Set Plan Item Request
The request specification is as follows:
Request EndPoint: /v1/planitems
The following properties must be passed in the request message header:
|
Element |
Type |
Cardinality |
Description |
| _nm_ | String | Required | Interface identifier name; MUST be set as SetPlanItemRequestEvent. |
|
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. |
|
requestReply |
Boolean |
Required |
If set to true:
The response is sent on the temporary queue by default or on the destination set as JMSReplyTo property in the request message. If set to false:The response is sent on tibco.aff.tds.plan.reply queue. |
|
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 EnableUniqueUDFNames is set to true in Order Management Server configurations. In case of multiple User Defined Fields with the same name and flavor in the request, the value from the last encountered user-defined field is considered. |
|
planItemID |
String |
Required |
Internal unique identifier for the plan item to update. |
| originator | String | Optional | The component, which has originated this call. E.g. the name of the process component PC_BUNDLE_PROVIDE. |
The request message body must contain the XML payload as per the following schema:
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/flavour | 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. |