Upgrading or Downgrading a Promotion

When you use the Siebel REST API to upgrade or downgrade a promotion, the Siebel application upgrades or downgrades an existing promotion asset to the selected target promotion. If the existing promotion's components are part of the target promotion definition, then they are transferred to the target promotion. The other mandatory components of the target promotion are then added. Any components in the existing promotion asset that cannot be moved to the target promotion are either disconnected or retained, depending on the value of the Component Prompt Action in the input. The result of this API is a Quote or an Order.

The following request upgrades or downgrades a promotion asset:

URI: http://ServerName:port/siebel/v1.0/service/Workflow Process Manager/RunProcess
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request body:

 	{
	"body": {
		"ProcessName": "ISS Promotion WS - In Memory Upgrade Process-Order",
		"Account Id": "88-1VYRV7",
		"Asset Integration Id": "188-1VYRW1",
		"Operation Id": "88-231PR",
		"PricingMode": "Y",
		"CheckEligibility": "Y",
		"Sync": "Y",
		"AssetPromptAction": {
			"IntObjectFormat": "Siebel Hierarchical",
			"MessageId": "1234",
			"IntObjectName": "ISS Promotion Component Prompt Action",
			"MessageType": "Integration Object",
			"ListOfISS Promotion Component Prompt Action": {
				"Asset": {
					"Asset Integration Id": "88-1VYRWA",
					"Component Prompt Action": "Disconnect"
				}
			}
		}
	}
}

For a description of the request message associated with this API, see the following table.

Name	Description
Process Name	One of the following processes is required: ISS Promotion WS - In Memory Upgrade Process-Order ISS Promotion WS - In Memory Upgrade Process-Quote
Asset Integration Id	Required. Integration ID of the promotion asset you want to upgrade.
Account Id	Required. Account ID associated with the asset.
Operation Id	Required. Unique ID for upgrade path, this is the returned Operation Id from GetPromotionUpgradePaths REST API.
New Promotion Id	Required. Row ID of the target promotion.
AssetPromptAction:Asset:Asset Integration Id	Required for prompt components. Integration ID of the Promotion component with the Prompt Action code.
AssetPromptAction:Asset:Component Prompt Action	Required for prompt components. Disconnect or Modify. If the value is Disconnect, then the asset is disconnected. If the value is Modify, then the asset is continued.
PricingMode	Optional. The default value is Y. Call the Pricer on the targeted document if the flag is Y or if this flag is not specified.
CheckEligibility	Optional. The default value is Y. Applies the Eligibility and Compatibility rules on the line items if the flag is Y or if this flag is not specified.
Sync	Optional. The default value is Y. The upgraded document will be synced to the database if the flag is Y or if this flag is not specified.

Here are the response details for a successful request:

HTTP Code: 200
Content-Type: application/json

Response body:

    	           
{
	"Error Code": "",
	"Siebel Operation Object Id": "88-231PR",
	"Account Id": "88-1VYRV7",
	"Asset Integration Id": "88-1VYRW1",
	"New Promotion Id": "88-231OB",
	"Sync": "Y",
	"PricingMode": "Y",e
	“CheckEligibility": "Y",
	"SiebelMessage": {
		"IntObjectFormat": "Siebel Hierarchical",
		"MessageId": "88-24PPB",
		"IntObjectName": "PDS Order",
		"MessageType": "Integration Object",
		"Header": {
			"Account Id": "88-1VYRV7",
			"Id": "88-1W2KLG",
			"Order Number": "296-114333809",
			"Order Type": "Sales Order",
			"Line Item": [
				{
					"Asset Integration Id": "88-1VYRWA",
					"Action Code": "Update",
					"Product Type Code": "Product",
					"Id": "88-1W2KLJ",
					"Name": "ND_SP1",
					"XA": [
						{
							"Display Name": "Color",
							"XA Id": "88-1V6BGF",
							"Id": "88-1W2KLK",
							"Action Code": "-"
						}
					]
				},
				{
					"Asset Integration Id": "88-1VYRW1",
					"Action Code": "Delete",
					"Product Type Code": "Promotion",
					"Id": "88-1W2KLZ",
					"Name": "Millennium Max 200 Package"
				}
			]
		}
	}
}