Generate Program Documentation Report

Use this operation 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 HPCMMLProgramDocumentationReport_{AppName)_{POV}.pdf. The file can be downloaded using File Explorer.

REST Resource

GET epm/rest/{api_version}/applications/{application}/povs/{POV}/programDocumentationReport?queryParameter={"fileType":"PDF","useAlias":"true"}


Supported Media Types: application/json


The following table summarizes the client request.

Table 13-9 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 for which to create the report Path Yes None
pov 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 Query No PDF
useAlias Boolean value to specify whether to use aliases in the report, true or falset Query No false

Example URL with fileType set to PDF and useAlias set to true:


Response Body

Supported Media Types: application/json

Table 13-10 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": 0,
    "statusMessage": "Success",
    "details": "Program Documentation report HPCMMLProgramDocumentationReport_BksML30_2016_January_Actual.pdf generated successfully in the outbox folder.",
    "links": [{
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
        "rel": "self",
        "data": {
            "useAlias": false
        "action": "GET"