# Interface IBulkApi

OptimaJet.Workflow.Core.Runtime.Bulk.IBulkApi

Provides an API for executing [WorkflowRuntime](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) operations in bulk mode.

Namespace: [OptimaJet.Workflow.Core.Runtime.Bulk](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/)

```csharp
public interface IBulkApi
```

## Properties

`int DefaultMaxDegreeOfParallelism { get; set; }` 

Gets or sets the default value used for the `maxDegreeOfParallelism` argument in Bulk API methods.

`bool DefaultThrowOnError { get; set; }` 

Gets or sets the default value used for the `throwOnError` argument in Bulk API methods.

## Methods

`Task<Dictionary<Guid, BulkTaskResult<Empty>>> CreateInstanceAsync(IEnumerable<CreateInstanceParams> createInstanceParams, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.CreateInstanceAsync(CreateInstanceParams, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `createInstanceParams` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `createInstanceParams` | `IEnumerable<CreateInstanceParams>` | A collection of [CreateInstanceParams](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/CreateInstanceParams/) values describing the process instances to create. |
| `taskFinalizedHandler` | `EventHandler<Guid, Empty>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, Empty>` | A dictionary of final task states and results. The key is [CreateInstanceParams.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/CreateInstanceParams/). |

`Task<Dictionary<Guid, BulkTaskResult<Empty>>> CreateInstanceAsync(IEnumerable<Guid> processIds, string schemaCode, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.CreateInstanceAsync(string, Guid, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `IEnumerable<Guid>` | A collection of process IDs for which instances are created. |
| `schemaCode` | `String` | Schema code used when creating instances. |
| `taskFinalizedHandler` | `EventHandler<Guid, Empty>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, Empty>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<ProcessInstance>>> GetProcessInstanceAndFillProcessParametersAsync(IEnumerable<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, ProcessInstance>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetProcessInstanceAndFillProcessParametersAsync(Guid)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `IEnumerable<Guid>` | A collection of process IDs for which process instances are obtained and filled. |
| `taskFinalizedHandler` | `EventHandler<Guid, ProcessInstance>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, ProcessInstance>` | A dictionary of final task states and results. The key is the [ProcessInstance.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) of each requested process. |

`Task<Dictionary<Guid, BulkTaskResult<ProcessInstancesTree>>> GetProcessInstancesTreeAsync(IEnumerable<Guid> rootProcessIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, ProcessInstancesTree>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetProcessInstancesTreeAsync(Guid, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `rootProcessIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `rootProcessIds` | `IEnumerable<Guid>` | A collection of root process IDs for which instance trees are obtained. |
| `taskFinalizedHandler` | `EventHandler<Guid, ProcessInstancesTree>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, ProcessInstancesTree>` | A dictionary of final task states and results. The key is each corresponding item from `rootProcessIds`. |

`Task<Dictionary<Guid, BulkTaskResult<ProcessInstancesTree>>> GetProcessInstancesTreeAsync(IEnumerable<ProcessInstance> processInstances, EventHandler<BulkTaskFinalizedEventArgs<Guid, ProcessInstancesTree>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetProcessInstancesTreeAsync(ProcessInstance, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processInstances` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstances` | `IEnumerable<ProcessInstance>` | A collection of process instances for which trees are obtained. |
| `taskFinalizedHandler` | `EventHandler<Guid, ProcessInstancesTree>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, ProcessInstancesTree>` | A dictionary of final task states and results. The key is [ProcessInstance.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/). |

`Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<ProcessInstance> processInstances, IEnumerable<string> identityIds, string? commandNameFilter = null, string? mainIdentityId = null, CultureInfo? culture = null, bool conditionCheck = false, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetAvailableCommandsAsync(ProcessInstance, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processInstances` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstances` | `IEnumerable<ProcessInstance>` | A collection of process instances for which commands are queried. |
| `identityIds` | `IEnumerable<String>` | The workflow participant identities used to build the initial command list. |
| `commandNameFilter` | `String` | Returns only the named command when provided. |
| `mainIdentityId` | `String` | The main workflow participant identity used for priority rule checks. |
| `culture` | `CultureInfo` | Culture used for localizing command names and parameters. |
| `conditionCheck` | `Boolean` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), commands with failed condition checks are excluded. |
| `taskFinalizedHandler` | `EventHandler<Guid, WorkflowCommand>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, WorkflowCommand>` | A dictionary of final task states and results. The key is [ProcessInstance.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/). |

`Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<ProcessInstance> processInstances, string identityId, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetAvailableCommandsAsync(ProcessInstance, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processInstances` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstances` | `IEnumerable<ProcessInstance>` | A collection of process instances for which commands are queried. |
| `identityId` | `String` | The workflow participant identity used to build the initial command list. |
| `taskFinalizedHandler` | `EventHandler<Guid, WorkflowCommand>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, WorkflowCommand>` | A dictionary of final task states and results. The key is [ProcessInstance.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/). |

`Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<Guid> processIds, IEnumerable<string> identityIds, string? commandNameFilter = null, string? mainIdentityId = null, CultureInfo? culture = null, bool conditionCheck = false, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetAvailableCommandsAsync(Guid, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `IEnumerable<Guid>` | A collection of process IDs for which commands are queried. |
| `identityIds` | `IEnumerable<String>` | The workflow participant identities used to build the initial command list. |
| `commandNameFilter` | `String` | Returns only the named command when provided. |
| `mainIdentityId` | `String` | The main workflow participant identity used for priority rule checks. |
| `culture` | `CultureInfo` | Culture used for localizing command names and parameters. |
| `conditionCheck` | `Boolean` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), commands with failed condition checks are excluded. |
| `taskFinalizedHandler` | `EventHandler<Guid, WorkflowCommand>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, WorkflowCommand>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<Guid> processIds, string identityId, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetAvailableCommandsAsync(Guid, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `IEnumerable<Guid>` | A collection of process IDs for which commands are queried. |
| `identityId` | `String` | The workflow participant identity used to build the initial command list. |
| `taskFinalizedHandler` | `EventHandler<Guid, WorkflowCommand>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, WorkflowCommand>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<Guid> processIds, string identityId, CultureInfo culture, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.GetAvailableCommandsAsync(Guid, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `IEnumerable<Guid>` | A collection of process IDs for which commands are queried. |
| `identityId` | `String` | The workflow participant identity used to build the initial command list. |
| `culture` | `CultureInfo` | Culture used for localizing command names and parameters. |
| `taskFinalizedHandler` | `EventHandler<Guid, WorkflowCommand>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, WorkflowCommand>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<CommandExecutionResult>>> ExecuteCommandAsync(IEnumerable<WorkflowCommand> commands, string identityId, string impersonatedIdentityId, bool checkRestrictions = false, EventHandler<BulkTaskFinalizedEventArgs<Guid, CommandExecutionResult>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.ExecuteCommandAsync(WorkflowCommand, string, string, CancellationToken, bool)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each command in `commands`.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `commands` | `IEnumerable<WorkflowCommand>` | A collection of commands to execute. |
| `identityId` | `String` | The workflow participant identity that initiates command execution. |
| `impersonatedIdentityId` | `String` | The workflow participant identity on whose behalf the commands are executed. |
| `checkRestrictions` | `Boolean` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), actor-restriction checks are enforced for each transition. |
| `taskFinalizedHandler` | `EventHandler<Guid, CommandExecutionResult>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, CommandExecutionResult>` | A dictionary of final task states and results. The key is [WorkflowCommand.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowCommand/). |

`Task<Dictionary<Guid, BulkTaskResult<CommandExecutionResult>>> ExecuteCommandWithRestrictionCheckAsync(IEnumerable<WorkflowCommand> commands, string identityId, string impersonatedIdentityId, EventHandler<BulkTaskFinalizedEventArgs<Guid, CommandExecutionResult>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.ExecuteCommandWithRestrictionCheckAsync(WorkflowCommand, string, string, CancellationToken)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each command in `commands`.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `commands` | `IEnumerable<WorkflowCommand>` | A collection of commands to execute. |
| `identityId` | `String` | The workflow participant identity that initiates command execution. |
| `impersonatedIdentityId` | `String` | The workflow participant identity on whose behalf the commands are executed. |
| `taskFinalizedHandler` | `EventHandler<Guid, CommandExecutionResult>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, CommandExecutionResult>` | A dictionary of final task states and results. The key is [WorkflowCommand.ProcessId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowCommand/). |

`Task<Dictionary<Guid, BulkTaskResult<Empty>>> UpdateSchemeIfObsoleteAsync(List<Guid> processIds, bool ignoreAutoSchemeUpdate, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.UpdateSchemeIfObsoleteAsync(Guid, bool)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `List<Guid>` | A collection of process IDs for which schema updates are performed. |
| `ignoreAutoSchemeUpdate` | `Boolean` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), ignores auto-scheme update behavior. |
| `taskFinalizedHandler` | `EventHandler<Guid, Empty>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, Empty>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<Empty>>> UpdateSchemeIfObsoleteAsync(List<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.UpdateSchemeIfObsoleteAsync(Guid)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `List<Guid>` | A collection of process IDs for which schema updates are performed. |
| `taskFinalizedHandler` | `EventHandler<Guid, Empty>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, Empty>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<Empty>>> DeleteInstanceAsync(List<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.DeleteInstanceAsync(Guid)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `List<Guid>` | A collection of process IDs for which instances are deleted. |
| `taskFinalizedHandler` | `EventHandler<Guid, Empty>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, Empty>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

`Task<Dictionary<Guid, BulkTaskResult<bool>>> IsProcessExistsAsync(List<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, bool>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default)` 

Executes [WorkflowRuntime.IsProcessExistsAsync(Guid)](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) for each `processIds` item.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processIds` | `List<Guid>` | A collection of process IDs to check for existence. |
| `taskFinalizedHandler` | `EventHandler<Guid, Boolean>` | Event handler invoked when an individual task in the batch completes. It receives the task's progress and intermediate result in [BulkTaskFinalizedEventArgs<TId, TResult>](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/BulkTaskFinalizedEventArgs-TId-TResult/). |
| `maxDegreeOfParallelism` | `Nullable<Int32>` | Maximum number of tasks that may execute concurrently while running this bulk call. |
| `throwOnError` | `Nullable<Boolean>` | When [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), after all tasks are completed, an [AggregateException](https://learn.microsoft.com/dotnet/api/system.aggregateexception) is thrown if at least one task has failed. |
| `cancellationToken` | `CancellationToken` | Cancellation token observed while scheduling and executing tasks. If cancellation is requested, no new tasks are started and already running tasks continue. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Guid, Boolean>` | A dictionary of final task states and results. The key is each corresponding item from `processIds`. |

[Previous Empty](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Bulk/Empty/) [Next Calendar](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime.Calendars/Calendar/)