Jump to

• Request
• Response
• Examples

Get Startup Settings

get

/applications/{applicationName}/databases/{databaseName}/settings/startup

Returns startup settings of the specified database.

Request

Path Parameters

• applicationName(required):

  Application name.

• databaseName(required):

  Database name.

Back to Top

Response

200 Response

OK

Startup settings returned successfully.

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top

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

Back to Top