Operation: Delete | X4Documentation

With the Delete operation of the Data Object Persistence adapter, you change the retentionTime of a data object.

For more information on the retentionTime of data objects, see Defining Data Objects .

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

Parameters

Note:

The xPath parameter is not relevant for this operation.

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

✳️

This parameter is required.

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

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

The adapter does not expect specific input for this operation.

The adapter changes the retentionTime as specified, but does not issue any specific output.