Get Plan

This operation gives the udf-level plan details.

Method: HTTP GET method

Endpoint: http://<host_address>:<port_address>/v1/plan

Parameters
Name Type Value
ALL_PI_SINGLE_UDF_NAME (optional) string (query) ALL_PI_SINGLE_UDF_NAME
ALL_PI_SINGLE_UDF_NAME_IGNORE_EMPTY_PI (optional) Boolean (query) true or false
MATCHING_PI_UDF_NAME_VAL (optional) string (query) ALL_PI_SINGLE_UDF_NAME_IGNORE_EMPTY_PI
businessTransactionID (optional) string (query) businessTransactionID
CorrectionID (optional) string (query) CorrectionID
idsOnly (optional) Boolean (query) true or false
includeItems (optional) Boolean (query) true or false
orderId (mandatory) string (query) orderid
Note: The value of orderId must not contain ":"
orderRef (optional) string (query) orderRef
Note: You must enter the orderRef value for the older orders where the orderRef was unique and there was no orderId. For the new orders, both the orderId and orderRef are the same, you can enter either one.
Note: The value of orderRef must not contain ":"
planID (mandatory) string (query) planID