Webex · Schema

Package

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
name object The Webex Wholesale Packages assigned to the customer.
status string The provisioning status of the a particular package. * `provisioned` - Customer is fully provisioned on Cisco Webex. * `provisioning` - Customer is provisioning. * `deleting` - Customer is being delet
warnings array List of warnings that occurred during that last attempt to provision/update this customer. *Note:* + This list captures errors that occurred during *asynchronous or background* provisioning of the cus
errors array List of errors that occurred during that last attempt to provision/update this customer. *Note:* + This list captures errors that occurred during *asynchronous or background* provisioning of the custo
licenseIds array List of licenseIds for the package.
View JSON Schema on GitHub

JSON Schema

webex-package-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Package",
  "title": "Package",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/components/schemas/WholesalePackagesCustomer",
      "description": "The Webex Wholesale Packages assigned to the customer."
    },
    "status": {
      "type": "string",
      "enum": [
        "provisioned",
        "provisioning",
        "deleting",
        "error"
      ],
      "description": "The provisioning status of the a particular package.\n * `provisioned` - Customer is fully provisioned on Cisco Webex.\n * `provisioning` - Customer is provisioning.\n * `deleting` - Customer is being deleted.\n * `error` - An error occurred provisioning the customer on Cisco Webex.\n"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Error"
      },
      "description": "List of warnings that occurred during that last attempt to provision/update this customer.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the customer, *after* the API has been accepted and 202 response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Error"
      },
      "description": "List of errors that occurred during that last attempt to provision/update this customer.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the customer, *after* the API has been accepted and 202 response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
    },
    "licenseIds": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvYjdjNGRlZTgtODZmNi00YzAxLWJkYjMtMTM3MjM2ZWY3NGRmOlNMV0NBXzdmYTBkZjhjLTlmNTEtNGE1Zi05YzY4LTU1ODRlNWM2N2E0Yg"
      },
      "description": "List of licenseIds for the package."
    }
  }
}