Apply Data Grants

Applies data grants for a given Profitability and Cost Management application. This API submits a job to create and apply the data grants in Essbase.

This API removes all existing data grants in Essbase and recreates them with the latest information from the application. It can also be used to repair data grants if there are any issues.

REST Resource

POST /epm/rest/{api_version}/applications/{application}/jobs/applyDataGrants


Supported Media Types: application/json


The following table summarizes the client request.

Table 14-7 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with, such as v1 Path Yes None
application Name of the application to create Path Yes None

Example URL


Response Body

Supported Media Types: application/json

Table 14-8 Parameters

Name Description
details Task ID, such as BksML12_BksML12_LoadData_D20160118T051020_ba8_1
status See Migration Status Codes
statusMessage Message about the status, such as Success
type Profitability
data Parameters as key value pairs
links Detailed information about the link
href Links to API call
action The HTTP call type
rel Relationship type
data Parameters as key value pairs passed in the request

Example of Response Body:

The following shows an example of the response body in JSON format.

    "type": "Profitability",
    "status": -1,
    "statusMessage": "In Progress",
    "details": "BksML30_ ApplyDataGrants _D20161003T033953_b06",
    "links": [{
        "action": "POST",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
        "rel": "self"
    }, {
        "action": "GET",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
        "rel": "Job Status"