Get Plan Request

The request specification is as follows:

Queue or Topic

Queue

Destination

tibco.aff.tds.plan.read.request

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

Element

Type

Cardinality

Description

_nm_ String Required The interface identifier name; must be set as GetPlanRequestEvent.

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, only returns the IDs of elements rather than all plan data. If false, returns all plan data.

includeItems

Boolean

Required

If true returns all plan items with the plan. If false, only the plan details are returned.

originator String Optional The component which has originated this call. For example, the name of the process component PC_BUNDLE_PROVIDE.
MATCHING_PI_UDF_NAME_VAL String Optional The value of this field is in the format: UDF name=UDF value. When this value is set, the output is a plan with the plan items which have the matching UDF name and value as specified in the header value together with all the UDFs for the corresponding matched plan items.

If the format for this UDF is not in the form UDF name=UDF value, an error is returned.

ALL_PI_SINGLE_UDF_NAME String Optional

The value of this is a UDF name. The output is a plan with all the plan items and the plan items have only the UDF specified in the header if present.

If both MATCHING_PI_UDF_NAME_VAL and ALL_PI_SINGLE_UDF_NAME are present in the request, an error is returned.

ALL_PI_SINGLE_UDF_NAME_IGNORE_

EMPTY_PI

Boolean Optional This is intended to be used in conjunction with ALL_PI_SINGLE_UDF_NAME. The default value of false indicates that all plan items are present in the response even if they do not have a UDF matching the UDF specified in ALL_PI_SINGLE_UDF_NAME. A true value indicates that plan items with no matching UDF are removed from the response.

No body (payload) is associated with the request message.