REST API for Oracle Essbase

Update Application Configurations

put

/applications/{applicationName}/configurations

Updates the application configurations and returns the updated configuration details.

Request

Path Parameters

applicationName(required):

Application name.

Response

200 Response

Configurations were updated successfully. Returns the configuration details and the links to get, edit, or delete the configurations.

400 Response

Bad Request

Failed to update the configurations. The application name or configuration entries is invalid, or the given configuration property has not been added to the application.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Examples

The following example shows how to update the configuration currently set for the specified Essbase application. You can use an array to update multiple configuration properties at once.

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 PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/configurations?links=none" -H "Accept:application/json" -H "Content-Type:application/json" --data "@./updateconfigs.json" -u %User%:%Password%

Input JSON Data

The script above executes, on Sample_Dynamic Basic, the application configuration array specified in updateconfigs.json. The input file has the following contents:

[
  {
    "key" : "HYBRIDBSOINCALCSCRIPT",
    "value" : "NONE",
    "configured" : true
  }, {
    "key" : "ASODYNAMICAGGINBSO",
    "value" : "FULL",
    "configured" : true
  } 
]

Example of Response Body

The following example shows the contents of the response body in JSON format.

[ {
  "key" : "HYBRIDBSOINCALCSCRIPT",
  "value" : "NONE",
  "configured" : false
}, {
  "key" : "ASODYNAMICAGGINBSO",
  "value" : "FULL",
  "configured" : false
} ]