OData

This page provides example code for performing OData queries in the Integration Theme.

If you are unfamiliar with OData and how to use it, there is great official documentation available.

💡 Tip: Combine queries using & (ampersand). For example: $top=2&$skip=5. See more

The shared 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).

await client.getAllSpecifications(GROUP_ALIAS, "oDataQueryString");

Edit the Query String inputs to experiment with custom queries against your own data, and update the results shown.

Jump to Content


$filter

💡 Tip: Results can be filtered by any available property, not just state or date as demonstrated.

Example: Filter by state

Use an OData query to filter by StateName.

Result

Loading...

Example: Filter between dates

Use an OData query to find results between two dates.

Result

Loading...

$orderby

Use an OData query to order based on properties e.g. 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.

Result

Loading...

$top

Use an OData query to manipulate 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.