Supplier Data API with Pagination Query and Filter Parameters

You can use query and filter parameters to paginate API results and to return incremental data.

Parameter

Description

realm

Specifies the name of the customer site that the client application wants to access, which can be any of the realmName values in the realms list returned by the Oauth token.

$skip

Specifies the pagination token returned in the body of the previous response, which is a numeric value.

Specifying $skip=0 is equivalent to not passing any $skip parameter and returns page 1 records from the first record to the specified page limit.

Specifying the pagination token in the body of the previous response skips all records up to and including that page and retrieves successive page records up to the specified page limit.

$count

Specifies whether or not page metadata and total count of records are returned in the response.

$top

Specifies the number of records returned for the page in the response from the pagination token onward. The value you specify must be greater than 0 and less than or equal to the system-defined pagination limit per page for the endpoint.

$filter

Specifies the update timestamps for records returned in the response and returns all records in the range in the specified page limit. This query parameter supports the following filter parameters:
  • updatedDateFrom: the earliest update date for records to be returned. Records most recently updated before this date are excluded from the response.

    This parameter uses the ge (greater than or equal to) operator and a date.

  • updatedDateTo: the latest update date for records to be returned. Records most recently updated after this date are excluded from the response.

    This parameter uses the le (less than or equal to) operator and a date.

Dates must be in the format YYYY-MM-DDThh:mm:ssZ in Greenwich Mean Time (GMT).
{{runtime_url}}/supplierdatapagination/v4/prod/vendors/S1052004/workspaces/questionnaires/qna/?realm=customersite-T&$skip=10=updatedDateFrom ge '2019-09-29T12:20:51Z' and updatedDateTo le '2019-09-29T12:20:51Z'