Configuration BOM Instance
Overview
Beginning in 2017 R1, the configBomInstance resource is available for performing standard REST operations. When using an external client application for order capture and a user chooses to customize a product, the external client application opens the Oracle CPQ Model Configuration page in an embedded iFrame. Once the user customizes the product, the configBomInstance and a unique identifier (i.e. configId) is returned back to the external client application. The configBomInstance is stored in the configBomInstance resource, so the correct BOM instance can be determined while processing asset based operation requests.
Resource Attribute |
Description |
---|---|
Configuration Id |
The configuration Identifier that uniquely identifies the configuration BOM instance. The Configuration ID (i.e. "configId") is for the client-side integration action and is not the same as the Commerce system attribute (i.e. _configuration_id) introduced in Oracle CPQ 2017 R1. For UI integrations, the client-side integration action returns the "configid" in response JSON. For other actions such as Terminate, Renew, Suspend, and Resume order, RESTful calls generated from the saveconfigbom BML function return the lineId. |
BOM Instance |
An invariant key that uniquely identifies the root component of the BOM. |
Configuration BOM Instance |
The Configuration BOM Instance data. |
Fulfillment Status |
Fulfillment Status of the configuration BOM instance. This attribute can also be updated. |
Action Code |
Indicates the change required for this root config instance. For example - TERMINATE, SUSPEND, RESUME, RENEW. |
Source Identifier |
The variable name of the commerce process or external application identifier. |
Transaction Date |
The date and time on which the service request was made. This attribute can also be updated. |
Transaction Id |
The current transaction identifier. This attribute can also be updated. |