Oracle Communities

Oracle Analytics and AI

Child Item

Sample REST API url and payload to call BIP Report

Hi Team,

We have requirement to call BIP report through integration in which we need REST API to call.
I have standard REST API that is Run Report : /services/rest/v1/reports/{reportPath}/run url but help us to prepare sample API and How to pass the parameter.

Find more posts tagged with

Accepted answers

Sumanth V -Oracle

@User_T27VM - Please let us know if you are using OAC BIP(CLOUD) or a standalone or On-premise BIP. Also, do you have the authentication part sorted and need only assistance with payload for run report API alone, please confirm.

All comments

Sumanth V -Oracle

MayuriMMote

Hi @Sumanth V -Oracle -

We are using OAC BIP(CLOUD). I need only assistance with payload for run report API alone using Postman. I have authentication to call API's

Sumanth V -Oracle

@User_T27VM , Please refer the below blog, this has a sample example on how the payload is passed to run a report and download the output as pdf as well.

Topic: Run a Publisher Report

https://blogs.oracle.com/analytics/post/run-schedule-publisher-reports-on-oac-using-rest-apis

MayuriMMote

Hi @Sumanth V -Oracle -

As per suggested blog I tried to ran REST API but getting 404 NOT Found error.
Could you check the URL which I am trying to hit :

https://<Instance URL>/xmlpserver/services/rest/v1/reports/Custom%252FCSOD%20Custom%252FReports%252FPTP%252FExpenses%252FMobile%20App%20Approval%252FCurrent%20Approver%20Detail%20Report/run/'parameter value'

Operation:POST

Sumanth V -Oracle

@User_T27VM - The URL seems to be fine. Can we try just running the report first without a parameter value. Choose a simple report with no parameters and try running the same first and let us know if it works.

MayuriMMote

Hi @Sumanth V -Oracle

I have tried the URL without parameter but getting the error, The requested URL was not found on this server.

As per the suggested blog where we need to set below values:

curl -X POST -H "Authorization: Bearer eyJ4NXQjUzI1NiI6IkttM1VBWEttaHpHa0pxeDFnQldrZ1RFOFVJU0VtYklEdVpJUGdYVVUtb1EiLCJ4NXQiOiJ1S0h3cXp6M1c2S3czcWU3NnE5UFdXbTRQS3ciLCJraWQiOiJTSUdOSU5HX0tFWSIsImFsZyI6IlJTMjU2In0………………………………………………………tlr6Njab5i5qW1A" -o SampleOAPReport.pdf -H "Content-Type:multipart/form-data" -v -F 'ReportRequest={"attributeFormat":"pdf"};

Sumanth V -Oracle

@User_T27VM - As per the blog below is the syntax:

curl -X POST -H "Authorization: Bearer <Token generated for Auth>" -o SampleOAPReport.pdf -H "Content-Type:multipart/form-data" -v -F 'ReportRequest={"attributeFormat":"pdf"};type=application/json' https://<instancename>-<NameSpace>-<region>.analytics.ocp.oraclecloud.com/api/xmlpserver/services/rest/v1/reports/<Report part up to shared folders>/run

MayuriMMote

@Sumanth V -Oracle

Apart from URL it wont allow me to add any other syntax.

MayuriMMote

Hi @Sumanth V -Oracle

The BIP report which I am trying to ran is on Oracle cloud Application. Integration team needs REST API to call that report from their end. I already provided ExternalReportWSSService webservice and working payload but instead of SOAP Webservice they need REST API to call that report.
In the blog I saw they are using some authentication token but I don't have that. let me know the approach I am following is the correct or not?

Sumanth V -Oracle

@User_T27VM - The bearer token is for authentication. It would be helpful if you can share the entire command ran through Oracle cloud application and response received from it. It would be helpful in debugging.