Set Plan Item Request
Request EndPoint: /v1/planitems
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. |
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 earlier mentioned cases, 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 the same 'name' and 'flavor' do not get duplicated, if the flag
|
orderID | string | Required | Internal unique identifier for the plan.
Note: The value of orderId must not contain " : "
|
planItemID |
String |
Required |
Internal unique identifier for the plan item to be updated. |
The following table lists the details of the 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 update. |
planItem | Type | Required | Plan item type. Only user-defined field Name and Value are updated. If the Unique User Defined Fields are enabled for the engine an update occurs if disabled the entire current user-defined field payload is dropped and replaced with the new payload. |
planItem/planItemID | String | Required | Internal unique identifier for the plan item to update. |
planItem/planItemName | String | Optional | Process component name. |
planItem/udf | Type | 0-M | user-defined field type. |
planItem/udf/type | String | Optional | Type of the user defined field. |
planItem/udf/flavor | String | Optional | Flavor of the user-defined field. Must be set as output. |
planItem/udf/name | String | Required | Field name. |
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. |