Operation SubmitOrderExecutionPlan
Method: HTTP POST method
Endpoint: http://<host_address>:<port_address>/v1/plan
Example:
{ "planId": "string", "orderId": "string", "orderRef": "string", "originator": "string", "planCreationDate": "2023-02-04T18:16:04.927Z", "status": "string", "statusChanged": "2023-02-04T18:16:04.927Z", "description": "string", "planStartDate": "2023-02-04T18:16:04.927Z", "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": { "acknowledgeMode": "REST, MESSAGING", "planFragmentID": "string", "planFragmentName": "string", "planFragmentVersion": "string", "owner": "string", "record_Type": "string", "errorHandler": "string", "retry": { "retryOverride": true, "retryFailed": true, "retryCount": 0, "retryDelay": 0 }, "section": [ { "startMilestoneID": "string", "endMilestoneID": "string", "typicalDuration": 0, "maximumDuration": 0 } ] }, "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-04T18:16:04.927Z", "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-04T18:16:04.927Z", "status": "Status for the milestone.", "statusChanged": "2023-02-04T18:16:04.927Z", "dependencies": [ { "dependencyID": "Unique identifier for this dependency.", "type": "Type of dependency.", "ready": false, "readyTime": "2023-02-04T18:16:04.927Z", "status": "Status of the dependency.", "statusChanged": "2023-02-04T18:16:04.927Z", "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-04T18:16:04.927Z" }, "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-04T18:16:04.927Z" } } ] } ] } ], "udves": [ { "evaluationPriority": "string", "type": "string", "flavor": "string", "name": "string", "value": "string", "originalValue": "string" } ] }