config.js file for these examples is incomplete. Enter your own settings for the examples to function.
How this example works:
Each input below represents the optional oDataQueryString parameter for supported methods (see Client SDK Docs).
For each example, the following code will be run when the input value changes - with the OData query string applied:
await client.getAllSpecifications(GROUP_ALIAS, "oDataQueryString");
Edit the Query String inputs to experiment with custom query string - the results shown will update in real time.
Jump to Content
$filter
$filter supports various operators to control the response.
| Operator | Description | Example String |
|---|---|---|
| eq | Equal to | $filter=stateName eq 'Complete' |
| ne | Not equal to | $filter=stateType ne 'Running' |
| gt | Greater than | $filter=id gt 1000 |
| ge | Greater than or equal | $filter=id ge 1000 |
| lt | Less than | $filter=id lt 20 |
| le | Less than or equal | $filter=id le 100 |
| contains | Value contains | $filter=contains(originalProjectName,'Demo') |
| startswith | Value starts with | $filter=startswith(originalProjectName,'Demo') |
| endswith | Value ends with | $filter=endswith(originalProjectName,'Demo') |
| and | Logical AND | $filter=creatorName eq 'Guest' and stateName eq 'Complete' |
| or | Logical OR | $filter=stateName eq 'Complete' or (editorName eq 'Admin' and contains(originalProjectName,'Demo')) |
| not | Logical NOT | $filter=not endswith(originalProjectName,'Test') |
💡 Tip: Results can be filtered by any available property, not just those demonstrated.
Example: Filter by state
Use an OData query to filter by State Type equal to "Paused".
Result
Loading...
Example: Filter between dates
Use an OData query to find results between two dates.
Result
Loading...
$orderby
💡 Tip: Results can be ordered by any available property, not just those demonstrated.
Example: Order by name
Use an OData query to order the response based on name.
Result
Loading...
Example: Order by date
Use an OData query to order the response based on DateEdited.
Result
Loading...
$select
Use an OData query to specify the properties to include in the response.
Result
Loading...
$skip
Use an OData query to manipulate the starting position - skipping and excluding results.
$skip is useful for pagination, when combined with $top.
Result
Loading...
$top
Use an OData query to manipulate/limit the number of items returned.
Result
Loading...
Combined Queries
Use a combined OData query to return complex results.
This example query returns the name & id for 2 results, skipping the first 3 results.
Result
Loading...
Custom OData Query Builder
Create a custom OData query and view the dynamic results.
Result
Enter a custom query.