Generate an Intercompany Matching Report

This REST API is used to execute an Intercompany Matching Report job.

For details on this task, see Managing Intercompany Matching Reports.

This REST API returns the job ID after starting the Intercompany Matching Report job.

Required Roles

Service Administrator, Power User or User

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/jobs

Request

Supported Media Types: application/json

Table 18-21 Parameters

Name	Description	Type	Required	Default
`api_version`	Version of the API you are working with: v3	Path	Yes	None
`application_name`	The name of the application Get the application name by using the Get Applications API. See Get Applications.	Path	Yes	None
`jobName`	The name of the saved Intercompany report definition, for example: IC_Job_01	Payload	Yes	None
`jobType`	Type of Job. Supported value: GENERATE_INTERCOMPANY_REPORT	Payload	Yes	None
`parameters`	Pass optional parameters to set the report POV	Payload	No	None

Table 18-22 Optional Parameters

Name	Description
`scenario`	The member of the Scenario dimension for the report, for example, Actual
`years`	The member of the Year dimension for the report, for example, FY22
`period`	The member of the Period dimension for the report, for example, December
`reportFormat`	The format for the report, for example, HTML
`fileName` (optional)	A filename for the report, for example, intercompany_receivables_report

Example of Request Body

{
"jobType": "GENERATE_INTERCOMPANY_REPORT",
"jobName": "icp1",
"parameters": {
"scenario":"actual",
"years": "FY22",
"period":"Dec",
"reportFormat":"HTML"
"fileName":"intercompany_receivables_report"
}
}

Response Body

Supported Media Types: application/json

Table 18-23 Parameters

Name	Description
`type`	Financial Consolidation and Close Application type, for example, FCCS
`status`	Status of the job: -1 =In progress 0 = Success; 1 = Fail 2 = Cancel Pending 3 = Cancelled 4 = Invalid Parameter >4 = Unknown
`details`	In case of errors, details are published with the error string.
`descriptiveStatus`	The status of the job, such as Completed or Error
`items`	Collection of Notification categories
`links`	Detailed information about the link
`href`	Links to API call
`action`	The HTTP call type
`rel`	Relationship type. Possible values: self

Example of Response Body:

The following shows an example of the response body in JSON format.

{
    "descriptiveStatus": "Processing",
    "jobId": 33,
    "jobName": "icp1",
    "details": null,
    "status": -1,
    "links": [
        {
            "rel": "self",
            "href": "http://slcar262.usdv1.oraclecloud.com:12055/HyperionPlanning/rest/v3/applications/tst/jobs/33",
            "action": "GET"
        },
        {
            "rel": "job-details",
            "href": "http://slcar262.usdv1.oraclecloud.com:12055/HyperionPlanning/rest/v3/applications/tst/jobs/33/details",
            "action": "GET"
        }
    ]
}