REST API for Oracle Essbase

Get User Preferences

get

/essbase/rest/v1/preferences

Gets user preferences. This operation returns links to various preferences available in this release.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

Preferences returned 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 retrieve links to current user preferences for Essbase.

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

Example of Response Body

{
  "links" : [ {
    "rel" : "grid",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/preferences/grid",
    "method" : "GET"
  } ]
}