> ## 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.ArchiveAgent
# \\ Class ArchiveAgent
Namespace: [SuperOffice.WebApi.Agents](SuperOffice.WebApi.Agents.md)\
Assembly: SuperOffice.WebApi.dll
ArchiveList functions of all kinds
```csharp theme={null}
public class ArchiveAgent : AgentBase, IArchiveAgent, IAgentBase, IDisposable
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[AgentBase](SuperOffice.WebApi.Agents.AgentBase.md) ←
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md)
#### Implements
[IArchiveAgent](SuperOffice.WebApi.Agents.IArchiveAgent.md),
[IAgentBase](SuperOffice.WebApi.Agents.IAgentBase.md),
[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)
#### Inherited Members
[AgentBase.\_json](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__json),
[AgentBase.\_binary](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__binary),
[AgentBase.\_config](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__config),
[AgentBase.\_client](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__client),
[AgentBase.\_disposeClient](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__disposeClient),
[AgentBase.Merge(RequestOptions)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Merge_SuperOffice_WebApi_RequestOptions_),
[AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromStream_System_Net_Http_HttpMethod_System_String_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.ParseAuthorization(IAuthorization)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ParseAuthorization_SuperOffice_WebApi_Authorization_IAuthorization_),
[AgentBase.CancelRequest()](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_CancelRequest),
[AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_SendRequestObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_SendRequestObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.SendRequest(HttpRequestMessage, RequestOptions)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_SendRequest_System_Net_Http_HttpRequestMessage_SuperOffice_WebApi_RequestOptions_),
[AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ThrowOnResponseErrorAsync_System_Net_Http_HttpRequestMessage_System_Net_Http_HttpResponseMessage_),
[AgentBase.ParseResponse\\using SuperOffice.WebApi;
using SuperOffice.WebApi.Agents;
var mySession = new WebApiOptions("[http://example.com/super/api](http://example.com/super/api)");
mySession.Authorization = new AuthorizationUsernamePassword("user", "pass");
using (ArchiveAgent agent = new ArchiveAgent(mySession))
\{
// call methods on agent here...
}\\
## Constructors
### \\ ArchiveAgent(HttpClient)
Constructor: ArchiveList functions of all kinds
```csharp theme={null}
public ArchiveAgent(HttpClient httpClient)
```
#### Parameters
`httpClient` [HttpClient](https://learn.microsoft.com/dotnet/api/system.net.http.httpclient)
Use this HTTP client instead of making own HttpClient instance.
### \\ ArchiveAgent(WebApiOptions, HttpClient)
Constructor: ArchiveList functions of all kinds
```csharp theme={null}
public ArchiveAgent(WebApiOptions options, HttpClient httpClient = null)
```
#### Parameters
`options` [WebApiOptions](SuperOffice.WebApi.WebApiOptions.md)
Base URL and authentication values.
`httpClient` [HttpClient](https://learn.microsoft.com/dotnet/api/system.net.http.httpclient)
Optional: Use this HTTP client instead of making a new one.
## Methods
### \\ CreateDefaultArchiveListResultAsync(RequestOptions)
Set default values into a new ArchiveListResult.
NetServer calculates default values on the entity, which is required when creating/storing a new instance
```csharp theme={null}
public Task CreateDefaultArchiveListResultAsync(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)\<[ArchiveListResult](SuperOffice.WebApi.Data.ArchiveListResult.md)\>
A blank ArchiveListResult
### \\ ExportArchiveAsync(string, string, string\[], string\[], ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string, string\[], int, RequestOptions)
Exports the target archive to a downloadable format.
```csharp theme={null}
public Task ExportArchiveAsync(string providerName, string context, string[] desiredEntities, string[] columns, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restrictions, string exportType, string[] selectedRowIds, int estimatedRowCount, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`desiredEntities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Comma separated list of the names of the desired entities.
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Comma separated list of the names of the columns wanted; supports display names
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
`restrictions` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
`exportType` [string](https://learn.microsoft.com/dotnet/api/system.string)
To what format the archive should be exported; Excel, etc.
`selectedRowIds` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
`estimatedRowCount` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The estimated amount of rows to be exported. Used to determine if the operation should be run as a batch task or immediately.
`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)\<[ExportArchiveResult](SuperOffice.WebApi.Data.ExportArchiveResult.md)\>
### \\ GetActivityFilterAsync(RequestOptions)
Get activity filter for the specified list.
```csharp theme={null}
public Task GetActivityFilterAsync(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)\<[ActivityFilter](SuperOffice.WebApi.Data.ActivityFilter.md)\>
The activity filter for the specified list
### \\ GetArchiveConfigurationAsync(string, string, RequestOptions)
Get the configuration for one archive. The configuration is keyed by a combination of archive provider name and gui name. The archive provider name must match an archive provider plugin; the gui name is an arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.
```csharp theme={null}
public Task GetArchiveConfigurationAsync(string guiName, string providerName, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`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)\<[ArchiveConfiguration](SuperOffice.WebApi.Data.ArchiveConfiguration.md)\>
Archive configuration consisting of column information, orderby information and entities
### \\ GetArchiveConfigurationV2Async(string, string, string, string, RequestOptions)
Get the configuration for one archive. The configuration is keyed by a combination of archive provider name (plus optional context), gui name, and optional table binding. The archive provider name must match an archive provider plugin; the gui name is an arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.
```csharp theme={null}
public Task GetArchiveConfigurationV2Async(string guiName, string providerName, string context, string ownerKeys, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor. Optional, but required for archives that depend on a context - for instance Quote archives that need to know their QuoteConnectionId to be meaningful
`ownerKeys` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name/value string containing ownership binding information. The first should resolve to a table/primarykey, such as selection=123. Future functionality may allow multiple/extended keys
`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)\<[ArchiveConfiguration](SuperOffice.WebApi.Data.ArchiveConfiguration.md)\>
Archive configuration consisting of column information, orderby information and entities
### \\ GetArchiveConfigurationWithContextAsync(string, string, string, RequestOptions)
Get the configuration for one archive, with context parameter. The configuration is keyed by a combination of archive provider name and gui name. The archive provider name must match an archive provider plugin; the gui name is an arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.
```csharp theme={null}
public Task GetArchiveConfigurationWithContextAsync(string guiName, string providerName, string context, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveConfiguration](SuperOffice.WebApi.Data.ArchiveConfiguration.md)\>
Archive configuration consisting of column information, orderby information and entities
### \\ GetArchiveList2Async(string, string, string, string, string, int, int, RequestOptions)
Get a page of data for an archive using a restriction string. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.
```csharp theme={null}
public Task GetArchiveList2Async(string guiName, string providerName, string sortOrder, string restriction, string entities, int page, int pageSize, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The GUI name of the archive list, used to retrieve the currently configured set of columns (otherwise manipulated using the ArchiveConfiguration service)
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`sortOrder` [string](https://learn.microsoft.com/dotnet/api/system.string)
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [string](https://learn.microsoft.com/dotnet/api/system.string)
Archive restrictions as string. e.g. "name = 'baz' or category oneOf (1,2,3)". Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListAsync(string, string, ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string\[], int, int, RequestOptions)
Get a page of data for an archive. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.
```csharp theme={null}
public Task GetArchiveListAsync(string guiName, string providerName, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restriction, string[] entities, int page, int pageSize, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The GUI name of the archive list, used to retrieve the currently configured set of columns (otherwise manipulated using the ArchiveConfiguration service)
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
Archive restrictions. Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Which entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumns2Async(string, string, string, string, string, int, int, RequestOptions)
Get a page of results for an archive list, explicitly specifying the restrictions as a string, orderby and chosen columns.
```csharp theme={null}
public Task GetArchiveListByColumns2Async(string providerName, string columns, string sortOrder, string restrictions, string entities, int page, int pageSize, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)
An array of the names of the columns wanted.
`sortOrder` [string](https://learn.microsoft.com/dotnet/api/system.string)
Sort order for the archive as string ('name asc, dept desc'). Can be null, which indicates 'no particular order'
`restrictions` [string](https://learn.microsoft.com/dotnet/api/system.string)
Archive restrictions as string ('category = 1 and business oneOf (1,2,3)'). Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsAsync(string, string\[], ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string\[], int, int, RequestOptions)
Get a page of results for an archive list, explicitly specifying the restrictions, orderby and chosen columns.
```csharp theme={null}
public Task GetArchiveListByColumnsAsync(string providerName, string[] columns, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restriction, string[] entities, int page, int pageSize, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
An array of the names of the columns wanted.
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
Archive restrictions. Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Which entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsWithContext2Async(string, string, string, string, string, int, int, string, RequestOptions)
Get a page of results for an archive list with context parameter, explicitly specifying the restrictions as a string, orderby and chosen columns.
```csharp theme={null}
public Task GetArchiveListByColumnsWithContext2Async(string providerName, string columns, string sortOrder, string restriction, string entities, int page, int pageSize, string context, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated names of the columns wanted.
`sortOrder` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of columns to sort order for the archive. e.g.: "name asc, dept desc, registeredBy" Can be null, which indicates 'no particular order'
`restriction` [string](https://learn.microsoft.com/dotnet/api/system.string)
Archive restrictions as string. e.g. "name startsWith 'foo' and (dept = 'bar' or dept = 'baz')" Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsWithContextAsync(string, string\[], ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string\[], int, int, string, RequestOptions)
Get a page of results for an archive list with context parameter, explicitly specifying the restrictions, orderby and chosen columns.
```csharp theme={null}
public Task GetArchiveListByColumnsWithContextAsync(string providerName, string[] columns, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restriction, string[] entities, int page, int pageSize, string context, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
An array of the names of the columns wanted.
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
Archive restrictions. Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Which entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsWithHeader2Async(string, string, string, string, string, int, int, string, RequestOptions)
Get a page of results for an archive list, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options. The return value includes a header that has various extra information, in addition to the actual rows.
```csharp theme={null}
public Task GetArchiveListByColumnsWithHeader2Async(string providerName, string columns, string sortOrder, string restriction, string entities, int page, int pageSize, string options, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated string of the names of the columns wanted.
`sortOrder` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated string of sort order for the archive. e.g. "name asc, dept desc" Can be null, which indicates 'no particular order'
`restriction` [string](https://learn.microsoft.com/dotnet/api/system.string)
Archive restrictions. e.g. "category = 2 or business oneOf (2,3,4)" Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`options` [string](https://learn.microsoft.com/dotnet/api/system.string)
name=value\&... formatted set of options. "rowcount=true" will cause the rowcount to be calculated and populated.
`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)\<[ArchiveListResult](SuperOffice.WebApi.Data.ArchiveListResult.md)\>
Header with optional row count, plus array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsWithHeaderAsync(string, string\[], ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string\[], int, int, string, RequestOptions)
Get a page of results for an archive list, explicitly specifying the restrictions, orderby and chosen columns; as well as a name/value string formatted set of options. The return value includes a header that has various extra information, in addition to the actual rows.
```csharp theme={null}
public Task GetArchiveListByColumnsWithHeaderAsync(string providerName, string[] columns, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restriction, string[] entities, int page, int pageSize, string options, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
An array of the names of the columns wanted.
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
Archive restrictions. Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Which entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`options` [string](https://learn.microsoft.com/dotnet/api/system.string)
name=value\&... formatted set of options. "rowcount=true" will cause the rowcount to be calculated and populated.
`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)\<[ArchiveListResult](SuperOffice.WebApi.Data.ArchiveListResult.md)\>
Header with optional row count, plus array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsWithHeaderWithContext2Async(string, string, string, string, string, int, int, string, string, RequestOptions)
Get a page of results for an archive list, with context parameter, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options. The return value includes a header that has various extra information, in addition to the actual rows.
```csharp theme={null}
public Task GetArchiveListByColumnsWithHeaderWithContext2Async(string providerName, string columns, string sortOrder, string restriction, string entities, int page, int pageSize, string options, string context, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of the names of the columns wanted.
`sortOrder` [string](https://learn.microsoft.com/dotnet/api/system.string)
Sort order for the archive. "name asc, dept desc" Can be null, which indicates 'no particular order'
`restriction` [string](https://learn.microsoft.com/dotnet/api/system.string)
Archive restrictions as string. "updated > '2009.1.1' and registeredBy = 2" Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`options` [string](https://learn.microsoft.com/dotnet/api/system.string)
name=value\&... formatted set of options. "rowcount=true" will cause the rowcount to be calculated and populated.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveListResult](SuperOffice.WebApi.Data.ArchiveListResult.md)\>
Header with optional row count, plus array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListByColumnsWithHeaderWithContextAsync(string, string\[], ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string\[], int, int, string, string, RequestOptions)
Get a page of results for an archive list, with context parameter, explicitly specifying the restrictions, orderby and chosen columns; as well as a name/value string formatted set of options. The return value includes a header that has various extra information, in addition to the actual rows.
```csharp theme={null}
public Task GetArchiveListByColumnsWithHeaderWithContextAsync(string providerName, string[] columns, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restriction, string[] entities, int page, int pageSize, string options, string context, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`columns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
An array of the names of the columns wanted.
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
Archive restrictions. Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Which entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`options` [string](https://learn.microsoft.com/dotnet/api/system.string)
name=value\&... formatted set of options. "rowcount=true" will cause the rowcount to be calculated and populated.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveListResult](SuperOffice.WebApi.Data.ArchiveListResult.md)\>
Header with optional row count, plus array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListWithContext2Async(string, string, string, string, string, int, int, string, RequestOptions)
Get a page of data for an archive using restrictions as strings, with context parameter. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.
```csharp theme={null}
public Task GetArchiveListWithContext2Async(string guiName, string providerName, string sortOrder, string restriction, string entities, int page, int pageSize, string context, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The GUI name of the archive list, used to retrieve the currently configured set of columns (otherwise manipulated using the ArchiveConfiguration service)
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`sortOrder` [string](https://learn.microsoft.com/dotnet/api/system.string)
Sort order for the archive. e.g. "name asc, dept desc" Can be null, which indicates 'no particular order'
`restriction` [string](https://learn.microsoft.com/dotnet/api/system.string)
Archive restrictions as string. e.g. "name gt 'B' or dept = 'baz'" Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)
Comma separated list of entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetArchiveListWithContextAsync(string, string, ArchiveOrderByInfo\[], ArchiveRestrictionInfo\[], string\[], int, int, string, RequestOptions)
Get a page of data for an archive, with context parameter. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.
```csharp theme={null}
public Task GetArchiveListWithContextAsync(string guiName, string providerName, ArchiveOrderByInfo[] sortOrder, ArchiveRestrictionInfo[] restriction, string[] entities, int page, int pageSize, string context, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The GUI name of the archive list, used to retrieve the currently configured set of columns (otherwise manipulated using the ArchiveConfiguration service)
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`sortOrder` [ArchiveOrderByInfo](SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)\[]
Sort order for the archive. Can be null, which indicates 'no particular order'
`restriction` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]
Archive restrictions. Archives will generally throw an exception if no restrictions are set. Pass in an empty array if you really do not want restrictions, but remember that you may end up fetching the first page of millions of rows.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Which entities to include. Can be null, which indicates 'include all entities'
`page` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page number, page 0 is the first page. Negative page numbers are interpreted as number of rows to skip.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Page size, which should be kept reasonable (say, no more than 1000 rows at a time)
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\>
Array of archive list items, where each item represents one row of data (row level data + the requested columns)
### \\ GetAvailableColumnsAsync(string, string, RequestOptions)
Return list of all columns supported by an archive provider. See also GetArchiveConfiguration.
```csharp theme={null}
public Task GetAvailableColumnsAsync(string providerName, string context, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Optional context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[ArchiveColumnInfo](SuperOffice.WebApi.Data.ArchiveColumnInfo.md)\[]\>
Array of all columns supported by the archive provider.
### \\ GetAvailableEntitiesAsync(string, string, RequestOptions)
Return list of all entities supported by an archive provider. See also GetArchiveConfiguration.
```csharp theme={null}
public Task GetAvailableEntitiesAsync(string providerName, string context, RequestOptions requestOptions = null)
```
#### Parameters
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the archive provider to use; it will be created via the ArchiveProviderFactory from a plugin
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Optional context parameter, url-encoded string context parameter for ArchiveProvider constructor
`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)\<[MDOListItem](SuperOffice.WebApi.Data.MDOListItem.md)\[]\>
Array of all entity types supported by the archive provider. MDOListItem.Name = DisplayName, Tooltip = DisplayTooltip, Type = code name, StyleHint = optional/mandatory, IconHint=DefaultShow
### \\ GetGroupAssociateIdsAsync(int\[], RequestOptions)
Returns the associate ids that belongs to the given groups
```csharp theme={null}
public Task GetGroupAssociateIdsAsync(int[] groupIds, RequestOptions requestOptions = null)
```
#### Parameters
`groupIds` [int](https://learn.microsoft.com/dotnet/api/system.int32)\[]
Array of group ids
`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)\[]\>
Array of associate ids
### \\ GetProviderNamesAsync(RequestOptions)
Return list of all archive provider names
```csharp theme={null}
public Task GetProviderNamesAsync(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)\[]\>
Array of all archive provider names.
### \\ GetRelatedData2Async(string, int, string, RequestOptions)
Get data for fields related to a table record. While this method /can/ be used to fetch plain fields, that is not the intended usage and it does not replace the Entity.Get methods available for that purpose. Nor does it replace the generic DotSyntax/Dynamic archive provider.
```csharp theme={null}
public Task GetRelatedData2Async(string table, int recordId, string fields, RequestOptions requestOptions = null)
```
#### Parameters
`table` [string](https://learn.microsoft.com/dotnet/api/system.string)
The root table to get related data for, such as 'ticket' or 'y\_car'
`recordId` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The primary key of the root table to get related data for
`fields` [string](https://learn.microsoft.com/dotnet/api/system.string)
Names of fields as a comma-separated list - these need to be valid in the DotSyntax for this table, and can be arbitrarily deep. Example: 'title,created\_by.associate\_id.person.fullName, x\_comment'. Do not start with the root table name.
`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)\<[RelatedData](SuperOffice.WebApi.Data.RelatedData.md)\[]\>
Array of field => ArchiveColumnData objects
### \\ GetRelatedDataAsync(string, int, string\[], RequestOptions)
Get data for fields related to a table record. While this method /can/ be used to fetch plain fields, that is not the intended usage and it does not replace the Entity.Get methods available for that purpose. Nor does it replace the generic DotSyntax/Dynamic archive provider.
```csharp theme={null}
public Task GetRelatedDataAsync(string table, int recordId, string[] fields, RequestOptions requestOptions = null)
```
#### Parameters
`table` [string](https://learn.microsoft.com/dotnet/api/system.string)
The root table to get related data for, such as 'ticket' or 'y\_car'
`recordId` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The primary key of the root table to get related data for
`fields` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Names of fields - these need to be valid in the DotSyntax for this table, and can be arbitrarily deep. Examples: 'title', 'created\_by.associate\_id.person.fullName', 'x\_comment'. Do not start with the root table name.
`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)\<[RelatedData](SuperOffice.WebApi.Data.RelatedData.md)\[]\>
Array of field => ArchiveColumnData objects
### \\ SetActivityFilterAsync(ActivityFilter, RequestOptions)
Set activity filter for the specified list.
```csharp theme={null}
public Task SetActivityFilterAsync(ActivityFilter activityFilter, RequestOptions requestOptions = null)
```
#### Parameters
`activityFilter` [ActivityFilter](SuperOffice.WebApi.Data.ActivityFilter.md)
New activity filter
`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)
### \\ SetChosenColumnsAsync(string, string, string\[], RequestOptions)
Set the currently chosen columns for the given gui name/provider name combination. This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveColumns: plus the archive provider name and gui name as its additionalInfo.
```csharp theme={null}
public Task SetChosenColumnsAsync(string guiName, string providerName, string[] chosenColumns, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`chosenColumns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Array of column names, where array order indicates left to right order in the archive.
`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)
### \\ SetChosenColumnsV2Async(string, string, string, string, string\[], RequestOptions)
Set the currently chosen columns for the given gui name/provider name combination. This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveColumns: plus the archive provider name and gui name as its additionalInfo.
```csharp theme={null}
public Task SetChosenColumnsV2Async(string guiName, string providerName, string context, string ownerKeys, string[] chosenColumns, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor. Optional, but required for archives that depend on a context - for instance Quote archives that need to know their QuoteConnectionId to be meaningful
`ownerKeys` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name/value string containing ownership binding information. The first should resolve to a table/primarykey, such as selection=123. Future functionality may allow multiple/extended keys
`chosenColumns` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Array of column names, where array order indicates left to right order in the archive.
`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)
### \\ SetChosenEntitiesAsync(string, string, string\[], RequestOptions)
Set the currently chosen entities for the given gui name/provider name combination. This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.
```csharp theme={null}
public Task SetChosenEntitiesAsync(string guiName, string providerName, string[] entities, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Array of entity names
`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)
### \\ SetChosenEntitiesV2Async(string, string, string, string, string\[], RequestOptions)
Set the currently chosen entities for the given gui name/provider name combination. This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.
```csharp theme={null}
public Task SetChosenEntitiesV2Async(string guiName, string providerName, string context, string ownerKeys, string[] entities, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor. Optional, but required for archives that depend on a context - for instance Quote archives that need to know their QuoteConnectionId to be meaningful
`ownerKeys` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name/value string containing ownership binding information. The first should resolve to a table/primarykey, such as selection=123. Future functionality may allow multiple/extended keys
`entities` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Array of entity names
`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)
### \\ SetColumnWidthsAsync(string, string\[], RequestOptions)
Set the column widths for the given set of columns and GUI name.
```csharp theme={null}
public Task SetColumnWidthsAsync(string guiName, string[] columnWidths, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`columnWidths` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Array of column widths. A column width is specified either as a fixed number of character (10c) or as a percentage (10%). Percentages will be recalculated so that they add up to exactly 100 when the configuration is fetched again.
`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)
### \\ SetColumnWidthsV2Async(string, string, string, string, string\[], RequestOptions)
Set the column widths for the given set of columns and GUI name.
```csharp theme={null}
public Task SetColumnWidthsV2Async(string guiName, string providerName, string context, string ownerKeys, string[] columnWidths, RequestOptions requestOptions = null)
```
#### Parameters
`guiName` [string](https://learn.microsoft.com/dotnet/api/system.string)
String that identifies the archive in the GUI, must be the same when fetching and storing configurations, but does not otherwise have to match anything.
`providerName` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name of archive provider, must match one of the plugins known to the ArchiveProviderFactory.
`context` [string](https://learn.microsoft.com/dotnet/api/system.string)
Context parameter, url-encoded string context parameter for ArchiveProvider constructor. Optional, but required for archives that depend on a context - for instance Quote archives that need to know their QuoteConnectionId to be meaningful
`ownerKeys` [string](https://learn.microsoft.com/dotnet/api/system.string)
Name/value string containing ownership binding information. The first should resolve to a table/primarykey, such as selection=123. Future functionality may allow multiple/extended keys
`columnWidths` [string](https://learn.microsoft.com/dotnet/api/system.string)\[]
Array of column widths. A column width is specified either as a fixed number of character (10c) or as a percentage (10%). Percentages will be recalculated so that they add up to exactly 100 when the configuration is fetched again.
`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)
## Related topics
- [SuperOffice.WebApi.Data.ArchiveConfiguration](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveConfiguration.md)
- [SuperOffice.WebApi.Data.ArchiveColumnData](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveColumnData.md)
- [SuperOffice.WebApi.Data.ArchiveColumnInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveColumnInfo.md)
- [SuperOffice.WebApi.Data.ArchiveListItem](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveListItem.md)
- [SuperOffice.WebApi.Data.ArchiveListResult](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveListResult.md)
- [SuperOffice.WebApi.Data.ArchiveOrderByInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveOrderByInfo.md)