> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.Batch

# <a id="SuperOffice_WebApi_Data_Batch" /> Class Batch

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for Batch.
BatchTasks run in the background.

```csharp theme={null}
public class Batch : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[Batch](SuperOffice.WebApi.Data.Batch.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get Batch 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new BatchAgent(configuration);
var batch = agent.GetBatch( 123 );</code></pre>

## Remarks

Use <xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false" />:
All Batch: <pre><code class="lang-csharp">"BatchTasks"</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_Batch__ctor" /> Batch()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public Batch()
```

## See Also

[BatchAgent](SuperOffice.WebApi.Agents.BatchAgent.md),
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md),


## Related topics

- [SuperOffice.WebApi.Data.Batch DeleteBatchTaskRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_DeleteBatchTaskRequest.md)
- [SuperOffice.WebApi.Data.Batch DeleteBatchTasksRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_DeleteBatchTasksRequest.md)
- [SuperOffice.WebApi.Data.Batch StartBatchJobRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_StartBatchJobRequest.md)
- [SuperOffice.WebApi.Data.Batch StopBatchJobRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_StopBatchJobRequest.md)
- [SuperOffice.WebApi.Data.Batch UpdateBatchTaskRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_UpdateBatchTaskRequest.md)
- [SuperOffice.WebApi.Data.Batch GetBatchTaskInfoRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_GetBatchTaskInfoRequest.md)