Operation: Update | X4Documentation

With the Update operation of the Data Object Persistence adapter, you update individual elements of a data object.

For more information on other operations of the Data Object Persistence adapter, see Data Object Persistence Adapter.

Parameters

caseId

✳️

This parameter is required.

ID of the process instance of the Business Process in which the data structure of the data objects is defined.

Possible values:

UUID of the process or %CASE_ID% system parameter

retentionTime

Time after which expired data objects are deleted (specified in days).

Note:

If you do not specify this parameter, the default value of 90 days is used.

Possible values:

Number in days, e.g. 100

xPath

✳️

This parameter is required for this operation.

Specifies the location of the elements to be updated in the data object.

Possible values:

Any valid string, e.g. Order/Content/Item

Status values

`1`	The operation was executed successfully.
`-1`	The operation failed due to a technical error.

Input

The adapter expects an XML document containing the data to be updated, e.g.:

<?xml version="1.0" encoding="UTF-8"?>
<Item>
	<ItemID>54782</ItemID>
	<ProductName>MyProduct</ProductName>
	<Quantity>5</Quantity>
	<UnitPrice>49,99</UnitPrice>
</Item>

Note:

If you do not specify new values in parameters during the Update operation, the existing values of the data object are used.

Output

The adapter outputs the updated data object as an XML document.