Jump to

• Request
• Response
• Examples

About Essbase

get

/essbase/rest/v1/about

Returns description, build, and version of 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"
    }
}

Back to Top

Examples

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

The calling user's ID and password, and the Essbase server URL, are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X GET -H "Accept: application/json" "%Server%/essbase/rest/v1/about" -u %User%:%Password% -o output_about.json

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.4.0.0.0",
  "build" : "nnn"
}

Back to Top