Skip to main content
Version: 8.9

Type Alias: BatchOperationItemResponse

type BatchOperationItemResponse = object;

Properties​

batchOperationKey​

batchOperationKey: BatchOperationKey;

The key (or operate legacy ID) of the batch operation.

errorMessage​

errorMessage: string | null;

The error message from the engine in case of a failed operation.

itemKey​

itemKey: string;

Key of the item, e.g. a process instance key.

operationType​

operationType: BatchOperationTypeEnum;

processedDate​

processedDate: string | null;

The date this item was processed. This is null if the item has not yet been processed.

processInstanceKey​

processInstanceKey: ProcessInstanceKey;

the process instance key of the processed item.

rootProcessInstanceKey​

rootProcessInstanceKey: ProcessInstanceKey | null;

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

state​

state: "ACTIVE" | "COMPLETED" | "SKIPPED" | "CANCELED" | "FAILED";

State of the item.