Get Plan Response

The response contains a UDF, namely 'PLAN_DESCRIPTION' under the Plan element which gives the plan description to the process components. This value comes from the order description provided during order submission process. If the order description is not provided, a default plan description 'Plan For' <order ref> is returned in the PLAN_DESCRIPTION UDF field.

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

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

correlationID

String

Optional

The 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

The flag indicating if the call was successful.

messageCode

String

Required

The result message code.

message

String

Required

Th result message.

planID

String

Required

The internal unique identifier for the plan specified in the request.

found

Boolean

Required

The flag indicating if the plan was found.

The response message contains the XML payload according to the following schema:

Get Plan Response

Get Plan Response

The following table lists the details of the elements.

Element Type Cardinality Description
businessTransactionID String Optional The unique identifier for tracing purposes across function calls.
resultStatus Type Required The result status type. See Appendix A for the specification of this type.
plan Type Optional The plan type. If the plan is not found, this is omitted.
plan/planID String Required The internal unique identifier for the plan.
plan/orderID String Required The internal unique identifier for the order for the plan.
plan/orderRef String Required External unique identifier for the order for the plan.
plan/udf Type 0-M UDF type.
plan/udf/type String Optional Type of the user defined field.
plan/udf/flavour String Optional Flavour of the UDF. The valid values are one of the following three:
  • config - For UDF corresponding to a characteristic in the product model or a system UDF generated by AOPD.
  • input - For UDF passed in the order.
  • output - For UDF set by the process component.
plan/udf/name String Required Field name.
plan/udf/value String Optional Field value.
plan/udf/originalValue String Optional Original field value at time of plan creation.
plan/udf/lastModified DateTime Optional Timestamp when the UDF was last modified.
plan/planItem Type 0-M Plan item type.
plan/planItem/planItemID String Required Internal unique identifier for the plan item.
plan/planItem/planItemName String Optional Name of the process component.
plan/planItem/udf Type 0-M UDF type.
plan/planItem/udf/type String Optional Type of the user defined field.
plan/planItem/udf/flavour String Optional Flavour of the UDF. The valid values are one of the following three:
  • config - For UDF corresponding to a characteristic in the product model or a system UDF generated by AOPD.
  • input - For UDF passed in the order.
  • output - For UDF set by the process component.
plan/planItem/udf/name String Required Field name.
plan/planItem/udf/value String Optional Field value.
plan/planItem/udf/originalValue String Optional Original field value at time of plan creation.
plan/planItem/udf/lastModified DateTime Optional Timestamp when the UDF was last modified.
plan/planItem/parentID String 0-M

IDs of the plan items which depend on the current plan item.

plan/planItem/childID String 0-M IDs of the plan items on which the current plan item depends.
plan/planItem/siblingID String 0-M IDs of the plan items corresponding to SIBLING_PRODUCT_* of the product fulfilled by current plan item.
plan/planItem/dependentID String 0-M IDs of the plan items corresponding to DEPENDENT_PRODUCT_* of the product fulfilled by current plan item.
plan/status String Required Status of the plan from a data perspective: active or complete.
plan/planDescription String Optional Plan description.