Get User's Applications Provisioning Reports

get

/essbase/rest/v1/users/{userId}/provisionReport/applications

Gets a provisioning report for a specific user across all applications. 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, meaning only links to applications are returned. If all is specified, provisioning information for all applications is returned.

Back to Top

Response

Supported Media Types

200 Response

OK

Provisioning report returned successfully.

Body ()
Root Schema : ApplicationProvisionReportItemList
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested 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

404 Response

Not Found

User not found.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get provisioning reports for a specific user across all Essbase applications.

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/users/user002/provisionReport/applications -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

The response returns links to a report for each application on the Essbase Server.

{
  "links" : [ {
    "rel" : "CalcTuple",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/CalcTuple",
    "method" : "GET"
  }, {
    "rel" : "Facility",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/Facility",
    "method" : "GET"
  }, {
    "rel" : "Sample_Dynamic",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/Sample_Dynamic",
    "method" : "GET"
  }, {
    "rel" : "Demo",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/Demo",
    "method" : "GET"
  }, {
    "rel" : "Sample",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/Sample",
    "method" : "GET"
  }, {
    "rel" : "ASOSamp",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/ASOSamp",
    "method" : "GET"
  }, {
    "rel" : "Consolidation",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport/applications/Consolidation",
    "method" : "GET"
  } ]
}
Back to Top