Essbase Block Analysis Report (v1)

Required Roles

Service Administrator

REST Resource

POST /interop/rest/diag/v1/services/essbaseblockanalysisreport

Request

Supported Media Types: application/json

Table 2-167 Parameters

Name	Description	Type	Required	Default
exportDataFile	Name of the zip file that contains the Oracle Essbase data that was previously exported from a BSO cube	Payload	Yes	None
reportFile	Name for the HTML formatted Block Analysis Report file	Payload	Yes	None

Sample Request Payload

{
  "exportDataFile": "EXPORT_DATA_FILE",
  "reportFile": "REPORT_FILE"
}

Response

Supported Media Types: application/json

Table 2-168 Parameters

Name	Description
details	Detailed status of the operation performed.
status	See Migration Status Codes
links	Detailed information about the link and HTTP call type
items	Detailed information about the API
href	Links to API call or status API
action	The HTTP call type
rel	Possible values: self or Job Status. If the value is set to Job Status, you can use the href to get the status
data	Parameters as key value pairs passed in the request

Example of Response Body

{
  "details": null,
  "status": -1,
  "items": [
    {
      "status": "EssbaseBlockAnalysisReport' Job has been 'started"
    }
  ],
  "links": [
    {
      "href": "https://<BASE-URL>/interop/rest/diag/v1/services/essbaseblockanalysisreport",
      "action": "POST",
      "rel": "self",
      "data": null
    },
    {
      "href": "https://<BASE-URL>/interop/rest/diag/v1/services/jobs/<JOB_ID>",
      "action": "GET",
      "rel": "Job' 'Status",
      "data": null
    }
  ]
}

Sample cURL Command

curl -s -u <USERNAME>:<PASSWORD> -H 'Content-Type: application/json' --request POST https://<BASE-URL>/interop/rest/diag/v1/services/essbaseblockanalysisreport -d '{
  "exportDataFile": "EXPORT_DATA_FILE",
  "reportFile": "REPORT_FILE"
}'