1. Oracle BI Publisher REST APIREST API for Oracle BI Publisher
  2. Quick Start

Quick Start

Set up your environment and create your first report for Oracle BI Publisher using the REST API by performing these steps:

  • Step 1 Obtain account information

  • Step 2 Install cURL

  • Step 3 Fetch report details

Step 1: Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to manage reports using the REST APIs. Specifically, you will need:

  • Username and password for Oracle BI Publisher

  • The URL of your Oracle BI Publisher instance

Step 2: Install cURL

The examples within this document use the cURL command-line tool to demonstrate how to access the Oracle BI Publisher REST API.

To connect securely to the server, you must install a version of cURL that supports SSL and provide an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. See also:

To install cURL on a Windows 64 bit system:

  1. In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.

  2. On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.

  3. Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the ca-bundle.crt SSL CA certificate bundle in the folder where you installed cURL.

  4. Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate bundle. For example:

    C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt

You are now ready to send requests to the Oracle BI Publisher using cURL.

Step 3: Fetch Report Details

Run this cURL command to return an existing report definition:

curl --u username:password -H "Accept:application/json" -X GET http://host:port/xmlpserver/services/rest/v1/reports/<reportPath>

For example, to fetch a report definition located at /Sample Lite/Published Reporting/Reports/Balance Letter:

curl --u jsmith:mypassword1 -H "Accept:application/json" -X GET http://example.com/xmlpserver/services/rest/v1/reports/%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter