REST API Services for CPQ Cloud

Add To Transaction

post

/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_addToTxn

This action is used for adding the current state of latest configuration data to the Transaction. This is typically used in conjunction with the Add from Catalog API of Commerce Transaction or Transaction line.

Request

Supported Media Types

application/json

Root Schema : prodFamVarName.prodLineVarName.modelVarName-_addToTxnRequest

Type: object

Show Source

cacheInstanceId: string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Root Schema : prodFamVarName.prodLineVarName.modelVarName-_addToTxnResponse

Type: object

Show Source

bsId(optional): integer

Title: Buyside Identifier

Buyside Identifier
destinationUrl(optional): string

Title: Destination URL

The source identified by the action that launched the Configuration or Transaction.
processId(optional): integer

Title: Process Id

Process identifier.

{
    "type":"object",
    "properties":{
        "bsId":{
            "type":"integer",
            "description":"Buyside Identifier",
            "title":"Buyside Identifier"
        },
        "processId":{
            "type":"integer",
            "description":"Process identifier.",
            "title":"Process Id"
        },
        "destinationUrl":{
            "type":"string",
            "description":"The source identified by the action that launched the Configuration or Transaction.",
            "title":"Destination URL"
        }
    }
}

Examples

The following example shows how to add the current state of latest configuration data to the Transaction by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/actions/_addToTxn

Request Body Sample

{
  "cacheInstanceId": "DJy4zFjQqMgkfCXYAD9OgKf3Teyqcnvi3QtQ1nJICFjs2MsvNWecrsHJYw7sLKul"
}

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
  "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp",
  "bsId": 36738986,
  "processId": 36244034
}