REST API for Oracle Essbase

Get Essbase Roles

get

/essbase/rest/v1/roles

Returns the roles available in Essbase. Valid type values are application and server. If type is empty, then both application and server roles are returned.

If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.

Request

Query Parameters

type: string

Valid type values are application and server.

Response

Supported Media Types

application/json
application/xml

200 Response

Returns roles for the specified type.

Root Schema : Roles

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RoleBean"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object RoleBean

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RoleBean"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : RoleBean

Type: object

Show Source

defaultRole: string
roles: array roles
type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "roles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "defaultRole":{
            "type":"string"
        }
    }
}

Nested Schema : roles

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

The following examples show how to search for service role provisioning information.

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 http://phoenix110702.dev3sub1phx.databasede3phx.oraclevcn.com:8999/essbase/rest/v1/roles -H "accept: application/json" -u %User%:%Password%

Example of Response Body

Essbase offers three kinds of service roles and four application-access permission levels.


{
  "items" : [ {
    "type" : "server",
    "roles" : [ "Service Administrator", "Power User", "User" ],
    "defaultRole" : "User"
  }, {
    "type" : "application",
    "roles" : [ "Application Manager", "Database Manager", "Database Update", "Database Access" ]
  } ]
}