The following is a non-exhaustive list of possible filtering options.
Examples:
Return subscriptions with where a property equals a value.
<property> eq <value>
filter=key eq 'STIAPL6404'
Return subscriptions where a property does not equal a value
not <property> eq <value>
filter=not key eq 'STIAPL6404'
Return subscriptions with where a property greater or equal a value.
<property> ge <value>
filter=createdAt ge '2024-01-18T19:53:51.480Z'
Return subscriptions with where a property lesser or equal a value.
<property> le <value>
filter=updatedAt le '2024-02-18T19:53:51.480Z'
The `and` operator returns results that meet both filter queries. In the example, the query only returns subscriptions with the exact key and with the specified subscription type.
<property> eq <value> and <property> eq <value>
filter=key eq 'STIQQ4L04' and subscriptionType eq 'CENTRAL_STORAGE'
The `or` operator returns results that meet either of filter queries. In the example, the query returns subscriptions with the exact key or with the specified subscription type.
filter=key eq 'STIQQ4L04' or subscriptionType eq 'CENTRAL_STORAGE'
Return subscriptions where property is one of multiple values.
<property> in <value>,<value>
filter=subscriptionType in 'CENTRAL_STORAGE', 'CENTRAL_CONTROLLER'
filter-tags
string
Filter expressions consisting of simple comparison operations joined
by logical operators to be applied on the assigned tags or their
values.
CLASS
EXAMPLES
Types
string
Comparison
eq, ne
Logical Expressions
and, or
Examples:
Return subscriptions that have a pair of tag with the exact same tag key and tag value.
<tagKey> eq <tagValue>
filter-tags='city' eq 'London'
Return subscriptions that have a pair of tag with the exact same tag key and the exact different tag value.
<tagKey> ne <tagValue>
filter-tags='city' ne 'London'
Return subscriptions containing the tag key and the corresponding value that satisfy all conditionals.
<property> eq <value> and <property> eq <value>
filter-tags='city' eq 'London' and 'street' eq 'Piccadilly'
Return subscriptions containing the tag key and the corresponding value that satisfy at least one of the conditionals.
<property> eq <value> or <property> eq <value>
filter-tags='street' eq 'Oxford Street' or 'street' eq 'Piccadilly'
limit
integer <int64> [ 1 .. 50 ]
Default: 50
Specifies the number of results to be returned. The default value is 50.
offset
integer <int64>
Default: 0
Specifies the zero-based resource offset to start the response from. The default value is 0.
select
Array of strings unique
A comma separated list of select properties to display in the response. The default is that all properties are returned.
Example: select=id,key
sort
string
A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator asc or desc. The default is ascending order.