Webex · Schema

ApiErrorResponse

Response body for an API error.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
trackingId string An opaque identifier for mapping protocol failures to service internal codes. When specified in a request, it can be used for co-relating events across services
error object An object containing details about the error.
View JSON Schema on GitHub

JSON Schema

webex-apierrorresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiErrorResponse",
  "title": "ApiErrorResponse",
  "description": "Response body for an API error.",
  "type": "object",
  "properties": {
    "trackingId": {
      "type": "string",
      "description": "An opaque identifier for mapping protocol failures to service internal codes. \n\nWhen specified in a request, it can be used for co-relating events across services",
      "example": "c1a4fcef-aee2-4dea-8977-29f594760552"
    },
    "error": {
      "description": "An object containing details about the error.",
      "$ref": "#/components/schemas/ErrorDetails"
    }
  }
}