Send Requests
Use the following guidelines when sending requests to the Oracle CPQ Cloud Service REST API.
URL Structure
Every call to the Oracle CPQ Cloud Service REST API must be made to a URL endpoint created using the following structure:
https://{siteurl}/rest/v6/{resource}{additionalParams}
| Endpoint URL Parameter | Description |
|---|---|
{siteurl} |
The base URL of the Oracle CPQ Cloud Service site. |
{resource} |
The name of the REST resource. |
{additionalParams} |
Optional additional parameters to specify the REST call. |
{queryParams} |
Optional parameters to query the REST resource. Note: If query parameters are not added to the Endpoint URL, the See Query Parameters for more information. |
For example:
REST Call to the Resource
https://testsite.oracle.com/rest/v6/documentGenerator
REST Call to the Resource with Additional Parameters
https://testsite.oracle.com/rest/v6/commerceDocumentsNorthAmericaTransaction/12345678
REST Call to the Resource with Query Parameters
https://testsite.oracle.com/rest/v6/performanceLogs?q={$and:[{component:{$eq: 'superuser'}},{$or:[{event:{$eq: "Login"}},{browserTime:{$exists: true}}]}]}&orderby=eventDate:desc
Supported Methods
CRUD (create, read, update, and delete) operations that can be performed on each exposed Oracle CPQ Cloud Service resource may vary. See each individual resource page for a full list of available CRUD operations.
| HTTP Method | Description |
|---|---|
GET |
Send a request to the Oracle CPQ Cloud Service REST resource asking to receive specific data back |
POST |
Send a command to the Oracle CPQ Cloud Service REST resource to invoke an operation |
DELETE |
Send a command to the Oracle CPQ Cloud Service REST resource to delete itself |
Media Types
Media types such as application/json, application/schema+json, and application/octet-stream are supported by the Oracle CPQ Cloud Service REST API. See individual REST endpoints for details.
Supported Headers
Three Header types can (and in some cases must) be included in calls to Oracle CPQ Cloud Service REST resources:
| Header | Description |
|---|---|
|
|
An Accept Header denotes what type of response the Oracle CPQ Cloud Service REST resource should send back. Oracle CPQ Cloud Service REST resources can send JSON, JSON Schema, and Binary responses back. Accept: application/json OR Accept: application/schema+json OR Accept: application/octet-stream |
|
|
A Content-Type Header denotes how the body of the REST call is encoded. Only POST and DELETE calls must contain a Content-Type Header. Payloads sent to Oracle CPQ Cloud Service REST resources must be encoded in JSON. Content-Type: application/json |
|
|
An Authorization Header contains the authentication needed to access the system being called. Oracle CPQ Cloud Service user access restrictions apply to REST calls. If a user cannot perform an operation within the Oracle CPQ Cloud Service user interface due to any type of user access restriction, the user will not be able to perform the operation via a REST call. Authorization Headers of calls to Oracle CPQ Cloud Service REST resources must adhere to HTTP Basic authentication standards, and must contain valid, Base64-encoded Oracle CPQ Cloud Service credentials ( Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg |