attributeFilter

Property description

The attributeFilter clause filters objects by their attribute type.

Minimal JSON

{
  "type": "attributeFilter",
  "attributeTypeKey": "",
  "operand": "",
  "value": "",
  "values": [""]
}

Nested properties

Property	Description	Values	Mandatory
type	attributeFilter	string	Yes
attributeTypeKey	Key of the attribute type the filter applies to.	array of strings	Yes
operand	Object filter expression. See below for supported operand values.	string	Yes
value	Number or text value used for comparison. 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 text strings with specified html tags (e.g., text_1). Used with membership operands (in or notIn). 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 text strings specified in the values property.
notIn	Excludes objects with text strings specified in the values property.

Null check operands

Operand	Description
empty	Objects with empty attributes. The following properties must be empty:  value, values.
notEmpty	Objects with attributes with some value. The following properties must be empty:  value, values.

Numerical operands

Operand	Description
equals	Objects with attribute value equal to the value property.
notEquals	Objects with attribute value different from the value property.
greaterThan	Objects with attribute value bigger than the value property.
lowerThan	Objects with attribute value lower than the value property.
greaterOrEqualsThan	Objects with attribute value bigger than or equal to the value property.
lowerOrEqualsThan	Objects with attribute value lower than or equal to the value property.
todayPlusXGreaterThan	Objects with attribute value + X (defined in the value property) bigger than today + X. X is understood as the number of days. Used for deadlines.

String operands

Operand	Description
like	Objects with attribute value containing the string specified in the value property.
startWith	Objects with attribute value starting with the string specified in the value property.
endWith	Objects with attribute value ending with the string specified in the value property.