Filtering operators

Operator Reverse Operator Parameters Type compatibility Description
EQUALS NOT_EQUALS 1 Text, Number, Boolean Equal/not equal to the value.
STARTS_WITH NOT_STARTS_WITH 1 Text The text starts/does not start with characters.

STARTS_WITH_DIGIT

 / Optional Text The text starts with a digit. The optional parameter is a pair of upper and lower boundaries separated by a comma. For example, "3, 8" means any digit from 3 to 8 is included.
ENDS_WITH NOT_ENDS_WITH 1 Text The text ends/does not end with characters.
INCLUDES NOT_INCLUDES 1 Text The text contains/does not contain the characters.
LESS GREATER 1 Number The value is strictly less than/greater than the value.
LESS_OR_EQUALS GREATER_OR_EQUALS 1 Number The value is less than or equal to/greater than or equal to the value.
BETWEEN / 2 Number The value is included within the values.
NULL NOT_NULL None Text, Number, Boolean Absence/presence of value.
IN NOT_IN Collection Text, Number, Boolean The value is in/not in the set of values.
EXISTS NOT_EXISTS 1 (optional) n/a See below.

CR_FILTER_DOMAIN

  / 1 n/a

ComplexRelation specific filter. Includes only complex relations with at least one related asset in the domain.

The following table shows samples for each operator. 

Operator Example
EQUALS 
{ "Field": { "name": "domainName", "operator": "EQUALS", "value": "New Business Terms" } }
STARTS_WITH 
{ "Field": { "name": "domainName", "operator": "STARTS_WITH", "value": "New" } }

STARTS_WITH_DIGIT

 
{ "Field": { "name": "assetName", "operator": "STARTS_WITH_DIGIT" } }
ENDS_WITH 
{ "Field": { "name": "domainName", "operator": "ENDS_WITH", "value": "Terms" } }
INCLUDES 
{ "Field": { "name": "domainName", "operator": "CONTAINS", "value": "Bus" } }
LESS 
{ "Field": { "name": "lastModified", "operator": "GREATER", "value": "1440492290300" } }
LESS_OR_EQUALS 
{ "Field": { "name": "lastModified", "operator": "GREATER_OR_EQUALS", "value": "1440492290300" } }
BETWEEN 
{ "Field": { "name": "lastModified", "operator": "BETWEEN", "values": [ "1440492290300", "1440493000000" } }
NULL 
{ "Field": { "name": "description", "operator": "NULL" } }
IN 
{ "Field": { "name": "statusName", "operator": "IN", "values": [ "New", "In Review" ] } }
EXISTS 
{ "Field": { "target": "RelationSource", "operator": "EXISTS", "value": "00000000-0000-0000-0000-000000007001", "name": "assetId" } }

CR_FILTER_DOMAIN

 
{ "Field": { "operator": "CR_FILTER_DOMAIN", "value": "00000000-0000-0000-0000-000000006013" } }