1. REST API for Oracle Essbase
  2. Tasks
  3. Applications

Start or Stop Application

put

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

Performs specified action on the application. Valid actions are Start, Stop, and Stop_no_force.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Action performed successfully.

.

400 Response

Bad Request

Failed to perform action.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to start or stop 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 - Start Application

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample?action=start" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Script with cURL Command - Stop Application

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample?action=stop" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%
Back to Top