Jump to

• Request
• Response
• Examples

Get Server Variable

get

/essbase/rest/v1/variables/{variableName}

Returns substitution variable details from the server.

Request

Path Parameters

• variableName: string

  Variable name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

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

Body ()

Root Schema : Variable

Type: object

Show Source

• appName(optional): string
• dbName(optional): string
• links(optional): array links
• name(optional): string
• value(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): 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 variable name may be incorrect.

500 Response

Internal Server Error.

Back to Top

Examples

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

Example of Response Body

{
  "name" : "CurrMonth",
  "value" : "Aug"
}

Back to Top