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

# \<a id="SuperOffice\_WebApi\_Agents\_DashAgent">\</a> Class DashAgent

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

Agent that lets you configure dashboard tiles and retrieve dashboard data

```csharp theme={null}
public class DashAgent : AgentBase, IDashAgent, IAgentBase, IDisposable
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[AgentBase](SuperOffice.WebApi.Agents.AgentBase.md) ←
[DashAgent](SuperOffice.WebApi.Agents.DashAgent.md)

#### Implements

[IDashAgent](SuperOffice.WebApi.Agents.IDashAgent.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\<T\&gt;(HttpResponseMessage)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ParseResponse__1_System_Net_Http_HttpResponseMessage_),
[AgentBase.Finally(RequestOptions)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Finally_SuperOffice_WebApi_RequestOptions_),
[AgentBase.Dispose()](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Dispose),
[AgentBase.Configuration](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Configuration),
[AgentBase.Client](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Client),
[AgentBase.HasRunningRequest](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_HasRunningRequest),
[AgentBase.ClientCancellationTokenSource](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ClientCancellationTokenSource),
[AgentBase.ProgressListener](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ProgressListener),
[AgentBase.UploadProgressListener](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_UploadProgressListener),
[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

\<pre>\<code class="lang-csharp">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 (DashAgent agent = new DashAgent(mySession))
\{
// call methods on agent here...
}\</code>\</pre>

## Constructors

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_\_ctor\_System\_Net\_Http\_HttpClient\_">\</a> DashAgent(HttpClient)

Constructor: Agent that lets you configure dashboard tiles and retrieve dashboard data

```csharp theme={null}
public DashAgent(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.

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_\_ctor\_SuperOffice\_WebApi\_WebApiOptions\_System\_Net\_Http\_HttpClient\_">\</a> DashAgent(WebApiOptions, HttpClient)

Constructor: Agent that lets you configure dashboard tiles and retrieve dashboard data

```csharp theme={null}
public DashAgent(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

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_AddNewTileToDashboardAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_DashTileDefinition\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddNewTileToDashboardAsync(int, DashTileDefinition, RequestOptions)

Add a new tile to a dashboard with next rank

```csharp theme={null}
public Task<DashTile> AddNewTileToDashboardAsync(int dashboardId, DashTileDefinition dashTileDefinition, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard to add the tile to

`dashTileDefinition` [DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)

The tile definition data to add to the dashboard

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

The newly added tile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_AddTileToDashboardAsync\_System\_Int32\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddTileToDashboardAsync(int, int, RequestOptions)

Add a tile to a dashboard with next rank

```csharp theme={null}
public Task<DashTile> AddTileToDashboardAsync(int dashboardId, int dashTileDefinitionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard to add the tile to

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

The id of the dashboard tile definition

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

The newly added tile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CopyTileSelectionAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CopyTileSelectionAsync(int, RequestOptions)

Copy Tile Selection for the dashboard

```csharp theme={null}
public Task<int> CopyTileSelectionAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy 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)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Selection Id

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDashTileSelectionFromEntityAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDashTileSelectionFromEntityAsync(string, RequestOptions)

Returns the id to a dashboard tile selection

```csharp theme={null}
public Task<int> CreateDashTileSelectionFromEntityAsync(string entityName, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the entity to create a default selection 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)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Selection Id

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultDashAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultDashAsync(RequestOptions)

Set default values into a new Dash.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<Dash> CreateDefaultDashAsync(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)\<[Dash](SuperOffice.WebApi.Data.Dash.md)\&gt;

A blank Dash

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultDashCollectionAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultDashCollectionAsync(RequestOptions)

Set default values into a new DashCollection.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<DashCollection> CreateDefaultDashCollectionAsync(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)\<[DashCollection](SuperOffice.WebApi.Data.DashCollection.md)\&gt;

A blank DashCollection

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultDashThemeAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultDashThemeAsync(RequestOptions)

Set default values into a new DashTheme.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<DashTheme> CreateDefaultDashThemeAsync(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)\<[DashTheme](SuperOffice.WebApi.Data.DashTheme.md)\&gt;

A blank DashTheme

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultDashTileAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultDashTileAsync(RequestOptions)

Set default values into a new DashTile.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<DashTile> CreateDefaultDashTileAsync(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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

A blank DashTile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultDashTileDefinitionAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultDashTileDefinitionAsync(RequestOptions)

Set default values into a new DashTileDefinition.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<DashTileDefinition> CreateDefaultDashTileDefinitionAsync(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)\<[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)\&gt;

A blank DashTileDefinition

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultPreviewDashAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultPreviewDashAsync(RequestOptions)

Set default values into a new PreviewDash.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<PreviewDash> CreateDefaultPreviewDashAsync(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)\<[PreviewDash](SuperOffice.WebApi.Data.PreviewDash.md)\&gt;

A blank PreviewDash

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultPreviewDashTileAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultPreviewDashTileAsync(RequestOptions)

Set default values into a new PreviewDashTile.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<PreviewDashTile> CreateDefaultPreviewDashTileAsync(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)\<[PreviewDashTile](SuperOffice.WebApi.Data.PreviewDashTile.md)\&gt;

A blank PreviewDashTile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultTileDefinitionForEntityAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultTileDefinitionForEntityAsync(string, RequestOptions)

Set Measure to CountAll and MeasureField to primary key field

```csharp theme={null}
public Task<DashTileDefinition> CreateDefaultTileDefinitionForEntityAsync(string entityName, RequestOptions requestOptions = null)
```

#### Parameters

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

Name of entity to use for primary key

`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)\<[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)\&gt;

Default

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_CreateDefaultTileForEntityAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultTileForEntityAsync(string, RequestOptions)

Set Measure to CountAll and MeasureField to primary key field

```csharp theme={null}
public Task<DashTile> CreateDefaultTileForEntityAsync(string entityName, RequestOptions requestOptions = null)
```

#### Parameters

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

Name of entity to use for primary key

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

Default

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_DeleteDashAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteDashAsync(int, RequestOptions)

Deletes the Dash

```csharp theme={null}
public Task DeleteDashAsync(int dashId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the Dash

`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)

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_DeleteDashThemeAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteDashThemeAsync(int, RequestOptions)

Deletes the DashTheme

```csharp theme={null}
public Task DeleteDashThemeAsync(int dashThemeId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the DashTheme

`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)

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_DeleteDashTileAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteDashTileAsync(int, RequestOptions)

Deletes the DashTile

```csharp theme={null}
public Task DeleteDashTileAsync(int dashTileId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the DashTile

`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)

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_DeleteDashTileDefinitionAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteDashTileDefinitionAsync(int, RequestOptions)

Deletes the DashTileDefinition

```csharp theme={null}
public Task DeleteDashTileDefinitionAsync(int dashTileDefinitionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the DashTileDefinition

`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)

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

Duplicate for the dashboard and all the sub elements

```csharp theme={null}
public Task<Dash> DuplicateDashboardAsync(int dashboardId, string name, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard to add the tile to

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

The name of the new dashboard

`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)\<[Dash](SuperOffice.WebApi.Data.Dash.md)\&gt;

New dashboard

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

Duplicate for the tile and all the sub elements

```csharp theme={null}
public Task<DashTile> DuplicateTileAsync(int dashTileId, string name, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the tile to copy

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

The name of the new tile

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

New tile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashAsync(int, RequestOptions)

Gets a specific Dash object.

```csharp theme={null}
public Task<Dash> GetDashAsync(int dashId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the Dash object

`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)\<[Dash](SuperOffice.WebApi.Data.Dash.md)\&gt;

Dash

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashCollectionAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashCollectionAsync(RequestOptions)

Gets a collection of dashboards for the current associate

```csharp theme={null}
public Task<DashCollection> GetDashCollectionAsync(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)\<[DashCollection](SuperOffice.WebApi.Data.DashCollection.md)\&gt;

Dashboard collection

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashListAsync\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashListAsync(int\[], RequestOptions)

Gets the ordered list of dashboards

```csharp theme={null}
public Task<Dash[]> GetDashListAsync(int[] dashboards, RequestOptions requestOptions = null)
```

#### Parameters

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

List of dashboardIds

`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)\<[Dash](SuperOffice.WebApi.Data.Dash.md)\[]\&gt;

List of dashboards

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashQuickFiltersAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashQuickFiltersAsync(int, RequestOptions)

Gets the quick filters for this dashboard

```csharp theme={null}
public Task<QuickFilterInfo[]> GetDashQuickFiltersAsync(int dashboardId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard to get the quick filters 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)\<[QuickFilterInfo](SuperOffice.WebApi.Data.QuickFilterInfo.md)\[]\&gt;

List of quick filters for the given dashboard

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashThemeAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashThemeAsync(int, RequestOptions)

Gets a specific DashTheme object.

```csharp theme={null}
public Task<DashTheme> GetDashThemeAsync(int dashThemeId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the DashTheme object

`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)\<[DashTheme](SuperOffice.WebApi.Data.DashTheme.md)\&gt;

DashTheme

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashTileAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashTileAsync(int, RequestOptions)

Gets a specific DashTile object.

```csharp theme={null}
public Task<DashTile> GetDashTileAsync(int dashTileId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the DashTile object

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

DashTile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashTileDefinitionAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashTileDefinitionAsync(int, RequestOptions)

Gets a specific DashTileDefinition object.

```csharp theme={null}
public Task<DashTileDefinition> GetDashTileDefinitionAsync(int dashTileDefinitionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the DashTileDefinition object

`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)\<[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)\&gt;

DashTileDefinition

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

Get HTML for a dashboard tile definition with TileType = HTML

```csharp theme={null}
public Task<DashTileHtml> GetDashTileHtmlAsync(int dashboardTileDefinitionId, string languageCode, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard tile definition

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

Preferred language code.

`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)\<[DashTileHtml](SuperOffice.WebApi.Data.DashTileHtml.md)\&gt;

HTML data

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashTileHtmlListAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashTileHtmlListAsync(int, RequestOptions)

Get HTML for a dashboard tile definition with TileType = HTML. Retrieve a list with all registered languages.

```csharp theme={null}
public Task<DashTileHtml[]> GetDashTileHtmlListAsync(int dashboardTileDefinitionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard tile definition

`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)\<[DashTileHtml](SuperOffice.WebApi.Data.DashTileHtml.md)\[]\&gt;

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashTilesAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashTilesAsync(int, RequestOptions)

Gets the ordered list of tiles for a dashboard

```csharp theme={null}
public Task<DashTile[]> GetDashTilesAsync(int dashboardId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\[]\&gt;

Ordered list of dashboard tiles

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetDashboardFencingInfoAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDashboardFencingInfoAsync(RequestOptions)

Get the current dashboard fencing status for the tenant

```csharp theme={null}
public Task<FencingInfo> GetDashboardFencingInfoAsync(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)\<[FencingInfo](SuperOffice.WebApi.Data.FencingInfo.md)\&gt;

Current fencing status including count, maximum, and warning state

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetPossibleDashQuickFiltersAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetPossibleDashQuickFiltersAsync(int, RequestOptions)

Gets the possible (not stored/selected) quick filters for this dashboard

```csharp theme={null}
public Task<QuickFilterInfo[]> GetPossibleDashQuickFiltersAsync(int dashboardId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard to get the possible quick filters 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)\<[QuickFilterInfo](SuperOffice.WebApi.Data.QuickFilterInfo.md)\[]\&gt;

List of possible quick filters for the given dashboard

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetPreviewDashAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetPreviewDashAsync(int, RequestOptions)

Get a dashboard from its id

```csharp theme={null}
public Task<PreviewDash> GetPreviewDashAsync(int dashboardId, RequestOptions requestOptions = null)
```

#### Parameters

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

Dashboard ID

`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)\<[PreviewDash](SuperOffice.WebApi.Data.PreviewDash.md)\&gt;

Dashboard suitable for preview

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetSecondaryTempTileSelectionAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSecondaryTempTileSelectionAsync(int, RequestOptions)

Copy selection to secondary temporary personal tile selection

```csharp theme={null}
public Task<int> GetSecondaryTempTileSelectionAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy 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)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Selection Id

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_GetTempTileSelectionAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetTempTileSelectionAsync(int, RequestOptions)

Copy selection to temporary personal tile selection

```csharp theme={null}
public Task<int> GetTempTileSelectionAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy 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)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Selection Id

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashAsync\_SuperOffice\_WebApi\_Data\_Dash\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashAsync(Dash, RequestOptions)

Updates the existing Dash or creates a new Dash if the id parameter is 0.

```csharp theme={null}
public Task<Dash> SaveDashAsync(Dash dash, RequestOptions requestOptions = null)
```

#### Parameters

`dash` [Dash](SuperOffice.WebApi.Data.Dash.md)

The Dash that is saved.

`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)\<[Dash](SuperOffice.WebApi.Data.Dash.md)\&gt;

New or updated Dash

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashQuickFiltersAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_QuickFilterInfo\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashQuickFiltersAsync(int, QuickFilterInfo\[], RequestOptions)

Saves the quick filters for this dashboard

```csharp theme={null}
public Task<QuickFilterInfo[]> SaveDashQuickFiltersAsync(int dashboardId, QuickFilterInfo[] quickFilters, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard these quick filters are associated with

`quickFilters` [QuickFilterInfo](SuperOffice.WebApi.Data.QuickFilterInfo.md)\[]

Complete list of quick filters for the given dashboard, overwriting the existing list

`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)\<[QuickFilterInfo](SuperOffice.WebApi.Data.QuickFilterInfo.md)\[]\&gt;

List of saved quick filters for the given dashboard

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashThemeAsync\_SuperOffice\_WebApi\_Data\_DashTheme\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashThemeAsync(DashTheme, RequestOptions)

Updates the existing DashTheme or creates a new DashTheme if the id parameter is 0.

```csharp theme={null}
public Task<DashTheme> SaveDashThemeAsync(DashTheme dashTheme, RequestOptions requestOptions = null)
```

#### Parameters

`dashTheme` [DashTheme](SuperOffice.WebApi.Data.DashTheme.md)

The DashTheme that is saved.

`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)\<[DashTheme](SuperOffice.WebApi.Data.DashTheme.md)\&gt;

New or updated DashTheme

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashTileAsync\_SuperOffice\_WebApi\_Data\_DashTile\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashTileAsync(DashTile, RequestOptions)

Updates the existing DashTile or creates a new DashTile if the id parameter is 0.

```csharp theme={null}
public Task<DashTile> SaveDashTileAsync(DashTile dashTile, RequestOptions requestOptions = null)
```

#### Parameters

`dashTile` [DashTile](SuperOffice.WebApi.Data.DashTile.md)

The DashTile that is saved.

`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)\<[DashTile](SuperOffice.WebApi.Data.DashTile.md)\&gt;

New or updated DashTile

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashTileDefinitionAsync\_SuperOffice\_WebApi\_Data\_DashTileDefinition\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashTileDefinitionAsync(DashTileDefinition, RequestOptions)

Updates the existing DashTileDefinition or creates a new DashTileDefinition if the id parameter is 0.

```csharp theme={null}
public Task<DashTileDefinition> SaveDashTileDefinitionAsync(DashTileDefinition dashTileDefinition, RequestOptions requestOptions = null)
```

#### Parameters

`dashTileDefinition` [DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)

The DashTileDefinition that is saved.

`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)\<[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)\&gt;

New or updated DashTileDefinition

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashTileHtmlListAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_DashTileHtml\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashTileHtmlListAsync(int, DashTileHtml\[], RequestOptions)

Set the HTML data for a tile with TileType = HTML.

```csharp theme={null}
public Task<DashTileHtml[]> SaveDashTileHtmlListAsync(int dashboardTileDefinitionId, DashTileHtml[] languages, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard tile definition

`languages` [DashTileHtml](SuperOffice.WebApi.Data.DashTileHtml.md)\[]

List of HTML content per language

`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)\<[DashTileHtml](SuperOffice.WebApi.Data.DashTileHtml.md)\[]\&gt;

### \<a id="SuperOffice\_WebApi\_Agents\_DashAgent\_SaveDashTilesAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_DashTile\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDashTilesAsync(int, DashTile\[], RequestOptions)

Saves the ordered list of tiles for a dashboard

```csharp theme={null}
public Task SaveDashTilesAsync(int dashboardId, DashTile[] dashTiles, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the dashboard

`dashTiles` [DashTile](SuperOffice.WebApi.Data.DashTile.md)\[]

The tiles in order

`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)