REST API for Oracle Essbase

Get Application Configuration (Filtered)

get

/essbase/rest/v1/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): string

Application name.

Query Parameters

configured: string

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

Default Value: all

Allowed Values: [ "all", "true", "false" ]
key: string

Filter key to refine the configuration property results.

Default Value: *

Response

Supported Media Types

application/json
application/xml

200 Response

The configuration properties were retrieved successfully.

Root Schema : schema

Type: array

Show Source

Array of: object ApplicationConfigList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationConfigList"
    }
}

Nested Schema : ApplicationConfigList

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationConfigEntry"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object ApplicationConfigEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationConfigEntry"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : ApplicationConfigEntry

Type: object

Show Source

configured: boolean

If true, the configuration property is enabled.
If false, the configuration property is turned off.
description: string

A description of the configuration property.
example: string

Usage example for the configuration property. Example: DATACACHESIZE 90M
key: string

Filter key to refine the configuration property results. For example if key=A*, all configuration properties beginning with the letter A are returned. Default is *
links: array links
syntax: string

The syntax for the configuration property. Example: DATACACHESIZE n
value: string

Value for the configuration property. Example: 1024

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"<p>Filter key to refine the configuration property results. For example if <code>key=A*</code>, all configuration properties beginning with the letter A are returned. Default is *</p>"
        },
        "description":{
            "type":"string",
            "description":"<p>A description of the configuration property.</p>"
        },
        "syntax":{
            "type":"string",
            "description":"<p>The syntax for the configuration property. Example: <code>DATACACHESIZE n</code></p>"
        },
        "example":{
            "type":"string",
            "description":"<p>Usage example for the configuration property. Example: <code>DATACACHESIZE 90M</code></p>"
        },
        "value":{
            "type":"string",
            "description":"<p>Value for the configuration property. Example: <code>1024</code></p>"
        },
        "configured":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the configuration property is enabled. <p>If <b>false</b>, the configuration property is turned off.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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
  } ]
}