Webex · Schema

DeviceTag

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
familyOrModelDisplayName	string	The family or model name of the device to which these settings apply.
tag	string	The unique identifier for the setting.
friendlyName	string	A user-friendly name for the setting. It helps to correlate the tag with the UI in settings groups.
tooltip	string	Explanatory text for the setting.
alert	string	Alert message related to this setting, if applicable.
level	array	The levels at which this setting can be configured. When fetching tags or updating tags, the tag should be allowed at the level the request is made for.
validationRule	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeviceTag",
  "title": "DeviceTag",
  "type": "object",
  "properties": {
    "familyOrModelDisplayName": {
      "type": "string",
      "description": "The family or model name of the device to which these settings apply.",
      "example": "Poly"
    },
    "tag": {
      "type": "string",
      "description": "The unique identifier for the setting.",
      "example": "%G711U_ORDER%"
    },
    "friendlyName": {
      "type": "string",
      "description": "A user-friendly name for the setting. It helps to correlate the tag with the UI in settings groups.",
      "example": "voice.codecPref.G711Mu"
    },
    "tooltip": {
      "type": "string",
      "description": "Explanatory text for the setting.",
      "example": "Tag tooltip."
    },
    "alert": {
      "type": "string",
      "description": "Alert message related to this setting, if applicable.",
      "example": "Alert text."
    },
    "level": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The levels at which this setting can be configured. When fetching tags or updating tags, the tag should be allowed at the level the request is made for.",
      "example": [
        "organization",
        "location",
        "device"
      ]
    },
    "validationRule": {
      "$ref": "#/components/schemas/ValidationRule"
    }
  }
}