Jump to

• Request
• Response
• Examples

About Essbase Instance

get

/essbase/rest/v1/about/instance

Returns instance details for Essbase.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Successful operation.

Body ()

Root Schema : about

Type: object

Show Source

• build(optional): string
• description(optional): string
• name(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "build":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "xml":{
        "name":"about"
    }
}

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to return configured details about the Essbase instance.

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/about/instance" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

{
  "provisioningSupported" : true,
  "resetPasswordSupported" : true,
  "easlocallyInstalled" : true
}

Back to Top