Developer Toolkit REST APIs
Overview
Beginning in Oracle CPQ 21A, the following REST APIs are available to support Developer Toolkit functions: download, validate, save, and deploy site BML and BMLT (BigMachines Extensible Language Test) files.
Administration
Get All BML and BMLT Files
| Description |
Use this endpoint to download zip file of site's Commerce BML and BMLT files.
This endpoint is equivalent to the cpq-toolkit pull command.
|
| URI Endpoint |
/rest/v17/adminMeta
|
| HTTP Method |
GET |
| Accept Header |
application/zip
|
| Request Body Parameters |
None
|
| Response Body Parameters |
Returns a zip file with metadata of all supported entities.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta
Developer Toolkit Validate
| Description |
Use this endpoint to validate BML and BMLT updates provided in the input file.
This endpoint is equivalent to the cpq-toolkit push --no-test --no-save command.
|
| URI Endpoint |
/rest/v17/adminMeta/actions/validate
|
| HTTP Method |
POST
|
| Accept Header |
application/zip
|
| Request Supported Media Type |
form-data
|
| Form Parameters |
File - Select zip file to be imported |
| Response Body Parameters |
Returns a zip file with associated log files.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta/actions/validate
Developer Toolkit Test
| Description |
Use this endpoint to validate and save BML and BMLT updates provided in the request body, run BMLTs, and then deploy.
This endpoint is equivalent to the cpq-toolkit push --no-save command.
|
| URI Endpoint |
/rest/v17/adminMeta/actions/test
|
| HTTP Method |
POST |
| Accept Header |
application/zip
|
| Request Supported Media Type |
form-data
|
| Form Parameters |
File - Select zip file to be imported |
| Response Body Parameters |
Returns a zip file with associated log files.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta/actions/test
Developer Toolkit Force Save
| Description |
Use this operation to validate and save BML and BMLT payload data.
This endpoint is equivalent to the cpq-toolkit push --no-test command.
|
| URI Endpoint |
/rest/v17/adminMeta/adminMeta/actions/forceSave
|
| HTTP Method |
POST |
| Accept Header |
application/zip
|
| Request Supported Media Type |
form-data
|
| Form Parameters |
File - Select zip file to be imported |
| Response Body Parameters |
Returns a zip file with associated log files.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta/actions/forceSave
Developer Toolkit Save
| Description |
Use this endpoint to validate and save BML and BMLT updates provided in the input Zip file.
This endpoint is equivalent to the cpq-toolkit push command.
|
| URI Endpoint |
/rest/v17/adminMeta/actions/save
|
| HTTP Method |
POST |
| Accept Header |
application/zip
|
| Request Supported Media Type |
form-data
|
| Form Parameters |
File - Select zip file to be imported |
| Response Body Parameters |
Returns a zip file with associated log files.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta/actions/save
Developer Toolkit Force Deploy
| Description |
Use this endpoint to validate, save and deploy BML and BMLT provided in the input Zip file, unit tests will be ignored.
This endpoint is equivalent to the cpq-toolkit push --no-test -d command.
|
| URI Endpoint |
/rest/v17/adminMeta/actions/forceDeploy
|
| HTTP Method |
POST |
| Accept Header |
application/zip
|
| Request Supported Media Type |
form-data
|
| Form Parameters |
File - Select zip file to be imported |
| Response Body Parameters |
Returns a zip file with associated log files.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta/actions/forceDeploy
Developer Toolkit Deploy
| Description |
Use this endpoint to validate and save BML and BMLT updates provided in the request body, run BMLTs, and then deploy.
This endpoint is equivalent to the cpq-toolkit push -d command.
|
| URI Endpoint |
/rest/v17/adminMeta/actions/deploy
|
| HTTP Method |
POST |
| Accept Header |
application/zip
|
| Request Supported Media Type |
form-data
|
| Form Parameters |
File - Select zip file to be imported |
| Response Body Parameters |
Return a zip with logs and test execution results.
|
URI Endpoint Sample
https://site.oracle.com/rest/v17/adminMeta/actions/deploy
Related Topics
See Also
