REST API Services for Oracle CPQ

Configuration REST Endpoints

Configuration

The Configuration Run-Time Data endpoints expose information and perform an action for a model. All Configuration Run-Time Data REST APIs follow a required product hierarchy starting with the product family then product line followed by the model. A variable name for the product entity is required. For example, /config{prodFamVarName}.{prodLineVarName}.{modelVarName}/ is the standard Configuration Run-Time Data product path for an endpoint URL.

Add Model to Favorites: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cm_favoriteslistinvocationID
Add Multiple Models to a Transaction: Method: post
Path: /rest/v16/config/actions/_bulkAddToTxn
Add Row to Array Set: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_add
Add To Transaction: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_addToTxn
Cancel: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cancel
Configuration Integration: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_integration_integratedCart
Configure a Model: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_configure
Configure Model in System: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_configureInSystem
Delete Row from an Array: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_delete
Drop Cache: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_dropCache
Get All Pick List Options: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_pickLists/actions/getOptions
Get BOM Items: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_bom/actions/getBomItems
Get Mandatory Models: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryModels/actions/getMandatoryModels
Get Mandatory Parts: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryParts/actions/getMandatoryParts
Get Price Books: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_priceBooks/actions/getPriceBooks
Get Recommended Models: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdModels/actions/getRecmdModels
Get Recommended Parts: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdParts/actions/getRecmdParts
Interact: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_interact
Load Array Set Data: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_loadData
Load Configuration Data: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_loadData
Next Configuration Node: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_next
Previous Configuration Node: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_previous
Process Invocation Action: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cm_invocationID
Reconfigure from Favorites: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureFav
Reconfigure Model: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureTxn
Reconfigure Model from Partner: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureClient
Resume Configuration: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_resumeConfig
Save Reconfiguration: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_save
Start Over: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_startOver
Update: Method: post
Path: /rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_update
x Add From Catalog (Not supported after v7): Method: post
Path: /rest/v7/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_addFromCatalog