Jump to

• Request
• Response
• Examples

Get Database

get

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

Returns details of database with specified database name and application name.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Database details returned successfully.

Body ()

Root Schema : Cube

Type: object

Show Source

• application(optional): string
• applicationRole(optional): string
• creationTime(optional): integer(int64)
• description(optional): string
• easManagedApp(optional): boolean

  If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.

• inspectDBAllowed(optional): boolean
• links(optional): array links
• modifiedBy(optional): string
• modifiedTime(optional): integer(int64)
• name(optional): string
• owner(optional): string
• startStopDBAllowed(optional): boolean
• startTime(optional): integer(int64)
• status(optional): string
• type(optional): string
  Allowed Values: [ "ASO", "BSO", "CURRENCY" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "creationTime":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedBy":{
            "type":"string"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ASO",
                "BSO",
                "CURRENCY"
            ]
        },
        "applicationRole":{
            "type":"string"
        },
        "easManagedApp":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.</p>"
        },
        "startStopDBAllowed":{
            "type":"boolean"
        },
        "inspectDBAllowed":{
            "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 database.

500 Response

Internal Server Error.

Back to Top

Examples

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

Example of Response Body

{
  "name" : "Basic",
  "application" : "ASOSamp",
  "owner" : "admin",
  "creationTime" : 1658867730017,
  "status" : "started",
  "startTime" : 1663814133852,
  "type" : "ASO",
  "description" : "",
  "modifiedBy" : "admin",
  "modifiedTime" : 1663814134304,
  "startStopDBAllowed" : true,
  "inspectDBAllowed" : true,
  "dbVariablesSetting" : {
    "showVariables" : true,
    "updateVariables" : true
  }
}

Back to Top