Generate Program Documentation Report - Run as a Job

Use this operation to submit 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 download file REST API or EPM Automate downloadfile command

REST Resource




Supported Media Types: application/json


The following table summarizes the client request.

Table 13-11 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 PDF
fileName Name of the output file Request Payload No HPCMMLProgramDocumentationReport_<AppName>_POV.pdf
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> epm/rest/v1/applications/<applicationName>/<povName>/jobs/programDocReportJob

Request Payload

     "fileType": "PDF",
     "useAlias": false,

Response Body

Supported Media Types: application/json

Table 13-12 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 FY12ActualReport.pdf generated successfully in the outbox folder",
    "links": [
"action": "GET",
            "rel": "self",
            "data": {
                "fileType": "PDF",
                "useAlias": false,
                "stringDelimiter": "_"
"href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
"action": "GET",
            "rel": "Job Status"