Webex · Schema
MetaDataWithPagingInfo
Metadata of response with paging information
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| orgid | string | Organization ID. |
| page | integer | Current page number. |
| pageSize | integer | Page size for current data set. |
| totalPages | integer | Number of pages. |
| totalRecords | integer | Total number of items. |
| links | object | Map of pagination links with `self`, `next`, `prev`, `last`, and `first`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MetaDataWithPagingInfo",
"title": "MetaDataWithPagingInfo",
"type": "object",
"description": "Metadata of response with paging information",
"properties": {
"orgid": {
"type": "string",
"format": "uuid",
"description": "Organization ID.",
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number.",
"example": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Page size for current data set.",
"example": 100
},
"totalPages": {
"type": "integer",
"format": "int32",
"description": "Number of pages.",
"example": 1
},
"totalRecords": {
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1000
},
"links": {
"type": "object",
"description": "Map of pagination links with `self`, `next`, `prev`, `last`, and `first`.",
"example": {
"next": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=2&pageSize=10",
"last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=3&pageSize=10",
"prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10",
"self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=1&pageSize=10",
"first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10"
}
}
}
}