Rest API

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 3

Please find below the steps to test the REST Resource available to retrieve reports POST

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

1. Pasted the below url in “Request URL” field with GET method to check for the active api
versions in our application as shown in the below screenshot. V3 seems like the active
one in the application but we use V1 to test the above API

https://planning-test-ejlu.pbcs.us2.oraclecloud.com/HyperionPlanning/rest/

2. Next, pasted the below URL in the “Request URL” field with POST method as shown in
the screenshot
The 2 headers used are :
Header Name Header Value
Content-Type application/json

Authorization Basic
ZWpsdS5yYW1pbGluZW5pQGRlbG9pdHRlLmNvbTpSdWtpQDY2Ng==

https://planning-test-
ejlu.pbcs.us2.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/report

3. Navigated to Body section , selected Body content type as “application/json” and Editor
View as Raw Input.
a. Pasted the below JSON object if we want to obtain the Late Tasks report in the
Task Manager group which is working as expected.
{
"groupName": "Task Manager",
"reportName": "Late Tasks",
"format": "XLS",
"module": "FCCS"
}
b. Pasted the below JSON Object to obtain the Balance Sheet Consolidated
Financial Report as shown in the below screenshot
{
"groupName": "Financial",
"reportName": "Balance Sheet Consolidated",
"format": "XLS",
"module": "FCCS"
}

4. Clicked on SEND to send the request to the server.


a. If the JSON Object in step 4.a is used ,we get a 200 SUCCESS response from the
server and the Late Tasks Report is generated in the inbox/outbox folder of the
FCCS Application in the format mentioned in the JSON object .
b. If the JSON Object in step 4.b is used, we get a 400 Bad Request response from
the server with the error mentioned as “Either the group name is invalid or you
don't have access to any reports with in the group.” as seen in the below
screenshot

You might also like