REST API for Oracle Essbase

About Essbase

get

/essbase/rest/v1/about

Returns description, build, and version of Essbase.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

Successful operation.

Root Schema : about

Type: object

Show Source

build: string
description: string
name: string
version: string

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

Examples

The following example shows how to retrieve version information about Essbase, using cURL to access the REST API from a Windows shell script.

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 -H "accept:application/json" "https://myserver.example.com:9001/essbase/rest/v1/about" -u %User%:%Password%

Example of Response Body

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

{
  "name" : "Essbase",
  "description" : "Essbase is a business analytics solution built using a proven, flexible best-in-class architecture for analysis and reporting. It delivers instant value and greater productivity for business users, analysts, modelers, and decision-makers across all lines of business within an organization. Users interact through a Web 2.0 or Microsoft Office interface to analyze, model, collaborate, and report. The platform, built to scale and perform, uses industry standard Oracle infrastructure.",
  "version" : "21.6.0.0.0",
  "build" : "nnn"
}