Response Pagination

Use query string parameters to sort and paginate response data

Overview

All operations that output a list support pagination unless not specified using "offset" and "limit"

Sort data

The sort query string parameter enables you to specify the attribute on which returned records are sorted and the sort order (ascending or descending) for those records.

Use the = operator to specify the sort column. In the following example, the returned records are sorted in ascending order based on the attribute value in the number column.

GET /portfolios?datasource=ds1&limit=3&sort=number ASC&q=number LIKE "Portfolio_*"

By default, Risk Modeler API services returns data sorted by a predefined attribute. If no attribute is specified, the service sorts records in ascending order on the default column.

Records may be sorted in ascending (ASC) or descending (DESC) order.

Page data

The limit and offset query string parameters enable you to paginate data returned from the request.

Where the limit query string parameter specifies the number of records returned, the offset query string parameter specifies the number of records that are "off set" before the first record.

Responses are returned in a searchItems array that contains one object for each record returned.

The default limit setting is 100 records per page. The default offset setting is 0 pages.