variable-info - click on schema id to expand documentation

variable-info - click on schema id to expand

Object specification for the description of variables in Verona APIs

Operations

SEND iqb_data_structures
Operation IDPlease select one schema
Accepts the following message:
select_schema
Message IDselect_schema
Examples

Schemas

object [variable info for coding]
uid: variable-info@verona@1.3
id
required
string
must match: ^[0-9a-zA-Z_]+$
Identifier for the variable

alias
string
must match: ^[0-9a-zA-Z_]+$
Alternative identifier for the variable

type
required
string
Data type of the variable value

Allowed values:
"string"
"integer"
"number"
"boolean"
"attachment"
"json"
"no-value"
"coded"
format
string
Data type format

Allowed values:
"text-selection"
"image"
"capture-image"
"audio"
"ggb-file"
"non-negative"
"latex"
"math-ml"
"math-table"
"math-text-mix"
"ggb-variable"
""
multiple
boolean
Can the value be of type Array?

Default value:false
nullable
boolean
Can the value be null?

Default value:false
array<object>
List of possible values

object
value
required
string | number | boolean
label
string
Additional properties are NOT allowed.
array<string>
Labels of the positions if the value is of type array

Items:
string
valuesComplete
boolean
Are the given values all possible values?

Default value:false
page
string
Page of the unit, on which the variable is located.

Additional properties are NOT allowed.