Synchronous Plan Generation Interface

Operation generatePlan

Method: HTTP POST

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

Example:

{
  "orderRef": "string",
  "orderID": "string",
  "header": {
    "description": "string",
    "orderPriority": 9,
    "invoiceAddress": {
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "locality": "string",
      "region": "string",
      "country": "string",
      "postCode": "string",
      "supplementaryLocation": "string"
    },
    "deliveryAddress": {
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "locality": "string",
      "region": "string",
      "country": "string",
      "postCode": "string",
      "supplementaryLocation": "string"
    },
    "notes": "string",
    "slaID": [
      "string"
    ],
    "udf": [
      {
        "name": "string",
        "value": "string",
        "extension": {
          "any": [
            "string"
          ]
        }
      }
    ],
    "extension": {
      "any": [
        "string"
      ]
    },
    "customerID": "string",
    "subscriberID": "string",
    "requiredByDate": "2023-02-06T04:40:55.860Z",
    "requiredOnDate": "2023-02-06T04:40:55.860Z"
  },
  "line": [
    {
      "lineNumber": "string",
      "subscriberID": "string",
      "productID": "string",
      "productVersion": "string",
      "quantity": 0,
      "uom": "string",
      "deliveryAddress": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "locality": "string",
        "region": "string",
        "country": "string",
        "postCode": "string",
        "supplementaryLocation": "string"
      },
      "action": "string",
      "actionMode": "string",
      "linkID": "string",
      "inventoryID": "string",
      "notes": "string",
      "slaID": [
        "string"
      ],
      "udf": [
        {
          "name": "string",
          "value": "string",
          "extension": {
            "any": [
              "string"
            ]
          }
        }
      ],
      "characteristic": [
        {
          "name": "string",
          "description": "string",
          "value": [
            {
              "name": "string",
              "type": "string",
              "value": "string",
              "valueFrom": "string",
              "valueTo": "string",
              "extension": {
                "any": [
                  "string"
                ]
              }
            }
          ],
          "extension": {
            "any": [
              "string"
            ]
          }
        }
      ],
      "customerItemID": "string",
      "extension": {
        "any": [
          "string"
        ]
      },
      "requiredByDate": "2023-02-06T04:40:55.860Z",
      "requiredOnDate": "2023-02-06T04:40:55.860Z"
    }
  ],
  "extension": {
    "any": [
      "string"
    ]
  }
}

Operation generatePartialPlan

Method: HTTP POST

Endpoint: http://<host_address>:<port_address>/plan/partial/sync

Example:

{
  "planGenerationPhase": "VALIDATION",
  "orderRequest": {
    "orderRef": "string",
    "orderID": "string",
    "header": {
      "description": "string",
      "orderPriority": 9,
      "invoiceAddress": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "locality": "string",
        "region": "string",
        "country": "string",
        "postCode": "string",
        "supplementaryLocation": "string"
      },
      "deliveryAddress": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "locality": "string",
        "region": "string",
        "country": "string",
        "postCode": "string",
        "supplementaryLocation": "string"
      },
      "notes": "string",
      "slaID": [
        "string"
      ],
      "udf": [
        {
          "name": "string",
          "value": "string",
          "extension": {
            "any": [
              "string"
            ]
          }
        }
      ],
      "extension": {
        "any": [
          "string"
        ]
      },
      "customerID": "string",
      "subscriberID": "string",
      "requiredByDate": "2023-02-06T04:41:32.048Z",
      "requiredOnDate": "2023-02-06T04:41:32.048Z"
    },
    "line": [
      {
        "lineNumber": "string",
        "subscriberID": "string",
        "productID": "string",
        "productVersion": "string",
        "quantity": 0,
        "uom": "string",
        "deliveryAddress": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "locality": "string",
          "region": "string",
          "country": "string",
          "postCode": "string",
          "supplementaryLocation": "string"
        },
        "action": "string",
        "actionMode": "string",
        "linkID": "string",
        "inventoryID": "string",
        "notes": "string",
        "slaID": [
          "string"
        ],
        "udf": [
          {
            "name": "string",
            "value": "string",
            "extension": {
              "any": [
                "string"
              ]
            }
          }
        ],
        "characteristic": [
          {
            "name": "string",
            "description": "string",
            "value": [
              {
                "name": "string",
                "type": "string",
                "value": "string",
                "valueFrom": "string",
                "valueTo": "string",
                "extension": {
                  "any": [
                    "string"
                  ]
                }
              }
            ],
            "extension": {
              "any": [
                "string"
              ]
            }
          }
        ],
        "customerItemID": "string",
        "extension": {
          "any": [
            "string"
          ]
        },
        "requiredByDate": "2023-02-06T04:41:32.048Z",
        "requiredOnDate": "2023-02-06T04:41:32.048Z"
      }
    ],
    "extension": {
      "any": [
        "string"
      ]
    }
  },
  "externalBusinessTransactionID": "string"
}

Operation generateAmendOrderPlan

Method: HTTP POST

Endpoint: http://<host_address>:<port_address>/plan/amend/sync

Example:

{
  "orderLineStatus": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "orderRequest": {
    "orderRef": "string",
    "orderID": "string",
    "header": {
      "description": "string",
      "orderPriority": 9,
      "invoiceAddress": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "locality": "string",
        "region": "string",
        "country": "string",
        "postCode": "string",
        "supplementaryLocation": "string"
      },
      "deliveryAddress": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "locality": "string",
        "region": "string",
        "country": "string",
        "postCode": "string",
        "supplementaryLocation": "string"
      },
      "notes": "string",
      "slaID": [
        "string"
      ],
      "udf": [
        {
          "name": "string",
          "value": "string",
          "extension": {
            "any": [
              "string"
            ]
          }
        }
      ],
      "extension": {
        "any": [
          "string"
        ]
      },
      "customerID": "string",
      "subscriberID": "string",
      "requiredByDate": "2023-02-06T04:42:47.661Z",
      "requiredOnDate": "2023-02-06T04:42:47.661Z"
    },
    "line": [
      {
        "lineNumber": "string",
        "subscriberID": "string",
        "productID": "string",
        "productVersion": "string",
        "quantity": 0,
        "uom": "string",
        "deliveryAddress": {
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "locality": "string",
          "region": "string",
          "country": "string",
          "postCode": "string",
          "supplementaryLocation": "string"
        },
        "action": "string",
        "actionMode": "string",
        "linkID": "string",
        "inventoryID": "string",
        "notes": "string",
        "slaID": [
          "string"
        ],
        "udf": [
          {
            "name": "string",
            "value": "string",
            "extension": {
              "any": [
                "string"
              ]
            }
          }
        ],
        "characteristic": [
          {
            "name": "string",
            "description": "string",
            "value": [
              {
                "name": "string",
                "type": "string",
                "value": "string",
                "valueFrom": "string",
                "valueTo": "string",
                "extension": {
                  "any": [
                    "string"
                  ]
                }
              }
            ],
            "extension": {
              "any": [
                "string"
              ]
            }
          }
        ],
        "customerItemID": "string",
        "extension": {
          "any": [
            "string"
          ]
        },
        "requiredByDate": "2023-02-06T04:42:47.661Z",
        "requiredOnDate": "2023-02-06T04:42:47.661Z"
      }
    ],
    "extension": {
      "any": [
        "string"
      ]
    }
  },
  "plan": {
    "planId": "string",
    "orderId": "string",
    "orderRef": "string",
    "originator": "string",
    "planCreationDate": "2023-02-06T04:42:47.661Z",
    "status": "string",
    "statusChanged": "2023-02-06T04:42:47.661Z",
    "description": "string",
    "planStartDate": "2023-02-06T04:42:47.661Z",
    "planStartMillis": 0,
    "isAmendment": true,
    "planItems": [
      {
        "planItemMessages": [
          {
            "planItemId": "string",
            "messageType": "string",
            "messageList": [
              {
                "lineNumber": "string",
                "type": "string",
                "code": "string",
                "description": "string",
                "udfs": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ]
              }
            ]
          }
        ],
        "planItemID": "Unique identifier for the plan item within the        plan.",
        "planItemName": "Identifier for the plan item name(Product        Description) within the plan.",
        "description": "Description for the plan item.",
        "planFragmentUniqueId": "The id of the process component to invoke when        executing the plan item.",
        "parentIds": "Plan Item Ids which are dependent on this plan item",
        "childIds": "Plan Item Ids on which this plan item depends",
        "siblingIds": "Plan Item Ids of sibling products for this plan        item",
        "dependentIds": "Plan Item Ids of dependent products for this plan        item",
        "startTimestamp": 0,
        "endTimestamp": 0,
        "cancelled": true,
        "isNonExecuting": true,
        "isNoReciprocalAction": true,
        "udfs": [
          {
            "evaluationPriority": "string",
            "type": "string",
            "flavor": "string",
            "name": "string",
            "value": "string",
            "originalValue": "string"
          }
        ],
        "planFragment": {
          "planFragmentUniqueId_CANCEL": {
            "name": "string",
            "description": "string"
          },
          "planFragmentUniqueId_PROVIDE": {
            "name": "string",
            "description": "string"
          },
          "planFragmentUniqueId_CEASE": {
            "name": "string",
            "description": "string"
          },
          "planFragmentUniqueId_UPDATE": {
            "name": "string",
            "description": "string"
          }
        },
        "orderLines": "A list of order lines for this plan item.",
        "action": "Action for the plan item.",
        "status": "Status for the plan item.",
        "statusChanged": "2023-02-06T04:42:47.661Z",
        "pcRequestType": "Type of request that was send to the process component.",
        "milestones": [
          {
            "milestoneID": "Unique identifier for this milestone within the        plan item and plan.",
            "description": "Description of the milestone.",
            "ready": false,
            "readyTime": "2023-02-06T04:42:47.661Z",
            "status": "Status for the milestone.",
            "statusChanged": "2023-02-06T04:42:47.661Z",
            "dependencies": [
              {
                "dependencyID": "Unique identifier for this dependency.",
                "type": "Type of dependency.",
                "ready": false,
                "readyTime": "2023-02-06T04:42:47.661Z",
                "status": "Status of the dependency.",
                "statusChanged": "2023-02-06T04:42:47.661Z",
                "timeDelta": 0,
                "external": {
                  "eventName": "Name of the external event that satisfies            this dependency.",
                  "eventId": "Unique identifier of the external event that            satisfies this dependency.",
                  "eventTime": "2023-02-06T04:42:47.661Z"
                },
                "point": {
                  "planItemID": "The plan item Id that uniquely identifies the            plan item that must reach a milestone for this dependency to            be satisfied.",
                  "planID": "The plan Id for the plan item Id that            uniquely identifies the plan item that must reach a milestone            for this dependency to be satisfied. If omitted then the            current plan is assumed.",
                  "milestoneID": "Warning: CHOICE element",
                  "end": "Warning: CHOICE element"
                },
                "time": {
                  "absoluteTime": "2023-02-06T04:42:47.661Z"
                }
              }
            ]
          }
        ]
      }
    ],
    "udves": [
      {
        "evaluationPriority": "string",
        "type": "string",
        "flavor": "string",
        "name": "string",
        "value": "string",
        "originalValue": "string"
      }
    ]
  },
  "amendmentNumber": 0
}