JSON reference for the userRelationFilter clause that filters objects by user relation type.
Property description
The userRelationFilter clause filters objects by their user relation type.
Minimal JSON
{
"type": "userRelationFilter",
"userRelationTypeKey": "",
"operand": "",
"value": "",
"values": [""]
}
Nested properties
| Property | Description | Values | Mandatory |
|---|
type | userRelationFilter | string | Yes |
userRelationTypeKey | Key of the user relation type the filter applies to. | array of strings | Yes |
operand | Object filter expression. See below for supported operand values. | string | Yes |
value | Dawiso user. 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 Dawiso users. 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 that were assigned user(s) specified in the values property. |
notIn | Excludes objects that were assigned user(s) specified in the values property. |
Null check operands
| Operand | Description |
|---|
empty | Objects without any user relations. The following properties must be empty: value, values. |
notEmpty | Objects with (any) user relations. The following properties must be empty: value, values. |
Numerical operands
| Operand | Description |
|---|
equals | Objects with the user specified in the value property. |
notEquals | Objects without the user specified the value property. |
String operands
| Operand | Description |
|---|
like | Objects with a user whose username contains the string specified in the value property. |
startWith | Objects with a user whose username starts with the string specified in the value property. |
endWith | Objects with a user whose username ends with the string specified in the value property. |