Webex · Example Payload

Webex Getvalidationschema Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Getvalidationschema Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "getValidationSchema",
  "method": "GET",
  "path": "/telephony/config/devices/dynamicSettings/validationSchema",
  "summary": "Get Validation Schema",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "tags": [
          {
            "familyOrModelDisplayName": "Poly",
            "tag": "%G711U_ORDER%",
            "friendlyName": "voice.codecPref.G711Mu",
            "tooltip": "Tag tooltip.",
            "level": [
              "location",
              "device"
            ],
            "validationRule": {
              "type": "int",
              "min": 0,
              "max": 10,
              "increment": 1
            }
          },
          {
            "familyOrModelDisplayName": "Poly",
            "tag": "%G722_ORDER%",
            "friendlyName": "voice.codecPref.G722",
            "tooltip": "Tag tooltip.",
            "level": [
              "location",
              "device"
            ],
            "validationRule": {
              "type": "int",
              "min": 0,
              "max": 10,
              "increment": 1
            }
          },
          {
            "familyOrModelDisplayName": "Poly",
            "tag": "%ENABLE_BLUETOOTH%",
            "friendlyName": "feature.bluetooth.enabled",
            "tooltip": "Tag tooltip.",
            "level": [
              "organization",
              "location",
              "device"
            ],
            "validationRule": {
              "type": "boolean",
              "values": [
                "1",
                "0"
              ]
            }
          },
          {
            "familyOrModelDisplayName": "Poly",
            "tag": "%DO_BLUETOOTH_DEVICE_NAME%",
            "friendlyName": "bluetooth.device.name",
            "tooltip": "Tag tooltip.",
            "alert": "Alert text.",
            "level": [
              "organization",
              "location",
              "device"
            ],
            "validationRule": {
              "type": "string",
              "regex": "[A-Za-z0-9]+",
              "maxLength": 255
            }
          },
          {
            "familyOrModelDisplayName": "Poly",
            "tag": "%DO_UI_MENU_BACKGROUND%",
            "friendlyName": "ui.menu.background",
            "tooltip": "Tag tooltip.",
            "level": [
              "organization",
              "location",
              "device"
            ],
            "validationRule": {
              "type": "string",
              "regex": "#[0-9A-F][0-9A-F][0-9A-F][0-9A-F][0-9A-F][0-9A-F]",
              "maxLength": 7,
              "validationHint": "#RRGGBB"
            }
          },
          {
            "familyOrModelDisplayName": "Poly",
            "tag": "%UP_BACKLIGHT_IDLE_INTENSITY%",
            "friendlyName": "up.backlight.idleIntensity",
            "tooltip": "Tag tooltip.",
            "level": [
              "organization",
              "location",
              "device"
            ],
            "validationRule": {
              "type": "enum",
              "values": [
                "0",
                "1",
                "2",
                "3"
              ]
            }
          }
        ]
      }
    }
  ]
}