> ## 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.BatchTaskInfo

# <a id="SuperOffice_WebApi_Data_BatchTaskInfo" /> Class BatchTaskInfo

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

Carrier object for BatchTaskInfo.
BatchTaskInfo contains information about one batch task.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[BatchTaskInfo](SuperOffice.WebApi.Data.BatchTaskInfo.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)

## Constructors

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo__ctor" /> BatchTaskInfo()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_AssociateId" /> AssociateId

Task owner. If it is a System task, AssociateId = 0.

```csharp theme={null}
public virtual int AssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_CancellationBehaviour" /> CancellationBehaviour

Indicate if the task can be stopped.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public BatchTaskCancellationBehaviour? CancellationBehaviour { get; set; }
```

#### Property Value

[BatchTaskCancellationBehaviour](SuperOffice.WebApi.Data.BatchTaskCancellationBehaviour.md)?

#### See Also

[BatchTaskInfo](SuperOffice.WebApi.Data.BatchTaskInfo.md).[CancellationBehaviour\_String](SuperOffice.WebApi.Data.BatchTaskInfo.md#SuperOffice_WebApi_Data_BatchTaskInfo_CancellationBehaviour_String)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_CancellationBehaviour_String" /> CancellationBehaviour\_String

Indicate if the task can be stopped.
Raw string enum value.

```csharp theme={null}
[JsonProperty("CancellationBehaviour")]
public string CancellationBehaviour_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[BatchTaskInfo](SuperOffice.WebApi.Data.BatchTaskInfo.md).[CancellationBehaviour](SuperOffice.WebApi.Data.BatchTaskInfo.md#SuperOffice_WebApi_Data_BatchTaskInfo_CancellationBehaviour)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Context" /> Context

Context for the executing task.

```csharp theme={null}
public virtual string Context { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Created" /> Created

Task creation time.

```csharp theme={null}
public virtual DateTime Created { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_DatabaseSerialNumber" /> DatabaseSerialNumber

Serial number of the database the task is to run on.

```csharp theme={null}
public virtual string DatabaseSerialNumber { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Description" /> Description

Description of the task.

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_DetailsRecord" /> DetailsRecord

Record Id of a row in the DetailsTable containing more info about the task.

```csharp theme={null}
public virtual int DetailsRecord { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_DetailsTable" /> DetailsTable

Id of table with more information about the task.

```csharp theme={null}
public virtual short DetailsTable { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_FileName" /> FileName

The filename related to the batchtask.

```csharp theme={null}
public virtual string FileName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Id" /> Id

Id of the task.

```csharp theme={null}
public virtual int Id { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_IsInternalTask" /> IsInternalTask

If IsInternalTask is true, this task will not add a trace to the database.

```csharp theme={null}
public virtual bool IsInternalTask { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_IsSystemTask" /> IsSystemTask

If IsSystemTask is true, the task is not initiated by an associate.

```csharp theme={null}
public virtual bool IsSystemTask { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_LastStarted" /> LastStarted

When was the task last started.

```csharp theme={null}
public virtual DateTime LastStarted { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Name" /> Name

Name of the task.

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_ParameterObject" /> ParameterObject

ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

```csharp theme={null}
public virtual StringDictionary ParameterObject { get; set; }
```

#### Property Value

[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_ProgressDescription" /> ProgressDescription

Descriptive text for the current stage

```csharp theme={null}
public virtual string ProgressDescription { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_ProgressPercent" /> ProgressPercent

Task progress, in percent of estimated total

```csharp theme={null}
public virtual short ProgressPercent { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Request" /> Request

Maps to the request field in the batchtask table.

```csharp theme={null}
public virtual string Request { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Response" /> Response

Maps to the response field in the batchtask table.

```csharp theme={null}
public virtual string Response { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_Result" /> Result

Maps to the result field in the batchtask table.

```csharp theme={null}
public virtual string Result { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_StartCount" /> StartCount

Maps to the startcount field in the batchtask table.

```csharp theme={null}
public virtual int StartCount { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_State" /> State

BatchTaskState of the task.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public BatchTaskState? State { get; set; }
```

#### Property Value

[BatchTaskState](SuperOffice.WebApi.Data.BatchTaskState.md)?

#### See Also

[BatchTaskInfo](SuperOffice.WebApi.Data.BatchTaskInfo.md).[State\_String](SuperOffice.WebApi.Data.BatchTaskInfo.md#SuperOffice_WebApi_Data_BatchTaskInfo_State_String)

### <a id="SuperOffice_WebApi_Data_BatchTaskInfo_State_String" /> State\_String

BatchTaskState of the task.
Raw string enum value.

```csharp theme={null}
[JsonProperty("State")]
public string State_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[BatchTaskInfo](SuperOffice.WebApi.Data.BatchTaskInfo.md).[State](SuperOffice.WebApi.Data.BatchTaskInfo.md#SuperOffice_WebApi_Data_BatchTaskInfo_State)

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.BatchAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.BatchAgent.md)
- [SuperOffice.WebApi.Agents.IBatchAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IBatchAgent.md)
- [SuperOffice.WebApi.Data.Batch UpdateBatchTaskRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_UpdateBatchTaskRequest.md)
- [SuperOffice.WebApi.Data.Batch StartBatchJobRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_StartBatchJobRequest.md)
- [SuperOffice.WebApi.Agents.SaintAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.SaintAgent.md)
- [SuperOffice.WebApi.Agents.ISaintAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ISaintAgent.md)