Oomnitza block: Query parameters

You can use a variety of query parameters in the Oomnitza block to tailor and limit API responses, especially when dealing with large datasets. This guide outlines how to effectively use these parameters, including field selection and formatting, to refine your data queries.

Note
Query parameters are optional. Click  to remove unnecessary Query parameters as failure to do so will cause validation errors. It is recommended that you choose some query parameters, particularly when fetching large volumes of data.

Alternative ID

Filters the result using an {alternative_id} or secondary id for the record. Use if you have more than one unique id for your record.

Fields

Limit the number of fields returned. For example, when fetching assets you may only wish to return the AWS related fields. In that case, supply a comma separated list of the field names as the value. 

Filter

Filter the results using a filter operation, such as barcode IS NULLor serial_number eq "OOM123". Follows the format fieldnamequery.

For details on the types of queries you can use, refer to Filtering data using the Oomnitza REST API.

Limit

Limit the number of records returned. For example, set the limit to 1 to return the first record, 10 to return the first 10 records. 

Skip

Skip records. For example, set the skip to 10 to skip the first 10 records. Starts at index 0. If you skip 5 and limit 10, the request returns assets 5 to 14. 

Sortby

Sort the results in ascending or descending order. For example, usemanufacturer_name ascto sort by manufacturer name in ascending order. Follows the format fieldnameasc / desc.

Important
You need to supply the correct field name when performing the query. If you are unsure what the correct field name is, check the External ID for the field in the Data Model. There can be no curly braces surrounding the field name before making your query, as per the format illustrated below.

 

Filtering data using the Oomnitza REST API