Extract Data REST API Enhancements

Oracle CPQ 24B introduces data store endpoints for the Extract Data REST API. These endpoints allow a customer to identify data stores (i.e., objects) and data store attributes that can be extracted from CPQ. Customers can also use available data store attributes to define criteria to extract data from the specified data store.

Get All Data Stores

Use this endpoint to return the list of data stores available for extract.

• Endpoint: /rest/v16/extract/dataStores
• Method:  GET

Get All Data Store Attributes

Use this endpoint to return the list of data store attributes available for extract.

• Endpoint: /rest/v16/extract/dataStores/{dataStoreName}/attributes
• Method:  GET

Extract Data Stores

Use this endpoint to submit a request to extract data stores.

• Endpoint: /rest/v16/extract/dataStores/actions/extractData
• Method:  POST

Customers can use data stores to extract customized data from CPQ.

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Tips And Considerations

The CPQ Extract Data REST API only supports Commerce main document and sub-document attributes and arrays.