Dimension Service API  2.0.0
api index

PagedDataMeta Object

since: 0.6
Contains metadata for a PagedData, including information on how to request other pages of the data sequence.

Fields

next
0.6optional
object
If present, contains a set of key-value pairs that represent the parameters needed to fetch the next page of results. All fields of this object must be included in their entirety to fetch the next page. Including only some fields, or changing the values for any of the fields, when requesting the next page has undefined behavior.

For GET requests, the fields of this object should be reproduced as query parameters when requesting the next page.

For POST requests, the fields of this object should be reproduced as formdata parameters when requesting the next page.

If this property is missing, that is an indication that a "next page" of results for the current request is not available (e.g., if this is the last page of results). Note that the PagedData.data array might be empty, or it might contain elements on this last page.

Related API Objects