Variable DTO - Cloud - Author-it

Development Documentation

Variable definition.

Properties

Name

Type

Description

Property

VariableId

Integer

Unique integer identifier for variable.

Property

Name

String

Unique name for variable. Brackets are not included (VARIABLE_NAME, not <VARIABLE_NAME>).

Property

Description

String

Description of variable.

Property

Value

String

Default value

Property

ValueObjectId

Integer

Default object ID value for variable (if variable is Object type).

Property

StyleId

Integer

Reference to Style object applied for this variable.

Property

VariableType

VariableType

Gets or sets the type of variable.

Property

ListOfValues

String List

List of valid values for variable. Used when variable type is set to "List of Values".

Property

ListOfValuesRelationships

VariableListValue List

List of valid values for a variable, and their relationships to each other. Used when variable type is set to "List of Values".

Property

IsVariantCriteria

Boolean

true if variable can be used as variant criteria, false otherwise.

Property

IsPublishPrompt

Boolean

true if variable causes prompt when used in content being published, false otherwise.