REST API for Oracle Essbase

Get Database Variable

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/variables/{variableName}

Returns the substitution variable details from the specified application and database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.
variableName(required): string

Variable name.

Response

Supported Media Types

application/json
application/xml

200 Response

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

Root Schema : Variable

Type: object

Show Source

appName: string
dbName: string
links: array links
name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "appName":{
            "type":"string"
        },
        "dbName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

Examples

The following example shows how to get information about a variable 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/OrclDSN?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

{
  "name" : "OrclDSN",
  "value" : "TBC_ORA"
}