Editing a Variable

Modifies a variable from a documents variable dictionary.

You can change the qualification, name or definition of the variable.
Note The modified formula must be valid. When you change the definition of the variable, you must refresh the document to commit your change to the report.
Request

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

Where:

  • {documentId}: the identifier of the Web Intelligence document retrieved from the list of documents
  • {variableId}: the identifier of the variable retrieved from the list of variables

Request body:

<variable qualification="...">
    <name>
    <definition>
</variable>
Response

Response type: application/xml or application/json

The response is a message stating the success or failure of the request.

Example

PUT <webiURL>/documents/8022/variables/L9

Request body:

<variable qualification="Measure">
    <name>Updated variable</name>
    <definition>=[RevenueThreshold]*[Threshold factor]/10</definition>
</variable>

Response:

<success>
    <message>The resource of type 'Variable' with identifier 'L9' has been successfully updated.</message>
    <id>L9</id>
</success>
Note You must refresh the document in order to see the changes.