Reference Guide

Filtering response data
Use one or more filter expressions in a request parameter to specify matching criteria for a list of resources returned by a
collection query. A filter expression works like an SQL WHERE clause. You specify a filter expression composed of boolean
predicates, and the expression is applied against the attribute values of the requested resource type. Only those instances that
cause the filter expression to evaluate to true are returned in the query response. The system ANDs together multiple filter
expressions.
Filter expressions use operators such as gt, gte, lt, and lte. The interpretation of these operators is type-dependent. For
example, gt used with datetime attributes means the date value to the right of gt must be more recent than the date value
to the left of gt.
Filtering is case insensitive for any property called name.
Using a filter expression can save bandwidth, because the server removes extra data before returning data to the client.
However a filter expression does not reduce the amount of work the server performs to answer the request.
NOTE: Complex requests can be slow or can fail.
Syntax
As the first parameter on the request URI: ?<attribute_name>=<filter_expr>
As a subsequent parameter on the request URI: &<attribute_name>=<filter_expr>
where <filter_expr> is defined by the following syntax :
[not.]<operator>.<filter value> You can use nested notation syntax
(<reference_attribute_name>(<attr1>,<attr2>...)) in a filter expression to filter by attributes from a related
resource type.
NOTE: Some resource types and attributes do not support filtering, which is indicated in their descriptions.
You can also filter by attributes that are not requested in the select URL parameter. A related resource type is a resource type
that is either referred to explicitly in the definition of the target resource type or embedded in the target resource type.
Supported operators
Comparator
Description Applicable data
types
Example
eq
Equal.
Returns true when the expression on the left
of eq equals the expression on the right.
All
?role_id=eq.3
True if the value of role_id is
Operator.
gt
Greater than.
Returns true when the expression on the left
of =eq is greater than the expression on the
right.
All
?low_value=gt.5
True if the value of low_value is greater
than 5.
gte
Greater than or equal.
Returns true when the expression on the left
of =eq is greater than or equal to the
expression on the right.
All
?software_version=gte.5.3
True if the value of software_version
is greater than or equal to 5.3.
lt
Less than
Returns true when the expression on the left
of =eq is less than the expression on the
right.
All
?
modify_time=lt.2018-05-07T17:5
6:28.859+00:00
True if the value of modify_time is
earlier than
2018-05-07T17:56:28.859+00:00.
28 Querying a resource