Jump to

• Request
• Response
• Examples

Update Application Configuration

put

/applications/{applicationName}/configurations/{configId}

Updates the application configuration and returns the updated configuration details.

Request

Path Parameters

• applicationName(required):

  Application name.

• configId(required):

  Configuration property name.

Back to Top

Response

200 Response

OK

The configuration was updated successfully. Returns the configuration details and the links to get, edit, or delete the configuration.

400 Response

Bad Request

Failed to update the configuration. The application name or configuration property is invalid, or the specified 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.

Back to Top

Examples

The following example shows how to update the configuration for the specified Essbase application, for one specific configuration property.

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/ASOSamp/configurations/IDLETIMEMERGE?links=none" -H Accept:application/json -H Content-Type:application/json -d '{"value": "FALSE", "configured": true}' -u %User%:%Password%

Example of Response Body

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

{
  "key" : "IDLETIMEMERGE",
  "value" : "FALSE",
  "configured" : false
}

Back to Top