ScriptVariable object

Abstract Type

ScriptVariable is an abstract type. When an object of type ScriptVariable is expected, you must pass an object of one of the following types:

Properties

property attributes valid values description filter option
name
string
required
create-only

The Variable Name

type
string
required
"ScriptVariableJson"
"ScriptVariableString"
"ScriptVariableList"
"ScriptVariableRemoteList"

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.