relationFilter

Property description

The relationFilter clause filters objects by their relation type.

Minimal JSON

{
  "type": "relationFilter",
  "relationTypeKey": "",
  "operand": "",
  "value": "",
  "values": [""]
}

Nested properties

Property	Description	Values	Mandatory
type	relationFilter	string	Yes
relationTypeKey	Key of the relation type the filter applies to.	array of strings	Yes
operand	Object filter expression. See below for supported operand values.	string	Yes
value	Key of a target object in the relation. Used with numerical and string operands. Must be empty if a null check operand is used (empty or notEmpty).	integer or string	Yes* (for numerical and string operands)
values	Array of keys of the target objects in the relation. Used with membership operands (in or notIn). This property is not case sensitive. Must be empty if a null check operand is used (empty or notEmpty).	array of strings	Yes* (for membership operands)

Supported operand values

Membership operands

Operand	Description
in	Selects objects with relation to the target object(s) specified in the values property.
notIn	Excludes objects with relation to the target object(s) specified in the values property.

Null check operands

Operand	Description
empty	Objects without any relations. The following properties must be empty:  value, values.
notEmpty	Objects with (any) relations. The following properties must be empty:  value, values.

Numerical operands

Operand	Description
equals	Objects with relation to the target object specified the value property.
notEquals	Objects without relation to the target object specified in the value property.

String operands

Operand	Description
like	Objects with relation to the target object whose name contains the string specified in the value property.
startWith	Objects with relation to the target object whose name starts with the string specified in the value property.
endWith	Objects with relation to the target object whose name ends with the string specified in the value property.