Contents

PageDetail

The number of items that return in the page.

Declaration

object PageDetail

Properties

NameTypeDescription
itemsPerPageint32

The maximum number of entries that return for this operation, which is the value of count in the GET operation. The actual number of entries that return can be less than the maximum itemsPerPage.

startIndexint32

The offset of the first entry that returns. Use offset in the request query string or Selector to override the default value of 0. For example, if the request is offset=5, the response startIndex is also 5. A value of 0 retrieves the first itemsPerPage results from the full result set.

totalResultsint64

The total number of entries that return for the operation.

Discussion

The PageDetail object contains the pagination response for returned multiple records.

{
   "data":[
     { },
     ...
   ],
   "pagination"{
     "totalResults": 10,
     "startIndex": 1,
     "itemsPerPage": 10
   },
}

See Also

API Usability