Getting the Variables of a Document

Gets the content of a variable dictionary of a Web Intelligence document.

Request

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

Where:

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

Response type: application/xml or application/json

Response body: a list of variables used by the document, where:

  • dataType and qualification attributes of <variable> are the type and qualification of the variable (measure, attribute or dimension)
  • grouping="true" attribute is only for grouping variables
  • <id> is the identifier of the variable
  • <name> is the name of the variable, as used in the document

Example

GET <webiURL>/documents/4326/variables

<variables>    
    <variable dataType="Numeric" qualification="Measure"> 
        <id>L6</id> 
        <name>Min Revenue</name>
    </variable> 
    <variable dataType="Numeric" qualification="Measure">  
        <id>L7</id>
        <name>RevenueThreshold</name>
    </variable>  
    <variable dataType="Numeric" qualification="Measure">
        <id>L8</id> 
        <name>Threshold factor</name>
    </variable> 
    <variable dataType="Numeric" qualification="Measure">
        <id>L9</id> 
        <name>Threshold Max</name>
    </variable>
    <variable dataType="Numeric" qualification="Measure">
        <id>LA</id>
        <name>Threshold Min</name>
    </variable>
    <variable grouping="true" dataType="String" qualification="Dimension">
        <id>LB</id>
        <name>Month+</name>
    </variable>
</variables>