Jump to

• Request
• Response
• Examples

Get Database Variables

get

/applications/{applicationName}/databases/{databaseName}/variables

Returns all substitution variables from the specified application and database.

Request

Path Parameters

• applicationName(required):

  Application name.

• databaseName(required):

  Database name.

Query Parameters

• orderBy:
  Order By specification in format:column:direction. For example, name:asc.

Back to Top

Response

200 Response

OK

Variables returned successfully, with links to get, edit, or delete.

400 Response

Bad Request

Failed to get the variables. The application or database name may be incorrect.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to list the variables defined for an Essbase cube.

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/applications/Sample/databases/Basic/variables?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "name" : "OrclDSN",
    "value" : "TBC_ORA"
  }, {
    "name" : "month",
    "value" : "Sep"
  } ]
}

Back to Top