REST API for Oracle Essbase

Get Application Configuration Filtered

get

/applications/{applicationName}/configurationkeys

Returns all the configuration properties currently set for the specified application, with option to filter by configured value.

Request

Path Parameters

applicationName(required):

Application name.

Query Parameters

configured:

Specify all to return all configured properties. Specify true to return enabled configuration properties. Specify false to return configuration properties that are turned off.
key:

Filter key to refine the configuration property results.

Response

200 Response

The configuration properties were retrieved successfully.

400 Response

Bad Request

Failed to get the configuration properties. The application name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get configuration properties currently set for the specified Essbase application, with the option to filter by configured value.

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/configurationkeys?links=none&configured=true&key=*CACHESIZE" -u %User%:%Password%

Example of Response Body

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

{
  "items" : [ {
    "key" : "ASODEFAULTCACHESIZE",
    "description" : "Set the default size for the aggregate storage cache associated with aggregate storage databases",
    "syntax" : "ASODEFAULTCACHESIZE n",
    "example" : "ASODEFAULTCACHESIZE 200",
    "configured" : false
  }, {
    "key" : "DATACACHESIZE",
    "description" : "Define the value for the data cache size for Essbase databases.",
    "syntax" : "DATACACHESIZE n",
    "example" : "DATACACHESIZE 90M",
    "configured" : false
  }, {
    "key" : "INDEXCACHESIZE",
    "description" : "Define the value for the index cache size for Essbase databases.",
    "syntax" : "INDEXCACHESIZE n",
    "example" : "INDEXCACHESIZE 100M",
    "configured" : false
  }, {
    "key" : "MAXFORMULACACHESIZE",
    "description" : "Specify the maximum size of the formula cache to be made available for calculating members with formulas.",
    "syntax" : "MAXFORMULACACHESIZE [dbname] n",
    "example" : "MAXFORMULACACHESIZE 2048",
    "configured" : false
  } ]
}