Get Plan Items Request

The request specification is as follows:

Queue or Topic	Queue
Destination	`tibco.aff.tds.plan.read.request`

Request Endpoint: /v1/planitems/get

The following properties must be passed in the request message header:

Element	Type	Cardinality	Description
_nm_	String	Required	The interface identifier name; must be set as GetPlanItemsRequestEvent.
businessTransactionID	String	Optional	The unique identifier for tracing purposes across function calls.
planID	String	Required	The internal unique identifier for the plan to retrieve.
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.
requestReply	Boolean	Required	If set to `true`: The response is sent on the temporary queue by default or on the destination set as JMSReplyTo property in the request message. If set to `false`: The response is sent on `tibco.aff.tds.plan.reply` queue.
idsOnly	Boolean	Required	If `true`, returns the IDs of elements rather than all plan data. If `false`, returns all plan data.
originator	String	Optional	The component, which has originated this call. For example, the name of the process component PC_BUNDLE_PROVIDE.
INCLUDE_RELATED_PLANITEMS	Boolean	Optional	The value of this header is `true` or `false`, and the absence of this header denotes a `false` value. When this header is set in the request, the output ID all the plan items, which belong to the same order line as the input plan item. When this header is set in the request, only a single plan item can be present in the getPlanItem request. If multiple plan items are present in the request, an error is returned.

The request message body must contain the XML payload as per the following schema:

Get Plan Items Request

The following table lists the details of the getPlanItemsRequest elements.

Element	Type	Cardinality	Description
businessTransactionID	String	Optional	Unique identifier for tracing purposes across function calls.
planID	String	Required	Internal unique identifier for the plan to retrieve.
idsOnly	String	Optional	If true only returns the IDs of elements rather than all plan data. Otherwise, if false returns all plan data.
udfFlavour	String	Optional	Currently not implemented.
udfMatch	String	Optional	Currently not implemented.
planItem	Type	0-M	Plan item type.
planItem/planItemID	String	Required	Internal unique identifier for the plan item to retrieve.
planItem/planItemName	String	Optional	Not Applicable.
planItem/udf	Type	0-M	Not Applicable.
parentID	String	0-M	Not Applicable.
childID	String	0-M	Not Applicable.
siblingID	String	0-M	Not Applicable.
dependentID	String	0-M	Not Applicable.