API Model

Variable

It describes a variable. Each variable model a question in the consultation.

Field Type Mandatory Meaning
 id  string  yes unique id for the variable
 name  string  yes variable name
 instanceIndex  integer  yes variable instance number. If the variable can't be instantiated it's always 1
 instanceBaseName  string  no instance base name. If the variable can't be instantiated it's empty
type enumeration  yes
  • qualitativeEnumeration
  • qualitativeEnumerationMulti
  • qualitativeLength
  • qualitativeLengthMulti
  • quantitativeEnumeration
  • quantitativeEnumerationMulti
  • quantitativeInterval
  • quantitativeIntervalMulti
 question string  no optional question that should be used in place of the variable name
 explanation string  no comment that add information about the question
 domain Domain  yes domain of the variable
frameName string  no name of the frame in witch the variable should be grouped
maskedValue string  no value input mask
solvable boolean  yes true if the variable can be solved with a subtable
metricSystem  enumeration no it define the characters that should be used as decimal and thousands separators

  • EU: "." as thousands separator and "," as decimal separator
  • USA: "," as thousands separator and "." as decimal separator
storedValues  array of strings  no previously entered values that have been stored in a back/what-if can be used as prefilled answer
thousandsSeparatorOn  boolean  yes true if the thousands should be visualized split

Feedback