Modify list

See also: List item

Event action – Abstract

Purpose: Modifies an existing list by adding or removing an entry or clearing the list.

images/download/attachments/189461968/image-2025-1-28_15-0-12-version-1-modificationdate-1738072811674-api-v2.png

The Modify list event action optionally carries out one of the supported modifications (‘Add’, ‘Remove’, ‘Empty’) to an existing list:

Operation

Effect

Modify list / Add

►NOTE◄ In many applications, adding entries to a list can be implemented more efficiently by assigning a value (e.g. via Set value) to a suitably parameterised List item resolver.

An entry (value configuration on the right) is added to the list (value configuration on the left).

images/download/attachments/189461968/image-2025-2-3_9-58-18-version-1-modificationdate-1738573097665-api-v2.png


Modify list / Remove

An existing entry (value configuration on the right) is removed from the list (value configuration on the left).

images/download/attachments/189461968/image-2025-2-3_10-0-15-version-1-modificationdate-1738573214799-api-v2.png

Modify list / Clear

All entries are removed from the list (only value configurations).

images/download/attachments/189461968/image-2025-2-3_10-1-18-version-1-modificationdate-1738573278116-api-v2.png

Configuration

After adding a new instance of the Modify list event action to a workflow, the Add operation is selected by default.

Clicking on the symbol (here: [+]) opens a context menu offering all operations for selection.

Depending on the operation selected, either only one value configuration appears for the definition of the list to be modified or a second value configuration (on the right) for the definition of the entry to be added or deleted.

images/download/attachments/189461968/image-2025-2-3_10-6-39-version-1-modificationdate-1738573598792-api-v2.png

►NOTE◄ A reference object present in the context of the event action can be used in all contained value configurations (for the list or, if applicable, the entry) as an input value for suitable value resolvers.

►IMPORTANT◄ Modifications to a list only take effect if the value configuration for the list can be 'updated'. Otherwise, the modifications will run through without an error message, but will only affect the data status provided as a “snapshot” by the value resolver and not the object to which it goes back.

Specific configuration options for each operation are demonstrated on the following pages: