Variables (Context Variables)

This variable contains basic information about variables that are available in the context. When you get this variable, you see only variable definitions that are accessible at your current permission level, not necessarily all existing variables. Read more about variable definition fields under Variables.

Variable Name:

variables

Records:

0...unlimited

Permissions:

Readable/writable at None permission level

Record Format:

Field Name

Field Description

Field Type

Notes

name

Name of the variable.

String

format

Format of variable encoded into String. If this field is NULL, the variable has a dynamic format -- it may return data of any format.

String

Nullable

description

Variable description.

String

readable

Flag indicating that variable is readable at your permission level.

Boolean

writable

Flag indicating that variable is writable at your permission level.

Boolean

help

Detailed variable description.

String

Nullable

group

Variable group, or NULL if variable does not belong to any group.

String

Nullable

iconId

ID of icon used to represent the variable (for internal use).

String

Nullable

helpId

ID of documentation article describing the variable (for internal use).

String

Nullable

Was this page helpful?