Jump to

• Request
• Response
• Examples

Get Application Configuration Property

get

/essbase/rest/v1/applications/{applicationName}/configurations/{configId}

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

Request

Path Parameters

• applicationName: string

  Application name.

• configId: string

  Configuration property name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

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

Body ()

Root Schema : ApplicationConfigEntry

Type: object

Show Source

• configured(optional): boolean

  If true, the configuration property is enabled.

  If false, the configuration property is turned off.

• description(optional): string

  A description of the configuration property.

• example(optional): string

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

• key(optional): 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(optional): array links
• syntax(optional): string

  The syntax for the configuration property. Example: DATACACHESIZE n

• value(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): 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 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