Configuration Bulk Add to Transaction REST API

Overview

Oracle CPQ exposes Configuration objects and configuration data through REST APIs and RESTful standards.This REST API is used to add several model configurations to a Transaction. With appropriate HTTP Basic authentication, administrators can make use of these service.

Administration

The endpoint for each REST API appends onto https://{siteurl}, where {siteurl} is the base URL of the Oracle CPQ site.

Bulk Add to Transaction

Bulk Add to Transaction
Description	This REST API is used to add several model configurations to a Transaction. The Transaction Id, Document Id, and model configuration items are specified in the request body. The Product Family, Product Line, and Model along with the configdata or punch-in information are defined for each item to be added. Note:Beginning in Oracle CPQ 20C, the `headlessMode` property replaces the `legacyMode` property in v10 Configuration REST APIs. If you explicitly set the `legacyMode` property in your REST calls, you need to remove the `legacyMode` property from v10 REST calls. If the `legacyMode` property is not removed, you will receive an invalid parameter error.
URI Endpoint	/rest/v17/config/actions/_bulkAddToTxn
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	bsId	Buyside Identifier (Required)
	documentId	The unique Identifier of the Main document or Sub Document (Required)
	items	An array of model configurations. The following information is specified for each item:
		prodFamVarName	The variable name of a Product Family
		prodLineVarName	The variable name of a Product Line
		modelVarName	The variable name of a Model
		prodFamVarName	The variable name of a Product Family
		instanceId	Optional identifier for this entry.
		configData	Top-level object in the payload containing the configuration data.
		fromPunchin	This Boolean attribute indicates that the configure is from a punchin.
		ModelPunchin	This object contains configuration parameters, flow inputs and search results.
	headlessMode	This boolean parameter determines the API execution behavior. false, the API honors CPQ legacy Configuration Layout Flow behavior, with the relevant attribute values to be overridden as defined in the current CPQ legacy Configuration Layout Flow. This value will provide the behavior that legacyMode value of 'true' provided in previous versions of the API. The default value is 'false'. true, the API does NOT send UI information or honor CPQ legacy Configuration Layout Flow.
Response Body Parameters	bsId	Buyside Identifier
	processId	The process Identifier
	destimationUrl	The destination URL.

URI Endpoint Sample

Request Body Sample

{ "bsId": 41370275, "documentId": 37056643,
"items": [{ "productFamily": "vision", "productLine": "servers", "model": "serverSolutions", "configData": { "packagedSolutions": { "value": "Sentinel", "displayValue": "Standard" } } }, { "productFamily": "vision", "productLine": "servers", "model": "ultraPowerSolutionPackage", "configData": { "serverCounter": 1, "powerSupply": { "value": "600W PSU", "displayValue": "600W PSU" }, "enclosure": "Vision Blade 6000 Chassis", "howMuchDataDoYouCurrentlyManageAndStore": { "value": "1 TB - 5 TB", "displayValue": "1 TB - 5 TB" }, "ram": { "value": "4 GB RAM", "displayValue": "4 GB RAM" }, "ramConfiguration": { "value": "2 Sticks", "displayValue": "2 Sticks" }, "slimFloppyDrive": false, "serverPerformance": { "value": "Entry Level", "displayValue": "Entry Level" }, "supportLevel": { "value": "Vision Gold", "displayValue": "Vision Gold" }, "oSLicenses": 1, "overrideLowQuantity": false, "howManyEmployeesDoYouHaveNow": { "value": "26 - 100", "displayValue": "26 - 100" }, "applicationSoftwareCounter": 4, "blades_quantity": 1, "numberOfProcessors": { "value": 2, "displayValue": "2" } } } ] }

Response Body Sample

Configuration Bulk Add to Transaction REST API

Overview

Administration

Related Topics