Generate Report for Financial Consolidation and Close and Tax Reporting

Generates a Task Manager report or Supplemental Data report for Financial Consolidation and Close and Tax Reporting.

This API is version v1.

Note:

All parameters must be specified for a report.

REST Resource

POST       /HyperionPlanning/rest/fcmapi/{api_version}/report

Request

Example of request body (to be run synchronously)

Example of request body (to be run asynchronously for larger reports)

Supported Media Types: application/json

The following table summarizes the client request.

Table 9-3 Report Parameters

Name Description Path Required
api_version Version of the API you are working with. This release is v1 Yes Yes
groupName The name of the group the report is associated with. No Yes
reportName The name of the report to be generated. No Yes
generatedReportFileName The user-specified name of the report to be generated. If this parameter is not provided, then the report will get generated with the data for reportName parameter in this table. No No
parameters Types of parameters:
  • Numerical - should be in BigDecimal format.
  • Text - standard string
  • Date - should be in format YYYY-MM-dd
  • Boolean
  • Users - user login ID
  • List of choices - case insensitive values
No No
format The format of the report (HTML, PDF, XLSX, or CSV). No No (Default is PDF)
module The module within custom SDM (Supplemental Data Management) or FCCS. FCCS refers to the Task Manager module. No No
emails Comma separated list of email addresses that will receive the report. No No
runAsync Generation of report runs asynchronously (true) or synchronously (false).

Oracle recommends setting this value to true (async) for larger reports. An example of request body and output is shown.

No No (Default is false)

For details about reportName or parameters see Using Task Manager and Supplemental Data Manager Reports.

For details about Output Format, see Generating the Report .

For details about retrieving job status while running reports, see Retrieve Job Status for a Report.

{
"groupName":"Task Manager",
"reportName":"Late Tasks",
"generatedReportFileName":"myReport.pdf",
 "parameters":{"Schedule" : "Qtr 2 Close", "Period":"Jun" },
"format":"PDF",
"module":"FCCS",
"emails":"user1@oracle.com,user2@oracle.com",
"runAsync":false
}
{
"groupName":"Task Manager",
"reportName":"Late Tasks",
"generatedReportFileName":"myReport.pdf",
 "parameters":{"Schedule" : "Qtr 2 Close", "Period":"Jun" },
"format":"PDF",
"module":"FCCS",
"emails":"user1@oracle.com,user2@oracle.com",
"runAsync":true
}

Response

Examples of Response Body

Supported Media Types: application/json

Parameters:

Table 9-4 Parameters

Name Description
type Type of report: SDM (Supplemental Data Management) or FCCS {Task Manager).
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 The HTTP call type
rel Relationship type (self, Job Status). If set to Job Status, you can use the href to get the status of the operation.
data Parameters as key value pairs passed in the request

The following is an example of the response body in JSON format for a Financial Consolidation and Close report called MyReport in pdf format that was run successfully synchronously (runAsync=false):

{
     "links": [
         {
             "rel": "self",
             "href": 
"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/myReport.pdf",
             "action": "POST"
         },
         {
             "rel": "report-content",
             "href": 
"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/myReport.pdf",
             "action": "POST"
 "GET"
         }
     ],
     "details": "MyReport.pdf",
     "type": "FCCS",
     "status": 0,
     "link": null,
     "error": null,
     "items": null
}

The following is an example of the response body in JSON format for a Financial Consolidate and Close report generated asynchronously (runAsync=true) where the report is "In Process" and you can use the Job ID generated to retrieve the job status. See Retrieve Job Status for a Report:

{
 "links":[
{
 "rel":"self",
 "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/report",
"action": "POST"
},
{
"rel":"Job Status",
 "href":  "https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/report/job/FCCS/100000001001009",
 "action": "GET"
}
],
"details":"In Process",
"status":-1,
"type":"FCCS",
"link":null,
"error":null
"items":null
}