List records in a logical entity

OAuth host for your environment. Use it for all requests that originate outside Zilliant’s internal network. For details, read X-Forwarded-Host header in Introduction.

Developer-friendly system name of the Zilliant entity.

Basic field filter expressed as fieldSystemName=fieldValue. When used, it appears in the underlying database query as a WHERE clause appended with an AND operator.

Note: The Try it & see response feature on this page can’t execute requests that use dynamic query parameter names, such as Brand=National. To use this query parameter, run the request from your preferred tool and manually add it to the request URL.

Comma-separated list of field system names to include in the result set. Must use Zilliant system name values for each field.

OData filter expression using field system names and supported operators:

• eq—Equal
• ne—Not equal
• lt—Less than
• le—Less than or equal
• gt—Greater than
• ge—Greater than or equal
• and—Logical AND
• or—Logical OR

Comma-separated list of fields to sort by.

For each field, you can optionally specify a sort direction (asc or desc) and NULL ordering (nulls first or nulls last). If you omit the sort direction, asc applies by default. If you omit NULL ordering, the default NULL placement is unchanged.

Meanings:

• asc—Sorts field values in ascending order (lowest to highest; A to Z).
• desc—Sorts field values in descending order (highest to lowest; Z to A).
• nulls first—Places NULL values before non-NULL values for the field.
• nulls last—Places NULL values after non-NULL values for the field.

Presence-only flag. When included, returns the total number of records that match the request. Can be combined with $filter.

Note: The Try it & see response feature on this page doesn’t support presence-only query parameters (parameters that are enabled by including the name only). To use this query parameter, run the request from your preferred tool and manually add it to the request URL.

Limit the number of returned records to the first N rows. Often paired with $orderby for top-N queries. For example, $orderby=LargeQty desc, Product&$top=100 would return 100 records comprising those with the largest values in the LargeQty field.

Omit the first N rows from the result separator. When paired with the $top parameter, this enables you to iterate multiple requests that paginate the result set. The corresponding value expression takes the format of an integer number. Some form of ordering is required. If you omit the $orderby option, ordering is automatically applied on the primary key fields of the entity.

For example, $top=10&$skip=50&$orderby=Organization will first order the records in the ascending alphabetical order within the Organization column, then skip the first 50 records in that result set, and therefore return records 61–70 in that ordered result set. So if you made iterative request calls of top 10 skip 0, top 10 skip 10, top 10 skip 20, and so on, you would paginate by 10 records per request.

Presence-only flag. When included, omits duplicate values in the result set. Must be used together with the $select query parameter. When also using $orderby, the sorted field must be one of the selected fields. When also using $skip, you must specify $orderby explicitly (implicit primary-key ordering is not allowed).

For example, $select=City&$distinct will return only the City field with all duplicate values removed.

Note: The Try it & see response feature on this page doesn’t support presence-only query parameters (parameters that are enabled by including the name only). To use this query parameter, run the request from your preferred tool and manually add it to the request URL.