@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias BatchOperationResponse

    type BatchOperationResponse = {
        batchOperationKey?: BatchOperationKey;
        batchOperationType?: BatchOperationTypeEnum;
        endDate?: string;
        errors?: BatchOperationError[];
        operationsCompletedCount?: number;
        operationsFailedCount?: number;
        operationsTotalCount?: number;
        startDate?: string;
        state?:
            | "ACTIVE"
            | "CANCELED"
            | "COMPLETED"
            | "CREATED"
            | "FAILED"
            | "PARTIALLY_COMPLETED"
            | "SUSPENDED";
    }
    Index

    Properties

    batchOperationKey? batchOperationType? endDate? errors? operationsCompletedCount? operationsFailedCount? operationsTotalCount? startDate? state?

    Properties

    batchOperationKey?: BatchOperationKey

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

    batchOperationType?: BatchOperationTypeEnum
    endDate?: string

    The end date of the batch operation.

    errors?: BatchOperationError[]

    The errors that occurred per partition during the batch operation.

    operationsCompletedCount?: number

    The number of successfully completed tasks.

    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?: number

    The total number of items contained in this batch operation.

    startDate?: string

    The start date of the batch operation.

    state?:
        | "ACTIVE"
        | "CANCELED"
        | "COMPLETED"
        | "CREATED"
        | "FAILED"
        | "PARTIALLY_COMPLETED"
        | "SUSPENDED"

    The state of the batch operation.

    Settings

    Member Visibility

    On This Page

    Properties