This API supports a custom query language that enables filtering collections based on most scalar properties of the target type. However, if a request attempts to filter using unauthorized virtual properties, the API returns an error.
You can compare scalar properties for equality using == or =eq= and inequality using != or =ne=. For an object with a numeric property maxRetries, a filter maxRetries == 3 returns all objects where maxRetries is set to 3. Likewise, a filter maxRetries != 3 finds all objects where maxRetries is not 3.
You can also filter numeric properties using greater than > or =gt=, greater than or equal >= or =ge=, less than < or =lt=, and less than or equal <= or =le=.
You can also filter string properties using the wildcard character *. For example, when filtering a collection of objects with a name property, using name==destination* returns objects like destination1 and destination2.
Filtering provides helper functions to identify special values. For example, use null() to match null values, as in filter description==null() to find objects missing a description. Use empty() to find empty string values.
You can combine basic searches to form complex filters using logical AND (;) and OR (,) operators. For example, if you want to find objects in a collection where the name is destination OR the description contains the string destination, use the filter name==destination,description==*destination*.