My Oracle Support Banner

Oracle BI Publisher Web Services APIs - Common Use Case Examples (Doc ID 1344535.1)

Last updated on APRIL 01, 2021

Applies to:

BI Publisher (formerly XML Publisher) - Version to 12c [Release 11.1 to 12.0]
Information in this document applies to any platform.


This documents contains some common use case examples for Oracle BI Publisher Web Services APIs.


This documented is intended for developers whom are creating integrations with Oracle BI Publisher via the available Web Services APIs.


To view full details, sign in with your My Oracle Support account.

Don't have a My Oracle Support account? Click to get started!

In this Document
 Useful Tools
 Common Use Cases
 1. How to capture XML data instead of an actual report?
 2. How to get the parameter details of an existing report definition?
 3. ScheduleService: from scheduleReport to getDocumentData in 4 steps
 3.1 Schedule the report using ScheduleService.scheduleReport()
 3.2 Fetch all child jobs via ScheduleService.getAllScheduledReportHistory()
 3.3 Determine the outputId of the generated report using ScheduleReport.getScheduledReportOutputInfo()
 3.4 Retrieve the generated document using  ScheduleReport.getDocumentData()

My Oracle Support provides customers with access to over a million knowledge articles and a vibrant support community of peers and Oracle experts.