Jump to

• Request
• Response
• Examples

Get Server Variables

get

/essbase/rest/v1/variables

Returns all the substitution variables from the Essbase server.

Request

Query Parameters

• all(optional): string
  Default Value: false

Back to Top

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.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VariableList

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

Nested Schema : VariableList

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Variable"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Variable

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested 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 variables.

500 Response

Internal Server Error.

Back to Top

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"
  } ]
}

Back to Top