Skip to content

Latest commit



61 lines (42 loc) · 1.49 KB

File metadata and controls

61 lines (42 loc) · 1.49 KB

REST conditions: Referview

Conditions are smaller parts of rules. Only one condition has to be satisfied to satisfy a rule. Every condition has a few specific properties.

This article is about the referview condition. If you're looking for any other condition you can find them in the More information section.

Individual properties

The referview condition has the following parameters:

  • refer-view: View that the condition refers to.
  • check-type: Boolean value to indicate whether a profile should be present in the other view. Possible values: "yes", "no".

JSON example

The following JSON demonstrates how to use the API method:

    "type": "ReferView",
    "check-type": "no"

PHP example

You can use this condition to check whether subprofiles have any overlap at all, inside or outside of the current view.

// required code

// make a new api object with your access token
$api = new CopernicaRestAPI("your-access-token", 4);

$data = array(
    // select referview condition
    'type' => 'ReferView',

    // set check-type
    'check-type' => 'no'

// do the call
$result = $api->post("rule/id/conditions", $data);

// print the result

The example above requires the CopernicaRestApi class.

More information