Set Plan

Method: HTTP POST method

Endpoint: http://<host_address>:<port_address>/v1/plan

Parameters
Name Type Value
businessTransactionID (optional) string (query) businessTransactionID
CorrectionID (optional) string (query) CorrectionID
notificationType Boolean (query) true or false
orderId (optional) string (query) orderid
planID (optional) string (query) planID
replaceInHeader (optional) Boolean (query) true or false
setPlanRequest (mandatory) body request values

Example of setPlanRequest value:

{
  "businessTransactionID": "string",
  "plan": {
    "orderID": "string",
    "orderRef": "string",
    "planID": "string",
    "planItem": [
      {
        "planItemID": "string",
        "planItemName": "string",
        "udf": [
          {
            "evaluationPriority": "string",
            "flavor": "string",
            "name": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ],
    "udf": [
      {
        "evaluationPriority": "string",
        "flavor": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  },
  "replace": {}
}