Get Plan Items Request
Request Endpoint: /v1/planitems/get
The following properties must be passed in the request message header:
Element |
Type |
Cardinality |
Description |
---|---|---|---|
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. |
idsOnly |
Boolean |
Optional |
If
|
includeRelatedPlanItems | Boolean | Optional |
The value of this header is
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 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. |
planItem | Type | 0-M | Plan item type. |
planItem/planItemID | String | Required | Internal unique identifier for the plan item to retrieve. |