Webex · Schema

WorkspaceResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
provisioningId	string	Provisioning ID that defines how this workspace is to be provisioned for Cisco Webex Services. Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the ch
userId	string	The user ID of the workspace on BroadWorks.
spEnterpriseId	string	The Service Provider supplied unique identifier for the workspace's enterprise.
displayName	string	The display name of the workspace.
primaryPhoneNumber	string	The primary phone number configured against the workspace on BroadWorks.
extension	string	The extension number configured against the workspace on BroadWorks.
id	string	A unique Cisco identifier for the workspace.
created	string	The date and time the workspace was provisioned.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkspaceResponse",
  "title": "WorkspaceResponse",
  "type": "object",
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2RkMjJlZGZlLTlmZWYtNDdmOS05ODFkLWYxYjA3MWFmMDcwYw",
    "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
    "userId": "[email protected]",
    "spEnterpriseId": "Reseller1+acme",
    "displayName": "Conference Room",
    "primaryPhoneNumber": "+1-240-555-1212",
    "extension": "51212",
    "created": "2019-10-18T14:26:16.000Z"
  },
  "properties": {
    "provisioningId": {
      "type": "string",
      "example": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
      "description": "Provisioning ID that defines how this workspace is to be provisioned for Cisco Webex Services. Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Cisco Webex Control Hub."
    },
    "userId": {
      "type": "string",
      "example": "[email protected]",
      "description": "The user ID of the workspace on BroadWorks."
    },
    "spEnterpriseId": {
      "type": "string",
      "example": "Reseller1+acme",
      "description": "The Service Provider supplied unique identifier for the workspace's enterprise."
    },
    "displayName": {
      "type": "string",
      "example": "Conference Room",
      "description": "The display name of the workspace."
    },
    "primaryPhoneNumber": {
      "type": "string",
      "example": "+1-240-555-1212",
      "description": "The primary phone number configured against the workspace on BroadWorks."
    },
    "extension": {
      "type": "string",
      "example": "51212",
      "description": "The extension number configured against the workspace on BroadWorks."
    },
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2RkMjJlZGZlLTlmZWYtNDdmOS05ODFkLWYxYjA3MWFmMDcwYw",
      "description": "A unique Cisco identifier for the workspace."
    },
    "created": {
      "type": "string",
      "example": "2019-10-18T14:26:16.000Z",
      "description": "The date and time the workspace was provisioned."
    }
  }
}