REST API for Oracle Essbase

Get Essbase URLs

get

/essbase/rest/v1/urls

Returns the list of available Essbase URLs. Essbase components, such as the web interface, Smart View client, and REST API, have their own URL endings. The main URL includes the host name or IP address, the port number, and the path /essbase/.

The default secured port is 9001, unless it was changed during deployment.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

The operation completed successfully.

Root Schema : Preference

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "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"
        }
    }
}

Examples

The following example shows how to get Essbase URLs.

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/urls -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "application" : "rest",
    "url" : "rest/v1"
  }, {
    "application" : "ui-v1",
    "url" : "ui"
  }, {
    "application" : "ui-v2",
    "url" : "jet"
  }, {
    "application" : "agent",
    "url" : "agent"
  }, {
    "application" : "japi",
    "url" : "japi"
  }, {
    "application" : "xmla",
    "url" : "xmla"
  }, {
    "application" : "smartview",
    "url" : "smartview"
  } ]
}

The URLs pertain to different Essbase component endpoints.

/essbase/rest/v1—The Essbase REST API basepath. You can also use /essbase/rest/docs to view the OpenAPI/Swagger interface in a Web browser.
/essbase/ui—The Essbase Redwood style web interface.
/essbase/jet—The Essbase classic style web interface.
/essbase/agent—The Essbase discovery URL. You can use it to log in to the MaxL Client. Example:
```
login $usrname $passwd on "https://myserver.example.com:9001/essbase/agent";
```
/essbase/japi—The Essbase Java API URL, also known as the Provider Services URL.
/essbase/xmla—The Essbase XML for Analysis URL.
/essbase/smartview—The Essbase Smart View client URL.