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

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

​
IntegerFilter

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

​
DecimalFilter

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

​
StringFilter

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

​
DateTimeFilter

​
boolean
default:"null"
Value is missing (null).
​
boolean
default:"null"
Any value is present (not null).
​
datetime
default:"null"
Equals the specified value.
​
datetime
default:"null"
Does not equal the specified value.
​
datetime
default:"null"
Greater than or equal to the specified value (lower bound).
​
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.
​
ChildFilter
At least one child resource matches each requirement (but not necessarily all of them at once).
​
ChildFilter[]
At least one child resource matches each requirement (must match all requirements with the same index simultaneously).
​
ChildFilter
No child resource matches each requirement (but not necessarily all of them at once).
​
ChildFilter[]
No child resource matches each requirement (must match all requirements with the same index simultaneously).