User management example filter
- Última actualización2020/05/01
User management example filter
This example filter is based on the User Management API fields and parameters. This filter searches for the username and the name of user.
This filter searches for the string bot-creator in the
username field and the string Adweta in
the firstName field.
{
"sort": [
{
"field": "username",
"direction": "asc"
}
],
"filter": {
"operator": "and",
"operands": [
{
"operator": "substring",
"value": "bot-creator",
"field": "username"
},
{
"operator": "substring",
"value": "Adweta",
"field": "firstName"
}
]
}
}
- sort
-
- field: the name of the field used to sort the response.
- direction: the sort order. It can be asc, ascending, or desc, descending.
- filter
-
Filter consists for an operator, value, and field. Filters are operands when used in conjunction with a boolean operator, such as and.
-
operands: filters are used as operands when
combined in a filter by using a boolean operator. There are two
available boolean operators:
- or: one of the conditions must be met.
- and: all of the conditions must be met.
-
operator: there are 11 operators
NONE, lt, le, eq, ne, ge, gt, substring, and, or, not
. And and or are used to evaluate multiple filters together. The other operators are used to evaluate values within individual filters. Not all operators work with all fields. - field: the name of the field used in the filter.
- value: the value of the field to be evaluated.
-
operands: filters are used as operands when
combined in a filter by using a boolean operator. There are two
available boolean operators: