Plan Item Suspend Response Event

Plan Item Suspend Response Event is sent by a Process Component as a response to a Plan Item Suspend Request Event. Orchestrator receives the result and interprets the result accordingly.

Event Destination Type Destination Event Type
PlanItemSuspendResponse POST (REST) /v1/planitem/suspendreply Asynchronous/Synchronous event
PlanItemSuspendResponse JMS Queue tibco.aff.orchestrator.planItem.suspend.reply Asynchronous event

The event has the following property:

Property Type Cardinality Description
originator String Optional The value of the originator property in the PlanItemSuspendRequest message, received from the Orchestrator, which must be mapped and sent back in the response message.

The payload specification is as follows:

Plan Item Suspend Response

The following table lists the details of the elements.

Element Type Cardinality Description
businessTransactionID String Optional Unique identifier for tracing purposes across function calls.
correlationID String Optional Unique identifier to correlate the request message with a response message.
resultStatus Type Required Result status type. See Appendix A for the specification of this type.
orderID String Required Internal unique identifier for the order associated with the plan containing the plan item to suspend.
orderRef String Required External unique identifier for the order associated with the plan containing the plan item to suspend.
planID String Required Internal unique identifier for the plan that contains the plan item to suspend.
planItemID String Required Unique identifier for the plan item within the plan to be suspended.
completed Boolean Required Flag indicating if the Process Component suspend completed processing.
success Boolean Required Flag indicating if the Process Component suspend completed successfully.

If any of the flag completed or success is false in PlanItemSuspendResponse, then the process component suspension gets failed and you have to resubmit the PlanItemSuspendResponse.