Send Requests
Use the following guidelines when sending requests using the Oracle BI Publisher REST API.
URL Structure
Access the Oracle BI Publisher REST resources using the following URL structure:
https://<host>:<port>/xmlpserver/services/rest
host Name of the host where Oracle BI Publisher is running.
port IP port where Oracle BI Publisher is running.
/xmlpserver/services/rest Fixed prefix for Oracle BI Publisher REST resources. For a complete list of resources, see REST Endpoints.
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on Oracle BI Publisher using standard HTTP method requests, as summarized in the following table.
| HTTP Method | Description |
|---|---|
| GET | Retrieve information about an Oracle BI Publisher resource. |
| POST | Create or retrieve an Oracle BI Publisher resource. |
| PUT | Update Oracle BI Publisher resources. |
| DELETE | Delete Oracle BI Publisher resources. |
Media Types
The following media types are supported by the Oracle BI Publisher REST API:
application/json
multipart/form-data
application/octet-stream
Supported Headers
The Oracle BI Publisher REST API supports the following headers that may be passed in the header section of the HTTP request or response.
| Header | Description | Example |
|---|---|---|
| Accept | Media type of the body of the response. | Accept: application/json |
| Content-Type | Media type of the body of the request. Required for POST and PUT requests. | Content-Type: application/json |