Generate Model Documentation Report

Generates an Enterprise Profitability and Cost Management Model Documentation report.

This is an asynchronous call, so use the job status URI to determine whether the operation is complete.

Any validation failures are written to file with file name provided in the parameters, and can be accessed from Inbox/Outbox Explorer.

This API is version v3.

Required Roles

Service Administrators

REST Resource

POST /HyperionPlanning/rest/v3/applications/{AppName}/jobs/

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Request

Supported Media Types: application/json

The following table summarizes the client request parameters specific to this job.

Table 23-12 Parameters

Name	Description	Type	Required	Default
`jobType`	`Generate EPCM Report`	Payload	Yes	None
`jobName`	User-specified name for this job execution Example: `"Model Documentation Report for 10 Actuals Allocation Process"`	Payload	Yes	None
`reportName`	`"MODEL_DOC"`	Payload	Yes	None
`outputFileName`	Name of the output file to which the report will be generated Example: `"My_Model_Doc_Report_Output"`	Payload	Yes	None
`outputType`	(PDF \| Word \| Excel \| HTML \| XML) Format in which the output will be generated Example: `"PDF"`	Payload	Yes	None
`modelName`	Name of model for which the report is generated Example: `"10 Actuals Allocation Process"`	Payload	Yes	None

Sample Payload

{
   "jobType":"Generate EPCM Report",
   "jobName":"Model Documentation Report for 10 Actuals Allocation Process",
   "parameters":{
        "reportName":"MODEL_DOC",
        "outputFileName":"My_Model_Doc_Report_Output",
        "outputType":"PDF",
        "modelName":"10 Actuals Allocation Process"
  }
}

Response

Supported Media Types: application/json

Table 23-13 Parameters

Name	Description
`jobId`	ID of the job that is created
`jobName`	Name of the job
`details`	In case of errors, details are published with the error string
`status`	See Migration Status Codes.
`links`	Detailed information about the link
`href`	Links to the API call
`action`	HTTP call type
`rel`	Can be `self` and/or `Job-details`. If set to `Job Status`, you can use the `href` to get the status of the job.
`data`	Parameters as key value pairs passed in the request

Example of Response Body

The following examples show the contents of the response body in JSON format:

Example 1: Job is in Progress

{
    "jobId": 26,
    "jobName": "Generate Report",
    "status": -1,
    "descriptiveStatus": "Processing",
    "details": null,
    "links": [
         {
            "rel": "self",
            "href":http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/6,
            "action": "GET"
         },
         {
            "rel": "job-details",
            "href":http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/6/details,
            "action": "GET"
        }
    ]
}

Example 2: Job Status with No Errors

{
    "jobId": 26,
    "jobName": "Generate Report",
    "status": 0,
    "descriptiveStatus": "Success",
    "details": null
    "links": [
        {
            "rel": "self",
            "href":http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/6,
            "action": "GET"
        },
        {
            "rel": "job-details",
            "href":http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/6/details,
            "action": "GET"
        }
    ],
}