This article covers field support for filtering in Query Resources (SDK | REST), Search Resources (SDK | REST), and Count Resources (SDK | REST).
Specify the filter object in the following format:
The following table shows field support for filters and sorting for the
resource object:
| Field | Supported Filters | Sortable |
|---|---|---|
id | $eq, $ne, $exists, $in, $nin, $startsWith | Sortable |
name | $eq, $ne, $exists, $in, $nin, $isEmpty | |
typeId | $eq, $ne, $exists, $in, $nin, $startsWith, $isEmpty | Sortable |
locationOptions.availableInAllLocations | $eq, $ne, $exists, $in, $nin | Sortable |
locationOptions.specificLocationOptions.availableInBusinessLocations | $eq, $ne, $exists, $in, $nin | Sortable |
locationOptions.specificLocationOptions.businessLocations.locationId | $eq, $ne, $isEmpty, $hasAll, $hasSome | Sortable |
eventsSchedule.scheduleId | $eq, $ne, $exists, $in, $nin, $startsWith | Sortable |
Results in Query Resources
(SDK | REST)
and Search Resources
(SDK | REST)
are sorted by the id field in ascending order by default.
To sort by a different field, use the sort object in the following format: