Contents

Pagination

Pagination state in change history list responses.

Declaration

object Pagination

Properties

NameTypeDescription
offsetinteger

Zero-based index of the first record on the current page.

pageSizeinteger

The number of records returned on this page.

totalCountinteger

The total number of records matching the query across all pages. Returns 0 when needTotals is set to "false" in the request options. Read-only.

Discussion

The Pagination object is returned in the pagination field of BaseAuditResponse (and its subtypes AuditSummaryResponse and ChangeDetailsResponse).

To page through results, increment offset by pageSize on each subsequent request until offset >= totalCount. When needTotals is "false" in the AuditQuery options, page forward instead until the response result array is empty.

Example

{
  "offset": 0,
  "pageSize": 50,
  "totalCount": 137
}

See Also