Quick Start

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

Prerequisites

Prerequisite More Information
Install cURL Use cURL
Set up authentication Authenticate

Task 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

Task 2: 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:port/xmlpserver/services/rest/v1/reports/Sample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter