Set Plan Request
Request Endpoint: /v1/plan
The following properties must be passed in the request message header:
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. |
OrderID |
String |
Required |
Internal unique identifier for the order related to the plan to update. |
correlationID | String | Optional |
Unique identifier for tracing purposes across a single function call. This is generally used by the calling application to correlate requests and responses. |
replace |
Boolean |
Required |
If set to true:
All the existing User Defined Fields is replaced by the User Defined Fields that are present in the request. If set to false:The User Defined Fields passed in the request is merged with the existing User Defined Fields. In any of the above case, the uniqueness of a user-defined field is maintained based on the 'name' and 'flavor' combination in the user-defined field. A user-defined field having exactly same 'name' and 'flavor' is not duplicated, if the flag EnableUniqueUDFNames is set to true in Order Management Server configurations. In case of multiple User Defined Fields with exactly same name and flavor in the request, the value from the last encountered user-defined field is considered. |
The following table lists the details of the elements.
Element | Type | Cardinality | Description |
businessTransactionID | String | Optional | Unique identifier for tracing purposes across function calls. |
Plan | Type | Required | Plan type. |
plan/planID | String | Required | Internal unique identifier for the plan to update. |
plan/orderID | String | Required | Internal unique identifier for the order related to the plan to update. |
plan/orderRef | String | Required | External unique identifier for the order related to the plan to update. |
plan/udf | Type | 0-M | |
plan/udf/type | String | Optional | Type of the user defined field. |
plan/udf/flavour | String | Optional | Flavor of the user-defined field. Must be set as output. |
plan /udf/name | String | Required | Field name. |
plan/udf/value | String | Required | Field value. |
plan/planItem | Type | 0-M | Plan item type. |
plan/planItem/planItemID | String | Required | Internal unique identifier for the plan item to update. |
plan/planItem/planItemName | String | Optional | Process component name. |
plan/planItem/udf | Type | 0-M | user-defined field type. |
plan/planItem/udf/type | String | Optional | Type of the user defined field. |
plan/planItem/udf/flavour | String | Optional | Flavor of the user-defined field. Must be set as output. |
plan/planItem/udf/name | String | Required | Field name. |
plan/planItem/udf/value | String | Required | Field value. |
replace | Any | Optional | If true it completely replaces the plan item, otherwise merges the user-defined field data. |