Business Analytics Headers Used in Pagination

Business Analytics Development and APIs : Paginate Mashable or Mashup Responses : Business Analytics Headers Used in Pagination

Pagination requests and responses follow a simple pattern:

1. Initial or new request that invokes a mashable or mashup and requests pagination from the Business Analytics Server. These requests use the following Business Analytics Headers or Parameters:

x-p-paginateRecord = identifies the repeating items in the mashable or mashup results that should be paginated.

x-p-paginateStart = indicates the starting record number to return or an initial invocation to cache.

x-p-paginateCount = the number of repeating items to return in as one page.

2. The response to any request that involves pagination which includes the response with the specific repeating items requested, plus these headers with pagination information:

x-paginateToken = a token identifying the cached response for this pagination set.

x-totalCount = the total number of repeating items in the cached response.

Note:

If the pagination record sent in the request has no matches, the full response from the mashable is returned.

3. Subsequent requests for specific paginated sets of records from the cached response. These requests include the same three headers as initial requests, plus x-paginateToken as a header to identify the cached response to use.

For more information on these headers, see Business Analytics Headers/Parameters.

Contact Support | Community | Feedback