Skip to main content
Each resource consists of individual fields (e.g., a user has an ID, name, email, etc.). The list of fields available for filtering is defined by a specific resource filter. In turn, this filter uses primitive filters to determine filtering conditions (equality, range, etc.).

​
BooleanFilter

​
isnull
boolean
default:"null"
Value is missing (null).
​
isnotnull
boolean
default:"null"
Any value is present (not null).
​
equals
boolean
default:"null"
Equals the specified value.

​
IntegerFilter

​
isnull
boolean
default:"null"
Value is missing (null).
​
isnotnull
boolean
default:"null"
Any value is present (not null).
​
equals
integer
default:"null"
Equals the specified value.
​
notequals
integer
default:"null"
Does not equal the specified value (any value except the one provided).
​
from
integer
default:"null"
Greater than or equal to the specified value (lower bound).
​
to
integer
default:"null"
Less than or equal to the specified value (upper bound).
​
in
integer[]
default:"null"
Matches one of the specified values.

​
DecimalFilter

​
isnull
boolean
default:"null"
Value is missing (null).
​
isnotnull
boolean
default:"null"
Any value is present (not null).
​
equals
decimal
default:"null"
Equals the specified value.
​
notequals
decimal
default:"null"
Does not equal the specified value (any value except the one provided).
​
from
decimal
default:"null"
Greater than or equal to the specified value (lower bound).
​
to
decimal
default:"null"
Less than or equal to the specified value (upper bound).
​
in
decimal[]
default:"null"
Matches one of the specified values.

​
StringFilter

​
isnull
boolean
default:"null"
Value is missing (null).
​
isnotnull
boolean
default:"null"
Any value is present (not null).
​
equals
string
default:"null"
Exactly matches the specified value (case-sensitive).
​
notequals
string
default:"null"
Does not match the specified value.
​
contains
string
default:"null"
Contains the specified value as a substring.
​
in
string[]
default:"null"
Matches one of the specified values.

​
DateTimeFilter

​
isnull
boolean
default:"null"
Value is missing (null).
​
isnotnull
boolean
default:"null"
Any value is present (not null).
​
equals
datetime
default:"null"
Equals the specified value.
​
notequals
datetime
default:"null"
Does not equal the specified value.
​
from
datetime
default:"null"
Greater than or equal to the specified value (lower bound).
​
to
datetime
default:"null"
Less than or equal to the specified value (upper bound).

​
EnumerableFilter

Used to filter parent resource collections based on their associated child collections.

​
Use Cases

  • All categories that have at least one product priced over $1000 without photos.
  • All customers who have at least one order for a product from a specific category.
  • All projects that have at least one incomplete task with high priority.
This filter operates on “EXISTS” logic. The result will only include parent resources that have at least one child resource matching the specified criteria.
​
any
ChildFilter
At least one child resource matches each requirement (but not necessarily all of them at once).
​
any
ChildFilter[]
At least one child resource matches each requirement (must match all requirements with the same index simultaneously).
​
none
ChildFilter
No child resource matches each requirement (but not necessarily all of them at once).
​
none
ChildFilter[]
No child resource matches each requirement (must match all requirements with the same index simultaneously).