Get Plan Items Response

The response specification is as follows:

Queue or Topic

Queue

Destination

temp queue or JMSReplyTo destination or tibco.aff.tds.plan.reply queue

The response message contains the following header properties:

Element

Type

Cardinality

Description

businessTransactionID

String

Optional

Unique identifier for tracing purposes across function calls. This is used for logging.

correlationID

String

Optional

Unique identifier for tracing purposes across a single function call. This is generally used by the calling application to correlate requests and responses.

Success

Boolean

Required

Flag indicating if the call was successful.

messageCode

String

Required

Result message code.

Message

String

Required

Result message.

planID

String

Required

Internal unique identifier for the plan specified in the request.

Found

Boolean

Required

Flag indicating if the plan was found.

The response message contains the XML payload as per the following schema:

Get Plan Items Response

Get Plan Items Response

The following table lists the details of the response elements.

Element Type Cardinality Description
businessTransactionID String See Image Unique identifier for tracing purposes across function calls.
resultStatus Type See Image Result status type. See Appendix A for the specification of this type.
planItem Type 0-M Plan item type.
planItem/planItemID String Required Internal unique identifier for the plan item.
planItem/planItemName String Optional Name of the process component.
planItem/udf Type 0-M user-defined field type.
planItem/udf/type String Optional Type of the user defined field.
planItem/udf/flavour String Optional Flavor of the user-defined field. The valid values are one of the following three:
  • config - For user-defined field corresponding to a characteristic in the product model or a system user-defined field generated by Automated Order Plan Development.
  • input - For user-defined field passed in the order.
  • output - For user-defined field set by the process component.
planItem/udf/name String Required Field name.
planItem/udf/value String Optional Field value.
planItem/udf/originalValue String Optional Original field value at the time of plan creation.
planItem/udf/lastModified DateTime Optional Timestamp when the user-defined field was last modified.
planItem/parentID String 0-M IDs of the plan items, which depends on the current plan item.
planItem/childID String 0-M IDs of the plan items on which the current plan item depends.
planItem/siblingID String 0-M IDs of the plan items corresponding to SIBLING_PRODUCT_* of the product fulfilled by current plan item.
planItem/dependentID String 0-M IDs of the plan items corresponding to DEPENDENT_PRODUCT_* of the product fulfilled by current plan item.