REST API for Oracle Essbase

Get Application Role Provision

get

/essbase/rest/v1/applications/{app}/permissions/{id}

Gets provisioning information on the specified application.

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

Path Parameters

app(required): string

Application name.
id(required): string

User or group ID.

Query Parameters

group: boolean

If true, ID is for a group. If false, ID is for a user. Default is false (ID is considered to be for a user.)

Default Value: false
inherited: boolean

If true, consider roles derived through parent groups. Default is false.

Default Value: false

Response

Supported Media Types

application/json
application/xml

200 Response

Provisioning information returned successfully.

Root Schema : permission

Type: object

Show Source

group: boolean

true or false. Whether the id refers to a group.
id: string

User or group ID.
links: array links
name: string

User or group name.
role: string

User or group role.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

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"
        }
    }
}

400 Response

Bad Request

The logged in user may not have the appropriate application role.

500 Response

Internal Server Error.

Examples

The following example shows how to get an application's provisioning details, using cURL to call 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/applications/Sample/permissions/User002?group=false&inherited=true"-H  "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "id": "User002",
  "role": "db_update",
  "links": [
    {
      "rel": "get",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "PUT"
    },
    {
      "rel": "delete",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "DELETE"
    }
  ]
}