Get Plan Request
The following properties must be passed in the request message header:
Request Endpoint: /v1/plan
|
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, only returns the IDs of elements rather than all plan data. If false, returns all plan data. |
|
includeItems |
Boolean |
Optional |
If true returns all plan items with the plan. If false, only the plan details are returned. |
| 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 user-defined field name and value as specified in the header value together with all the User Defined Fields for the corresponding matched plan items. If the format for this user-defined field 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 user-defined field name. The output is a plan with all the plan items and the plan items have only the user-defined field 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 user-defined field matching the user-defined field specified in ALL_PI_SINGLE_UDF_NAME. A true value indicates that plan items with no matching User Defined Fields are removed from the response. |
| OrderID | String | Required | The internal unique identifier for the order |