REST API for Oracle Essbase

Get Startup Settings

get

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

Returns startup settings of the specified database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Response

Supported Media Types

application/json
application/xml

200 Response

Startup settings returned successfully.

Root Schema : startup

Type: object

Show Source

allowUsersToStartDatabase: boolean

Enable or disable users from starting the cube, either directly, or as a result of requests requiring the cube to be started. The default is true.
startDatabaseWhenApplicationStarts: boolean

Automatically start the cube when the application starts. The default is true. Applicable only when allowUsersToStartDatabase is also true.

{
    "type":"object",
    "properties":{
        "allowUsersToStartDatabase":{
            "type":"boolean",
            "description":"<p>Enable or disable users from starting the cube, either directly, or as a result of requests requiring the cube to be started. The default is <b>true</b>.</p>"
        },
        "startDatabaseWhenApplicationStarts":{
            "type":"boolean",
            "description":"<p>Automatically start the cube when the application starts. The default is <b>true</b>. Applicable only when allowUsersToStartDatabase is also <b>true</b>.</p>"
        }
    },
    "xml":{
        "name":"startup"
    }
}

400 Response

Bad Request

Failed to return the startup settings. The application or database name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get current startup settings for a 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_Dynamic/databases/Basic/settings/startup" -H "accept: application/json"-u %User%:%Password%

Example of Response Body

{
  "startup": {
    "allowUsersToStartDatabase": true,
    "startDatabaseWhenApplicationStarts": true
  }
}