Webex · Schema

DevicesObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for a device.
description array Comma separated array of tags used to describe device.
model string Identifier for device model.
mac string MAC address of device.
primaryOwner boolean Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device.
type object Indicates if the line is acting as a primary line or a shared line for this device.
owner object Owner of the device.
activationState object Activation state of a device.
View JSON Schema on GitHub

JSON Schema

webex-devicesobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DevicesObject",
  "title": "DevicesObject",
  "type": "object",
  "required": [
    "id",
    "model",
    "primaryOwner",
    "type",
    "owner",
    "activationState"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=",
      "description": "Unique identifier for a device."
    },
    "description": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Comma separated array of tags used to describe device."
    },
    "model": {
      "type": "string",
      "example": "DMS Cisco 6871",
      "description": "Identifier for device model."
    },
    "mac": {
      "type": "string",
      "example": "123451234502",
      "description": "MAC address of device."
    },
    "primaryOwner": {
      "type": "boolean",
      "description": "Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device."
    },
    "type": {
      "$ref": "#/components/schemas/LineType",
      "description": "Indicates if the line is acting as a primary line or a shared line for this device."
    },
    "owner": {
      "$ref": "#/components/schemas/deviceOwner",
      "description": "Owner of the device."
    },
    "activationState": {
      "$ref": "#/components/schemas/DeviceActivationStates",
      "description": "Activation state of a device."
    }
  }
}