REST API for Oracle Essbase

List Dimensions

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/dimensions

Returns all the dimensions from the specified application and database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Response

Supported Media Types

application/json
application/xml

200 Response

Dimensions retrieved successfully, including details about the dimensions, and links to get the generations and levels of each dimension.

Root Schema : schema

Type: array

Show Source

Array of: object DimensionList

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

Nested Schema : DimensionList

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DimensionBean"
            }
        },
        "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 DimensionBean

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : DimensionBean

Type: object

Show Source

links: array links
members: integer(int32)
name: string
storedMembers: integer(int32)
type: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "members":{
            "type":"integer",
            "format":"int32"
        },
        "storedMembers":{
            "type":"integer",
            "format":"int32"
        },
        "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 dimensions. The application or database name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get all the dimensions of 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/dimensions?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items" : [ {
    "name" : "Year",
    "type" : "DENSE",
    "members" : 19,
    "storedMembers" : 12
  }, {
    "name" : "Measures",
    "type" : "DENSE",
    "members" : 17,
    "storedMembers" : 11
  }, {
    "name" : "Product",
    "type" : "SPARSE",
    "members" : 22,
    "storedMembers" : 19
  }, {
    "name" : "Market",
    "type" : "SPARSE",
    "members" : 25,
    "storedMembers" : 25
  }, {
    "name" : "Scenario",
    "type" : "DENSE",
    "members" : 5,
    "storedMembers" : 2
  }, {
    "name" : "Caffeinated",
    "type" : "SPARSE",
    "members" : 3,
    "storedMembers" : 0
  }, {
    "name" : "Ounces",
    "type" : "SPARSE",
    "members" : 5,
    "storedMembers" : 0
  }, {
    "name" : "Pkg Type",
    "type" : "SPARSE",
    "members" : 3,
    "storedMembers" : 0
  }, {
    "name" : "Population",
    "type" : "SPARSE",
    "members" : 15,
    "storedMembers" : 0
  }, {
    "name" : "Intro Date",
    "type" : "SPARSE",
    "members" : 8,
    "storedMembers" : 0
  } ]
}