For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.9

Type Alias: BatchOperationResponse

type BatchOperationResponse = object;

Properties​

actorId​

actorId: string | null;

The ID of the actor who performed the operation. Available for batch operations created since 8.9.

actorType​

actorType: AuditLogActorTypeEnum | null;

The type of the actor who performed the operation. This is null if the batch operation was created before 8.9, or if the actor information is not available.

batchOperationKey​

batchOperationKey: BatchOperationKey;

Key or (Operate Legacy ID = UUID) of the batch operation.

batchOperationType​

batchOperationType: BatchOperationTypeEnum;

endDate​

endDate: string | null;

The end date of the batch operation. This is null if the batch operation is still running.

errors​

errors: BatchOperationError[];

The errors that occurred per partition during the batch operation.

operationsCompletedCount​

operationsCompletedCount: number;

The number of successfully completed tasks.

operationsFailedCount​

operationsFailedCount: number;

The number of items which failed during execution of the batch operation. (e.g. because they are rejected by the Zeebe engine).

operationsTotalCount​

operationsTotalCount: number;

The total number of items contained in this batch operation.

startDate​

startDate: string | null;

The start date of the batch operation. This is null if the batch operation has not yet started.

state​

state: BatchOperationStateEnum;