API - FlexOffers Deployment

Description

These APIs are used to perform CRUD operations on the FlexOffers for deployment.

Mark for deployment or undeployment

PUT/channels/{icIdOrName}/offermappings/{offerMappingId}/deployment

Input

Request Body Parameter – Content-Type: application/json

To mark for deployment

{
	"deployAction": "markDeploy"
}

To mark for undeployment

{
	"deployAction": "markUndeploy"
}

Sample response

{
    "deployAction": "markDeploy",
    "state": 2,
    "deployedState": 11,
    "dirty": true,
    "lastProdDepTime": 1578016269626,
    "lastMarkTime": 1586258988734,
    "deploymentStatusText": "Last production deployment 01/03/2020 07:21:09.",
    "deploymentWaitMessage": "Waiting to be deployed since 04/07/2020 16:59:48, and locked against edits."
}

Output

Table 1. Response Codes
Accepted	202	Accepted
Error	400	Bad Request
Server Error	500	Internal Server Error

Cancel deployment/undeployment for FlexOffers

DELETE

DELETE /channels/{icIdOrName}/offermappings/{offerMappingId}/deployment

Input

Request Body Parameter – Content-Type: application/json

To cancel mark for deployment

{
	"cancelDeploy": "markDeploy"
}

To cancel mark for undeployment

{
	"cancelDeploy": "markUndeploy"
}

Sample response

{
    "cancelDeploy": "markDeploy",
    "state": 2,
    "deployedState": 11,
    "dirty": true,
    "lastProdDepTime": 1578016269626,
    "lastMarkTime": 1586258988734,
    "deploymentStatusText": "Last production deployment 01/03/2020 07:21:09.",
    "deploymentWaitMessage": "Waiting to be deployed since 04/07/2020 16:59:48, and locked against edits."
}

Output

Table 2. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	Internal Server Error

Get depolyment state for FlexOffers

GET

GET /channels/{icIdOrName}/offermappings/{offerMappingId}/deployment

Output

Table 3. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	nputs provided for the API are not valid

Sample responses

{
    "deployAction": "getDeploymentState",
    "state": 0,
    "deployedState": 10,
    "dirty": false,
    "lastProdDepTime": null,
    "lastMarkTime": null,
    "deploymentStatusText": "Not yet deployed",
    "deploymentWaitMessage": null
}

{
    "deployAction": "markDeploy",
    "state": 2,
    "deployedState": 11,
    "dirty": true,
    "lastProdDepTime": 1578016269626,
    "lastMarkTime": 1586258988734,
    "deploymentStatusText": "Last production deployment 01/03/2020 07:21:09.",
    "deploymentWaitMessage": "Waiting to be deployed since 04/07/2020 16:59:48, and locked against edits."
}

deployedState

NOT_YET_DEPLOYED: 10
DEPLOYED: 11
UN_DEPLOYED: 12

State

READY_FOR_DEPLOYMENT: 0
READY_FOR_UN_DEPLOYMENT: 1
MARK_FOR_DEPLOYMENT: 2
MARK_FOR_UN_DEPLOYMENT: 3