Essbase Data Load for Oracle Profitability and Cost Management Cloud

Load input data to an Essbase application.

REST Resource

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

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 13-24 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application Name of the application for which to load the data Path Yes None
clearAllDataFlag Whether to clear existing data (true) or not (false) Payload Yes None
dataLoadValue Possible values are ADD_EXISTING_VALUES or OVERWRITE_EXISTING_VALUES Payload Yes None
dataFileName Name of the data file already present in the inbox folder Payload Yes None

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/BksML12/jobs/essbaseDataLoadJob

{"clearAllDataFlag":"true","dataLoadValue":"OVERWRITE_EXISTING_VALUES","dataFileName":"input.txt"}

Response Body

Supported Media Types: application/json

Table 13-25 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.

      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/Ex3F1/povs/FY14_JUN_Actual_Working/ruleBalance?queryParameter=%7B%22modelViewName%22:%22BU%2010601%22%7D",
    
{
  "type": "Profitability",
  "links": [
    {
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/BksML12/jobs/essbaseDataLoadJob",
      "action": "POST",	
      "rel": "self",
      "data": {
      "clearAllDataFlag":"true",
       "dataLoadValue":"OVERWRITE_EXISTING_VALUES",
       "dataFileName":"input.txt"
        }
    }, {
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/jobs/ChecktaskStatusJob/BksML12_BksML12_LoadData_D20160118T051020_ba8_1",
        "action": "GET",
        "rel": "Job status"
        }
    ],
    "status": -1,
    "details": "BksML12_BksML12_LoadData_D20160118T051020_ba8_1",
    "statusMessage": "In_Progress"
}