Get Application Provisioning Report

get

/essbase/rest/v1/groups/{groupId}/provisionReport/applications/{application}

Gets provisioning report for the specified application. The logged in user must have at least Database Manager role for the application. Application roles are included in the report only if the logged in user has at least Application Manager role for the 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
  • Value can be all or none. Default value is none. When value is none, only links to roles, filters and scripts will be returned. When value is all, provisioning information for roles, filters, and scripts are returned.

Back to Top

Response

Supported Media Types

200 Response

OK

Provisioning report returned successfully.

Body ()
Root Schema : ApplicationProvisionReportItem
Type: object
Show Source
Nested Schema : DatabaseProvisionReportItemList
Type: object
Show Source
Nested Schema : ProvisionReportItemList
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : DatabaseProvisionReportItem
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : ProvisionReportItem
Type: object
Show Source
Nested Schema : inheritedFromGroups
Type: array
Unique Items Required: true
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source

400 Response

Bad Request

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

404 Response

Not Found

The group with that ID does not exist.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get links to reports on a particular group's access to one application on the Essbase Server.

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

The script requests provisioning information for the group id dbaccessgroup related to the application Sample.

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "name" : "Sample",
  "roles" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample/roles",
      "method" : "GET"
    } ]
  },
  "filters" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample/filters",
      "method" : "GET"
    } ]
  },
  "scripts" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample/scripts",
      "method" : "GET"
    } ]
  }
}
Back to Top