Webex · Schema

FlowVariablesRes

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
description	string	Description for the variable
desktopLabel	string	Variable name shown on Agent Desktop
id	string	Identifier for the variable
isAgentEditable	boolean	Determines whether is eligible for desktop agent to edit
isCAD	boolean	Determines whether variable is agent viewable
isReportable	boolean	Determines whether a variable is reportable
isSecure	boolean	Determines whether a variable is marked sensitive
name	string	Name of the variable
overwrite	boolean	Determines whether a global variable has been overwritten
source	string	Source of the variable (GLOBAL, SUBFLOW_INPUT, SUBFLOW_OUTPUT, an empty string ). It's left empty for subflow local or flow variables
type	string	Data type of the variable (STRING, INTEGER, DATETIME, DECIMAL, JSON, BOOLEAN)
value	string	Value of the variable

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FlowVariablesRes",
  "title": "FlowVariablesRes",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Description for the variable",
      "example": "var1 is meant for loop counter"
    },
    "desktopLabel": {
      "type": "string",
      "description": "Variable name shown on Agent Desktop",
      "example": "var1"
    },
    "id": {
      "type": "string",
      "description": "Identifier for the variable",
      "example": "04b302a9-6d92-4365-8902-9b04bc3bf5f9"
    },
    "isAgentEditable": {
      "type": "boolean",
      "description": "Determines whether is eligible for desktop agent to edit",
      "example": false
    },
    "isCAD": {
      "type": "boolean",
      "description": "Determines whether variable is agent viewable",
      "example": false
    },
    "isReportable": {
      "type": "boolean",
      "description": "Determines whether a variable is reportable",
      "example": false
    },
    "isSecure": {
      "type": "boolean",
      "description": "Determines whether a variable is marked sensitive",
      "example": false
    },
    "name": {
      "type": "string",
      "description": "Name of the variable",
      "example": "var1"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Determines whether a global variable has been overwritten",
      "example": false
    },
    "source": {
      "type": "string",
      "description": "Source of the variable (GLOBAL, SUBFLOW_INPUT, SUBFLOW_OUTPUT, an empty string ). It's left empty for subflow local or flow variables",
      "example": "GLOBAL"
    },
    "type": {
      "type": "string",
      "description": "Data type of the variable (STRING, INTEGER, DATETIME, DECIMAL, JSON, BOOLEAN)",
      "example": "STRING"
    },
    "value": {
      "type": "string",
      "description": "Value of the variable",
      "example": "hello world!"
    }
  }
}