Webex · Schema

devices

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.
modelType object Identifier for device model type.
mac string MAC address of device.
ipAddress string IP 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.
hoteling object Hoteling login settings, which are available when the device is the owner's primary device and device type is PRIMARY. Hoteling login settings are set at the owner level.
owner object Owner of device.
activationState object Activation state of device.
View JSON Schema on GitHub

JSON Schema

webex-devices-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/devices",
  "title": "devices",
  "type": "object",
  "required": [
    "id",
    "model",
    "primaryOwner",
    "type",
    "hoteling",
    "owner",
    "activationState"
  ],
  "properties": {
    "id": {
      "type": "string",
      "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",
      "description": "Identifier for device model."
    },
    "modelType": {
      "$ref": "#/components/schemas/DeviceType",
      "description": "Identifier for device model type."
    },
    "mac": {
      "type": "string",
      "description": "MAC address of device."
    },
    "ipAddress": {
      "type": "string",
      "description": "IP 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/DeviceLineType",
      "description": "Indicates if the line is acting as a primary line or a shared line for this device."
    },
    "hoteling": {
      "$ref": "#/components/schemas/HotelingRequest",
      "description": "Hoteling login settings, which are available when the device is the owner's primary device and device type is PRIMARY. Hoteling login settings are set at the owner level."
    },
    "owner": {
      "$ref": "#/components/schemas/deviceOwner",
      "description": "Owner of device."
    },
    "activationState": {
      "$ref": "#/components/schemas/ActivationStates",
      "description": "Activation state of device."
    }
  }
}