Update Server Variable

put

/variables/{variableName}

Updates a substitution variable on the server and returns the updated variable.

Request

Path Parameters
Back to Top

Response

200 Response

OK

Variable updated successfully. Includes variable details and links to get, edit, or delete the variable.

400 Response

Bad Request

Failed to update the variable. The variable name may be incorrect.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to update a global variable on the Essbase Server.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/variables/CurrMonth?links=none" -H Accept:application/json -H Content-Type:application/json -d '{"value": "Sep"}' -u %User%:%Password%

Example of Response Body

{
  "name" : "CurrMonth",
  "value" : "Sep"
}
Back to Top