External Configurator Integration REST API

External Configurator
Description	This service invokes the External Configurator Advanced Save function.
URI Endpoint	/rest/v17/productFamilies/{pfVarName}/productLines/{plVarName}/models/{modelVarName}/actions/_externalConfigurationSave
Endpoint Parameters	pfVarName	The variable name of the product family
	plVarName	The variable name of the product line
	modelVarName	The variable name of the model
HTTP Method	POST
Success Response	Returns the Transaction ID, document number, status, and a link to the saved transaction
Request Body Parameters	bsId	The Oracle CPQ Transaction ID
		Required for Add from Catalog and Reconfigure
	documentNumber	The document number of a model line
		Required for Reconfigure
	reconfigActionVarName	The Reconfigure Action Variable Name
		Required for Reconfigure
		If this value is not provided, the default "_reconfigure_action" is used
	reconfigSource	The entity to be reconfigured
		Required for Reconfigure
		Valid values: Quote and Line Item; if this value is not provided, Quote is used as the default value
	parameters	Generic string parameters passed to the Save BML "ext_config_url_params" for an external configuration rule.

USE CASE EXAMPLES

Request Body Sample

Response Sample Save Successful

The Transaction ID, document number, and a link to the saved transaction are returned for a successful save.

HTTP status code: 200 OK

{ "status": "save", "bsId": 12345, "documentNumber": 2, "href": "..." }

---

Response Sample Cancel / None

If the Save BML function is canceled, the status returned is "cancel". If the Save BML function is not defined, the status returned is "none".

HTTP status code: 200 OK

{"status": "cancel"}

---

Response Sample Error

When a Save BML function error occurs, the status returned is "error". The response body is a JSON array of the messages returned from the Save BML.

HTTP status code: 500

{ "status": "error", [ { "type": "error", "info": "Failed to launch the configuration session." }, { "type": "warning", "info": "invalid configuration attributes while launching the configuration session." } ] }

---

Response Sample Processing Error

If the error is due to the server-side processing error, the response body is the exception error message.

External configuration is not defined for model myModel belonging to product line myLine under product family myFamily.