1. REST API for Oracle Essbase
  2. Tasks
  3. Application Role Provisioning

Search Application Role Provisioning

get

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

Search for 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
Query Parameters

  • Input may include all, group, or user. Default value is all, so if this query parameter is not specified, all users and groups are returned.

    Default Value: all

  • User or group ID wildcard pattern. if specified, returns users and groups matching the pattern. If not specified, returns all users and groups having some role. Users or groups having no role are not returned.

    Default Value: *

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

    Default Value: false

  • Input may include all, none, or a comma-separated list of roles (for example, app_manager, db_manager, db_update,or db_access). Default value is all, so if this query parameter is not specified, all users and groups having some role are returned. If none is specified, only users and groups having no role will be returned. If named roles are specified, then only users and groups having any of the named roles are returned.

    Default Value: all
Back to Top

Response

Supported Media Types

200 Response

OK

Successfully returned provisioning information for users or groups matching search criteria. Response type can be either JSON, XML, or CSV stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the search result will be returned in the response body. If Accept='application/octet-stream', the search result will be returned as a stream.

Body ()
Root Schema : result
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : permission
Type: object
Show Source

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top

Examples

The following examples show how to search for an application's provisioning information, 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.

Specify links=none as a query parameter if you don't want links in the response.

Script with cURL Command

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions?id=*&role=all&filter=all&inherited=false" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "items": [
    {
      "id": "User001",
      "role": "db_access",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "DELETE"
        }
      ]
    },
    {
      "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"
        }
      ]
    },
    {
      "id": "User003",
      "role": "db_manager",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User004",
      "role": "app_manager",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "DELETE"
        }
      ]
    }
  ]
}

Script with cURL Command - No Links, Write to Output File

The following example gets application permission for a specified user.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004?group=false&links=none" -H "Accept: application/json" -o output_get.json -u %User%:%Password%

Example of Response Body

The following is written to output_get.json: 

{
  "id" : "User004",
  "role" : "app_manager"
}
Back to Top