PaginatedListMeta

Metadata for paginated list of results for Listing APIs

meta objectrequired

referenceInstantintegerrequired

Allows a consistent view of data across multiple paged requests. Unix epoch time to be used as reference for offset > 0 (corresponds to query instant, as returned by server on first call) - should be the same for all pages

Possible values: >= 0

offsetintegerrequired

Index of the first item returned in the page

Possible values: >= 0

pageSizeintegerrequired

Maximum number of items that can be returned per page

Possible values: >= 0

totalintegerrequired

Total number of items contained in all pages

Possible values: >= 0

deletedReferences object[]

This attribute will returned when the modified_since query parameter is used. It will contain references to deleted resources since the provided instant, that would have otherwise been included in the dataset (either at the top-level or as associated objects)

Array [

idstringrequired

classNamestringrequired

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

deleteTimestampstring<date-time>required

The instant when the reference was deleted

]

PaginatedListMeta

{
  "meta": {
    "referenceInstant": 0,
    "offset": 0,
    "pageSize": 0,
    "total": 0
  },
  "deletedReferences": [
    {
      "id": "string",
      "className": "string",
      "deleteTimestamp": "2024-07-29T15:51:28.071Z"
    }
  ]
}