Jump to

• Request
• Response
• Examples

Get Application Configuration Property

get

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

Returns configuration (based on configuration property name) from the specified application.

Request

Path Parameters

• applicationName(required):

  Application name.

• configId(required):

  Configuration property name.

Back to Top

Response

200 Response

OK

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

400 Response

Bad Request

Failed to get the configuration information. The application name or configuration property is invalid.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get the configuration currently set for the specified Essbase application, for a specific configuration property name.

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/configurations/HYBRIDBSOINCALCSCRIPT?links=none" -u %User%:%Password%

Example of Response Body

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

{
  "key" : "HYBRIDBSOINCALCSCRIPT",
  "value" : "FULL",
  "configured" : false
}

Back to Top