Webex · Schema

CadVariableBulkExportDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	A name for the Global Variable.
description	string	A the description for the Global Variable created.
agentEditable	boolean	Indicates whether the Global Variable is editable in the Agent Desktop by the agent or not.
variableType	string	A valid Global Variable Type. The valid types are: String, Integer, DateTime, Boolean, Decimal.
defaultValue	string	A default value for the Global Variable.
reportable	boolean	Indicates whether the Global Variable is reportable or not.
sensitive	boolean	Indicates whether the Global Variable is sensitive or not.
agentViewable	boolean	Indicates whether the agent can view the Global Variable in Agent Desktop or not.
desktopLabel	string	A desktop label for the Global Variable created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CadVariableBulkExportDTO",
  "title": "CadVariableBulkExportDTO",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "A name for the Global Variable.",
      "example": "Global Variable"
    },
    "description": {
      "type": "string",
      "description": "A the description for the Global Variable created.",
      "example": "Global Variable to describe meta-data."
    },
    "agentEditable": {
      "type": "boolean",
      "description": "Indicates whether the Global Variable is editable in the Agent Desktop by the agent or not.",
      "example": true
    },
    "variableType": {
      "type": "string",
      "description": "A valid Global Variable Type. The valid types are: String, Integer, DateTime, Boolean, Decimal.",
      "example": "INTEGER",
      "enum": [
        "STRING",
        "INTEGER",
        "DATE_TIME",
        "BOOLEAN",
        "DECIMAL",
        "String",
        "Integer",
        "DateTime",
        "Boolean",
        "Decimal"
      ]
    },
    "defaultValue": {
      "type": "string",
      "description": "A default value for the Global Variable.",
      "example": "Default Value"
    },
    "reportable": {
      "type": "boolean",
      "description": "Indicates whether the Global Variable is reportable or not.",
      "example": false
    },
    "sensitive": {
      "type": "boolean",
      "description": "Indicates whether the Global Variable is sensitive or not.",
      "example": false
    },
    "agentViewable": {
      "type": "boolean",
      "description": "Indicates whether the agent can view the Global Variable in Agent Desktop or not.",
      "example": true
    },
    "desktopLabel": {
      "type": "string",
      "description": "A desktop label for the Global Variable created.",
      "example": "Desktop Label"
    }
  }
}