Overview
These endpoints support pricing export, import, and bulk data services using web services.
Administration
|
Description |
Use this endpoint to export a pricing entity. Only price model and price agreement matrix grids are supported at this time. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/actions/export |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
entity |
The type of pricing entity Allowed Values: " |
|
filename |
The file name | |
|
id |
The variable name of the parent price model or price agreement | |
| Response Body Parameters |
createdBy |
The details of the user who created the record |
|
lastModifiedBy |
The details of the user who modified the record | |
|
links |
The link relations associated with the resource instance | |
|
messages |
List of task submission response messages | |
|
taskId |
The task identifier | |
https://sitename.oracle.com/rest/v17/pricingSetup/actions/export
{ "entity": "matrixGrid", "id": "test2" }
{ "taskId": 3023175064, "links": [{ "rel": "related", "href": "http://sitename.oracle.com/rest/rest/v17/tasks/3023175064" } ] }
Note: Refer to Task REST APIs to retrieve status for tasks, cancel tasks, and retrieve files associated with a task (e.g.export zip files).
|
Description |
Use this endpoint to import a pricing entity. Only price model and price agreement matrix grids are supported at this time. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/actions/import |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Header |
Content-Type: multipart/form-data |
|
| Request Body Parameters |
entity |
The type entity to be imported (eg. matrixGrid) |
|
file |
The file to be imported (required). |
|
|
id |
The variable name of the target price model or price agreement |
|
| Response Body Parameters |
links |
The link relations associated with the resource instance |
|
messages |
List of task submission response messages | |
|
taskId |
The task identifier | |
https://sitename.oracle.com/rest/v17/pricingSetup/actions/import
--header 'Accept: application/zip' \ --header 'Content-Type: multipart/form-data' \
--form 'id="test2"' \ --form 'entity="matrixGrid"' \ --form '=@"/D://matrixGrid_test2.zip"'
{ "taskId": 3023175064, "links": [{ "rel": "related", "href": "http://sitename.oracle.com/rest/rest/v17/tasks/3023175064" } ] }
|
Description |
Use this endpoint to retrieve Charge attributes to define CSV headers for bulk data service uploads. |
|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingBulkDataHeaders/charge |
|
Endpoint Parameters |
None |
|
HTTP Method |
GET |
| Request Body Parameters | None |
| Success Response |
200 |
Get Price Model Bulk Data Headers
|
Description |
Use this endpoint to retrieve Price Model attributes to define CSV headers for bulk data service uploads. |
|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingBulkDataHeaders/priceModel |
|
Endpoint Parameters |
None |
|
HTTP Method |
GET |
| Request Body Parameters | None |
| Success Response | Success Response |
Get Price Model Item Bulk Data Headers
|
Description |
Use this endpoint to retrieve Price Model Item attributes to define CSV headers for bulk data service uploads. |
|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingBulkDataHeaders/priceModelItem |
|
Endpoint Parameters |
None |
|
HTTP Method |
GET |
| Request Body Parameters | None |
| Success Response | Success Response |
Get Rate Plan Bulk Data Headers
|
Description |
Use this endpoint to retrieve Rate Plan attributes to define CSV headers for bulk data service uploads. |
|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/pricingBulkDataHeaders/ratePlan |
|
Endpoint Parameters |
None |
|
HTTP Method |
GET |
| Request Body Parameters | None |
| Success Response | Success Response |
|
Description |
Use this endpoint to bulk upload Oracle CPQ pricing data. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/bulkDataService/actions/upload |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Header |
Content-Type: multipart/form-data |
|
| Request Body Parameters |
entity |
The type entity to be imported (eg. matrixGrid) |
|
file |
The file to be imported (required). |
|
|
id |
The variable name of the target price model or price agreement |
|
| Response Body Parameters |
createdBy |
The details of the user who created the record. |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
links |
The link relations associated with the resource instance. |
|
|
messages |
List of task submission response messages. |
|
|
taskId |
The task identifier |
|
https://sitename.oracle.com/rest/v17/bulkDataService/actions/upload
--header 'Accept: application/zip' \
--header 'Content-Type: multipart/form-data' \
--form 'id="test2"' \ --form 'entity="matrixGrid"' \ --form '=@"/D://matrixGrid_test2.zip"'
{ "taskId": 3023175064, "links": [{ "rel": "related", "href": "http://sitename.oracle.com/rest/rest/v17/tasks/3023175064" } ] }
