Jump to

• Request
• Response
• Examples

Get Level

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/levels/{levelNumber}

Returns level details of a dimension, based on the specified level number, application, and database.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

• dimensionName: string

  Dimension name.

• levelNumber: integer(int32)

  Level number.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Level details returned successfully, including links to get or edit the level.

Body ()

Root Schema : GenerationLevel

Type: object

Show Source

• actualName(optional): string
• links(optional): array links
• name(optional): string
• number(optional): integer(int32)
• unique(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "actualName":{
            "type":"string"
        },
        "number":{
            "type":"integer",
            "format":"int32"
        },
        "unique":{
            "type":"boolean"
        },
        "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 level. The application name, database name, dimension name, or level number may be incorrect.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get details for a specified level of a dimension in 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/Market/levels/2?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.

{
  "name" : "Lev2",
  "number" : 2
}

Back to Top