ScriptVariableList object

Polymorphism

ScriptVariableList is a type that implements the ScriptVariable type.

When an object of type ScriptVariable is expected, you can use one of type ScriptVariableList (or use any other implementation).

Example JSON representation

{
  "allowedValues": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "category": "string",
  "description": "string",
  "hidden": true,
  "locked": true,
  "name": "string",
  "required": true,
  "type": "ScriptVariableList",
  "value": "string"
}

Properties

property attributes valid values description filter option
allowedValues
Array of VariableAllowedValue objects
required

The list of values to which the Global Variable value must correspond.

name
string
required
create-only

The Variable Name

type
string
required
"ScriptVariableList"

The type of Script Variable.

category
string
optional

The category of this Variable.

description
string
optional

A description that explains what this Global Variable is used for.

hidden
boolean
optional

Whether this Script Variable is hidden in Orchestration Rules or execute Script action.

locked
boolean
optional

Whether this Script Variable value is locked in Orchestration Rules or execute Script action.

required
boolean
optional

Whether this Script Variable value is required in Orchestration Rules or execute Script action.

value
string
optional

The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation.