> ## 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.Agents.IBulkUpdateAgent

# \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent">\</a> Interface IBulkUpdateAgent

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

Agent used for bulk update methods

```csharp theme={null}
public interface IBulkUpdateAgent : IAgentBase, IDisposable
```

#### Implements

[IAgentBase](SuperOffice.WebApi.Agents.IAgentBase.md),
[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)

## Methods

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_ExecuteByEntityIdsAsync\_SuperOffice\_WebApi\_Data\_FieldValueInfo\_\_\_System\_String\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> ExecuteByEntityIdsAsync(FieldValueInfo\[], string, string, string, RequestOptions)

Do the batchupdate on selected

```csharp theme={null}
Task<int> ExecuteByEntityIdsAsync(FieldValueInfo[] fieldValueInfos, string tableName, string context, string ids, RequestOptions requestOptions = null)
```

#### Parameters

`fieldValueInfos` [FieldValueInfo](SuperOffice.WebApi.Data.FieldValueInfo.md)\[]

The name of the wanted tablename

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

The name of the table to bulk update

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

Where is the function called from

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

Comma separated string of the ids of the entities to update

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Return batchtaskinfoid

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_ExecuteBySelectionIdAsync\_SuperOffice\_WebApi\_Data\_FieldValueInfo\_\_\_System\_String\_System\_String\_System\_Int32\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> ExecuteBySelectionIdAsync(FieldValueInfo\[], string, string, int, bool, RequestOptions)

Do the batchupdate on this selection

```csharp theme={null}
Task<int> ExecuteBySelectionIdAsync(FieldValueInfo[] fieldValueInfos, string tableName, string context, int selectionId, bool isShadow, RequestOptions requestOptions = null)
```

#### Parameters

`fieldValueInfos` [FieldValueInfo](SuperOffice.WebApi.Data.FieldValueInfo.md)\[]

The name of the wanted tablename

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

The name of the table to bulk update

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

Where is the function called for

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

The id of the selection

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

Use the shadow selection

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Return batchtaskinfoid

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_GetAvailableFieldsAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetAvailableFieldsAsync(string, RequestOptions)

Get all available fields for a given tablename/entity

```csharp theme={null}
Task<FieldValueInfo[]> GetAvailableFieldsAsync(string tablename, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the wanted tablename

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[FieldValueInfo](SuperOffice.WebApi.Data.FieldValueInfo.md)\[]\&gt;

Returns array of the available fields for the given entity

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_GetJobResultAsJsonFromBinaryObjectIdAsync\_System\_String\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetJobResultAsJsonFromBinaryObjectIdAsync(string, int, RequestOptions)

Get result of the batchupdate job

```csharp theme={null}
Task<string> GetJobResultAsJsonFromBinaryObjectIdAsync(string tableName, int binaryObjectId, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the table that was updated to show the log from

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

Which binaryobject id has stored the job result

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

Result of job as json

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_GetJobResultsFromStorageAsJsonAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetJobResultsFromStorageAsJsonAsync(RequestOptions)

Get result of the batchupdate job

```csharp theme={null}
Task<string[]> GetJobResultsFromStorageAsJsonAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\[]\&gt;

Result of job as json

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_GetStoredFieldsAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetStoredFieldsAsync(string, string, RequestOptions)

Get all stored fields for a given tablename/entity and context

```csharp theme={null}
Task<FieldValueInfo[]> GetStoredFieldsAsync(string tablename, string context, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the wanted tablename

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

Where is the function called for

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[FieldValueInfo](SuperOffice.WebApi.Data.FieldValueInfo.md)\[]\&gt;

Returns array of the stored or default fields for the given entity

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_RemoveStoredFieldsAndGetDefaultFieldsAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveStoredFieldsAndGetDefaultFieldsAsync(string, string, RequestOptions)

Remove the stored settings of the bulk update for this table from this context, to get the default settings instead

```csharp theme={null}
Task<FieldValueInfo[]> RemoveStoredFieldsAndGetDefaultFieldsAsync(string tableName, string context, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the table to remove stored settings from

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

Where is the function called from that we will remove the settings from

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[FieldValueInfo](SuperOffice.WebApi.Data.FieldValueInfo.md)\[]\&gt;

Returns array of the available fields for the given tablename

### \<a id="SuperOffice\_WebApi\_Agents\_IBulkUpdateAgent\_RemoveStoredFieldsAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveStoredFieldsAsync(string, string, RequestOptions)

Remove the stored settings of the bulk update for this table from this context

```csharp theme={null}
Task<bool> RemoveStoredFieldsAsync(string tableName, string context, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the table to remove stored settings from

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

Where is the function called from that we will remove the settings from

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)\&gt;


## Related topics

- [SuperOffice.WebApi.Agents.BulkUpdateAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.BulkUpdateAgent.md)
- [SuperOffice.WebApi.Data.OperationInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.OperationInfo.md)
- [SuperOffice.WebApi.Data.ControlInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.ControlInfo.md)
- [SuperOffice.WebApi.Data.FieldValueInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldValueInfo.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.BulkUpdate](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.BulkUpdate.md)
- [SuperOffice.WebApi.Data.BulkUpdate ExecuteByEntityIdsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.BulkUpdate_ExecuteByEntityIdsRequest.md)