REST API for Oracle Essbase

Get Application Startup Settings

get

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

Returns the startup settings of the specified application.

Request

Path Parameters

applicationName(required): string

Application name.

Response

Supported Media Types

application/json
application/xml

200 Response

Startup settings retrieved successfully.

Root Schema : startup

Type: object

Application startup settings.

Show Source

allowUsersToStartApplication: boolean

If true, all users who have at least read permission can load (start) the application. Startup is enabled by default.
startApplicationWhenServerStarts: boolean

If true, the application starts automatically when Essbase Server starts. By default, autostartup is disabled.

{
    "type":"object",
    "description":"<p>Application startup settings.</p>",
    "properties":{
        "allowUsersToStartApplication":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users who have at least read permission can load (start) the application. Startup is enabled by default.</p>"
        },
        "startApplicationWhenServerStarts":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the application starts automatically when Essbase Server starts. By default, autostartup is disabled.</p>"
        }
    },
    "xml":{
        "name":"startup"
    }
}

400 Response

Bad Request

Failed to get the startup settings. The application name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get startup-related settings of an Essbase application.

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/settings/startup?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Example of Response Body

{
  "startup" : {
    "allowUsersToStartApplication" : true,
    "startApplicationWhenServerStarts" : true
  }
}