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