Get Server Variables
get
/essbase/rest/v1/variables
Returns all the substitution variables from the Essbase server.
Request
Query Parameters
-
all: string
Default Value:
false
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Variables retrieved successfully. Includes variable details and links to get, edit, or delete the variables.
400 Response
Bad Request
Failed to get variables.
500 Response
Internal Server Error.
Examples
The following example shows how to list the variables defined globally 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 GET "https://myserver.example.com:9001/essbase/rest/v1/variables?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%Example of Response Body
{
"items" : [ {
"name" : "oci",
"value" : "OCI;SERVICE=myorclhost:1521/orcl.example.com"
}, {
"name" : "Orcl_DSN",
"value" : "TBC_ORA"
}, {
"name" : "FocusMarket",
"value" : "East"
}, {
"name" : "Scenario",
"value" : "Actual"
}, {
"name" : "CurrMonth",
"value" : "Sep"
} ]
}