Collaborative Quote Queue REST APIs

Overview

The Collaborative Quote Queue REST APIs allow administrators to manage the collaborative quote queue.

Clear Current Collaborative Quote Queue
Description	Use this endpoint to clear the collaborative operation queue for the specified transaction. This will cancel every operation that is executing or queued at the time that the request is processed.
URI Endpoint	/rest/v17/collabOperationQueues/{bsId}/actions/clearCurrentQueue
Endpoint Parameters	bsId	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	POST
Request Body Parameters	None
Success Response	204 Not Content
Error Responses	400	Collaborative quote editing is not enabled for process
	403	User with restricted access (Sales agent etc)
	404	Invalid bsId provided in the endpoint

Get Collaborative Quote Queue
Description	Use this endpoint to retrieve queued tasks for the specified transaction.
URI Endpoint	/rest/v17/collabOperationQueues/{bsId}
Endpoint Parameters	bsId	The commerce transaction Id. This is the unique identifier for a transaction within an Oracle CPQ site.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	currentlyExecutingOperation	Operation which is currently executing. Omitted if the next queued operation has not started executing yet.
	node	Name of the node that is currently responsible for executing all operations for the bsId.
	operationCount	The total number of incomplete operations, including executing and queued operations.
	queuedOperations	Operations which are queued and have not started execution. The order of the items in the array is the order in which they will execute.
Error Responses	400	Collaborative quote editing is not enabled for process
	403	User with restricted access (Sales agent etc)
	404	Invalid bsId provided in the endpoint