Getting the Definition of a Variable

Gets the definition of a variable from a documents variable dictionary.

Request

GET <webiURL>/documents/{documentId}/variables/{variableId}

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {variableId} is the variable identifier retrieved from the list of variables of the document
Response

Response type: application/xml or application/json

Response body: definition of the variable, described as follows:

  • dataType and qualification attributes of <variable> are the type and qualification of the variable (measure, attribute or dimension)
  • <id>
  • <name> is the name of the variable, as used in the document
  • <description> optional, can be used to describe how the variable is used
  • <formulaLanguageId>
  • <definition> is the formula used by the variable

Example

GET <webiURL>/documents/1234/variables/L9

<variable dataType="Numeric" qualification="Measure">
    <id>L9</id>
    <name>Threshold Max</name>
    <description></description>  
    <formulaLanguageId>[Threshold Max]</formulaLanguageId>    
    <definition>=[RevenueThreshold]*(1+[Threshold factor])</definition>
</variable>