API - Strategy Deployment

Description

These APIs are used to perform CRUD operations on the Strategy Deployment.

Get Deployment State

GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}/deployment?deployAction=getDeploymentState

Output

Table 1. Response Codes
Success	200	Ok
Error	400	Inputs provided for the API are not valid.
Server Error	500	Internal Server Error. For more details, check the logs.

Body Parameter – Content-Type:application/json

{
    "campaignId": 0,
    "deployAction": "",
    "state": 0,
    "deployedState": 0,
    "dirty": false,
    "lastProdDepTime": 0,
    "lastMarkTime": 0,
    "deploymentStatusText": "",
    "deploymentWaitMessage": ""
}

Mark for Deployment Or Un-Deployment

PUT /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}/deployment

Input

Body Parameter – Content-Type:application/json

{
     "campaignId": 0,
     "deployAction" : ""
}

Output

Table 2. Response Codes
Success	202	Accepted
Error	400	Bad Request
Server Error	500	Internal/Server Error

Body Parameter – Content-Type:application/json

{
    "campaignId": 0,
    "deployAction": "",
    "state": 0,
    "deployedState": 0,
    "dirty": false,
    "lastProdDepTime": 0,
    "lastMarkTime": 0,
    "deploymentStatusText": "",
    "deploymentWaitMessage": ""
}

Cancel Mark for Deployment Or Un-Deployment

DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/strategies/{strategyIdOrName}/deployment

Input

Body Parameter – Content-Type:application/json

{
     "campaignId": 0,
     "deployAction" : ""
}

Output

Table 3. Response Codes
Success	204	No Content
Error	400	Bad Request
Server Error	500	Internal/Server Error