Run report
post
/services/rest/v1/reports/{reportPath}/run
Sends a request to the Oracle BI Publisher server to run a specific report.
The request is syncronized, and the response contains the report output.
Request
Supported Media Types
- multipart/form-data
Path Parameters
- reportPath
-
Type:
string
Required:true
URL encoded report path. For example, if your report path is "/Sample Lite/Published Reporting/Reports/Balance Letter" then your encoded report path will be "%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter".
Form Parameters
- ReportData
-
Type:
file
Report data. "Content-Type: application/octet-stream"- ReportRequest
Required:true
Report request. "Content-Type: application/json". Check the ReportRequest of Get report parameters (/services/rest/v1/reports/{reportPath}/parameters) for JSON structure.
Response
Supported Media Types
- multipart/form-data
200 Response
Returns the report output as multipart/form-data having two parts.
1) ReportResponse having "Content-Type: application/json".
2) ReportOutput having "Content-Type: application/octet-stream".
Body
Root Schema : ReportResponse
Type:
object
- ReportOutput
-
Type:
string
(binary
)Report output. - ReportResponse
-
Type:
object
ReportResponseMetaData
Nested Schema : ReportResponseMetaData
Type:
object
- metaDataList
-
Type:
object
MetaDataList - reportContentType
-
Type:
string
The report content type. Possible values include: "text/html;charset=UTF-8""text/plain;charset=UTF-8" "application/pdf" "application/vnd.ms-powerpoint" "application/vnd.ms-excel" "application/msword" "application/x-shockwave-flash" "text/xml" "message/rfc822" - reportLocale
-
Type:
string
The locale selected for the report (for example, fr_FR).
Nested Schema : MetaDataList
Type:
object
- metaDataName
-
Type:
string
The name of the metadata. - metaDataValue
-
Type:
string
The metadata content.
Examples
Simple run report request and response
This example shows the request structure to run a simple report:
--Boundary_1_1153447573_1465550731355 Content-Type: application/json Content-Disposition: form-data; name="ReportRequest" {"byPassCache":true,"flattenXML":false} --Boundary_1_1153447573_1465550731355--
This example represents the response:
--Boundary_4_543972006_1465550732053 Content-Type: application/json Content-Disposition: form-data; name="ReportResponse" {"reportContentType":"application/pdf"} --Boundary_4_543972006_1465550732053 Content-Type: application/octet-stream Content-Disposition: form-data; filename="xmlp3001677868600512506tmp"; modification-date="Fri, 10 Jun 2017 09:25:32 GMT"; size=7638; name="ReportOutput" <Report output . For example PDF,HTML,EXCEL content> --Boundary_4_543972006_1465550732053--
Run a report with custom report data
This example shows the request structure to run a report with custom report data:--Boundary_3_384617262_1465550732541 Content-Type: application/json Content-Disposition: form-data; name="ReportRequest" {"byPassCache":true,"flattenXML":false} --Boundary_3_384617262_1465550732541 Content-Type: application/xml Content-Disposition: form-data; filename="Balance Letter.xml"; modification-date="Tue, 01 Jan 2000 07:35:28 GMT"; size=24700; name="ReportData" <Report XML Data Content> --Boundary_3_384617262_1465550732541--
This example represents the response:
--Boundary_6_656616533_1465550732888 Content-Type: application/json Content-Disposition: form-data; name="ReportResponse" {"reportContentType":"application/pdf"} --Boundary_6_656616533_1465550732888 Content-Type: application/octet-stream Content-Disposition: form-data; filename="xmlp2661880851808387788tmp"; modification-date="Fri, 01 Jan 2000 09:25:32 GMT"; size=7647; name="ReportOutput" <Report output . For example PDF,HTML,EXCEL content> --Boundary_6_656616533_1465550732888--