Generate Program Documentation Report - Run as a Job
Submits a job to generate a Program Documentation report for a given Profitability and Cost Management point of view.
The report is generated in the profitoutbox folder with the name as fileName parameter value or
HPCMMLProgramDocumentationReport_{AppName)_{POV}.pdf
as default. The
file can be downloaded using File Explorer or by using the EPM Automate
downloadfile
command.
Required Roles
Service Administrator, Power User, User, or Viewer
REST Resource
POST
/epm/rest/{api_version}/applications/<applicationName>/povs/<povName>/jobs/programDocReportJob
Request
Supported Media Types: application/json
The following table summarizes the client request.
Table 23-23 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are developing with, such as v1 |
Path | Yes | None |
applicationName |
Name of the application for which to create the report | Path | Yes | None |
povName |
The POV for which to create the report, for example, FY17_JUN_Actual_Working | Path | Yes | None |
fileType |
The file format to use for the report, PDF , XML , WORD , EXCEL , or HTML |
Request Payload | No | |
fileName |
Name of the output file | Request Payload | No | HPCMMLProgramDocumentationReport_<AppName>_POV.pdf |
subsetStart |
Rule set starting sequence number to specify a range of rule sets to include in the report | Request Payload | No | None |
subsetEnd |
Rule set ending sequence number to specify a range of rule sets to include in the report | Request Payload | No | None |
useAlias |
Boolean value to specify whether to use aliases in the report, true or false |
Request Payload | No | False |
stringDelimiter |
POV Dimension members separator | Request Payload | No | "_" |
Example URL
https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/
epm/rest/v1/applications/<applicationName>/povs/<povName>/jobs/programDocReportJob
Request Payload
{
"fileName":"FY12ActualReport.pdf",
"fileType": "PDF",
"subsetStart":"1",
"subsetEnd":"6",
"useAlias": false,
"stringDelimiter":"_"
}
Response Body
Supported Media Types: application/json
Table 23-24 Parameters
Name | Description |
---|---|
details |
Program Documentation report name, such as HPCMMLProgramDocumentationReport_BksML30_2016_January_Actual.pdf , and report status
|
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":"Program Documentation report 2016JanActual1.pdf generated successfully in the Outbox folder.",
"links":[
{
"href":"http:// <SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/jobs/ChecktaskStatusJob/BksML30_ProgramDocumentation_D20220511T115113_52a",
"action":"GET",
"rel":"Job Status"
}
]
}