Pagination
Many of the REST API's make use of a pagination strategy for dealing with operations that can return a large number of items. This strategy is built around the notion of a continuationToken
and a page size that determines the maximum number of items that can be returned in a single response.
When a continuationToken
is present in a response and has a non-null value, this signifies that there are more items available:
GET /service/rest/v1/<api>?<query>
{ "items" : [ ... ], "continuationToken" : "88491cd1d185dd136f143f20c4e7d50c" }
The API that produced the response will take a continuationToken
as an additional argument to the original query to signify that the next page of results is desired:
GET /service/rest/v1/<api>?<query>&continuationToken=88491cd1d185dd136f143f20c4e7d50c
If this response also contains a non-null continuationToken
, then its value can again be added to the original query to get the next page. This continues until the response returns a continuationToken
with a value of null
which signifies that there are no more pages of results.