Webex · Schema
MetaDataReferencesPagingInfo
Metadata of response for references with paging information
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| orgid | string | Org 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 |
| referencedEntities | array | List of referenced entities |
| currentEntity | string | Name of current entity |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MetaDataReferencesPagingInfo",
"title": "MetaDataReferencesPagingInfo",
"type": "object",
"properties": {
"orgid": {
"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}$",
"type": "string",
"description": "Org ID",
"format": "uuid",
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
"page": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 1
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 100
},
"totalPages": {
"type": "integer",
"description": "Number of pages",
"format": "int32",
"example": 1
},
"totalRecords": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"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/cad-variable?page=2&pageSize=10",
"last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=3&pageSize=10",
"prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10",
"self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=1&pageSize=10",
"first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10"
}
},
"referencedEntities": {
"type": "array",
"description": "List of referenced entities",
"example": [
"agent-profile",
"entrypoint"
],
"items": {
"type": "string"
}
},
"currentEntity": {
"type": "string",
"description": "Name of current entity",
"example": "entity_name"
}
},
"description": "Metadata of response for references with paging information"
}