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

# \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent">\</a> Interface ISaintAgent

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

Administration and maintenance of SAINT counters and statuses

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

#### Implements

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

## Methods

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_CreateDefaultSaintConfigurationAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultSaintConfigurationAsync(RequestOptions)

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

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

A blank SaintConfiguration

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_CreateDefaultStatusMonitorAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultStatusMonitorAsync(RequestOptions)

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

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

A blank StatusMonitor

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_CreateDefaultStatusMonitorPeriodsAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultStatusMonitorPeriodsAsync(RequestOptions)

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

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

A blank StatusMonitorPeriods

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_GetSaintConfigurationsAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSaintConfigurationsAsync(RequestOptions)

Returns the StatusMonitorPeriods entity.

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

The SaintConfiguration for all entities

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_GetStatusMonitorAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetStatusMonitorAsync(int, RequestOptions)

Get a single status monitor based on its identity

```csharp theme={null}
Task<StatusMonitor> GetStatusMonitorAsync(int id, RequestOptions requestOptions = null)
```

#### Parameters

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

Identity of status monitor

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

The requested status monitor

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_GetStatusMonitorPeriodsAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetStatusMonitorPeriodsAsync(RequestOptions)

Returns the StatusMonitorPeriods entity.

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

The StatusMonitorEntity

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

Get all active status monitors for a specified target

```csharp theme={null}
Task<StatusMonitor[]> GetStatusMonitorsAsync(int id, string type, RequestOptions requestOptions = null)
```

#### Parameters

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

Identity of target type(contact identity, project identity etc.)

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

Type to get status monitors for("contact", "project", etc.)

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

Active status monitors

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_RegenerateCountersAsync\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RegenerateCountersAsync(bool, RequestOptions)

Regenerate the Saint counters - this can take several minutes

```csharp theme={null}
Task<BatchTaskInfo> RegenerateCountersAsync(bool runAsBatch, RequestOptions requestOptions = null)
```

#### Parameters

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

If true, then execute the regeneration as a Batch Task; the service call will return immediately. Otherwise wait until the task completes, may cause a timeout if called as a Web Service

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

Information about the batch task, if batch execution was requested. Otherwise null

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_RegenerateStatusMonitorAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RegenerateStatusMonitorAsync(int, RequestOptions)

Regenerate the given status monitor

```csharp theme={null}
Task RegenerateStatusMonitorAsync(int statusMonitorId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the statusmonitor to regenerate

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

This method has no return value

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_RegenerateStatusMonitorsAsync\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RegenerateStatusMonitorsAsync(bool, RequestOptions)

Regenerate status monitors

```csharp theme={null}
Task<BatchTaskInfo> RegenerateStatusMonitorsAsync(bool runAsBatch, RequestOptions requestOptions = null)
```

#### Parameters

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

If true, then execute the regeneration as a Batch Task; the service call will return immediately. Otherwise wait until the task completes, may cause a timeout if called as a Web Service

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

Information about the batch task, if batch execution was requested. Otherwise null

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_SaveSaintConfigurationAsync\_SuperOffice\_WebApi\_Data\_SaintConfiguration\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveSaintConfigurationAsync(SaintConfiguration, RequestOptions)

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

```csharp theme={null}
Task<SaintConfiguration> SaveSaintConfigurationAsync(SaintConfiguration saintConfiguration, RequestOptions requestOptions = null)
```

#### Parameters

`saintConfiguration` [SaintConfiguration](SuperOffice.WebApi.Data.SaintConfiguration.md)

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

New or updated SaintConfiguration

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_SaveStatusMonitorAsync\_SuperOffice\_WebApi\_Data\_StatusMonitor\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveStatusMonitorAsync(StatusMonitor, RequestOptions)

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

```csharp theme={null}
Task<StatusMonitor> SaveStatusMonitorAsync(StatusMonitor statusMonitor, RequestOptions requestOptions = null)
```

#### Parameters

`statusMonitor` [StatusMonitor](SuperOffice.WebApi.Data.StatusMonitor.md)

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

New or updated StatusMonitor

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_SaveStatusMonitorPeriodsAsync\_SuperOffice\_WebApi\_Data\_StatusMonitorPeriods\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveStatusMonitorPeriodsAsync(StatusMonitorPeriods, RequestOptions)

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

```csharp theme={null}
Task<StatusMonitorPeriods> SaveStatusMonitorPeriodsAsync(StatusMonitorPeriods statusMonitorPeriods, RequestOptions requestOptions = null)
```

#### Parameters

`statusMonitorPeriods` [StatusMonitorPeriods](SuperOffice.WebApi.Data.StatusMonitorPeriods.md)

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

New or updated StatusMonitorPeriods

### \<a id="SuperOffice\_WebApi\_Agents\_ISaintAgent\_SetRankOnStatusMonitorsAsync\_System\_String\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetRankOnStatusMonitorsAsync(string, int\[], RequestOptions)

Set rank order on status monitors

```csharp theme={null}
Task SetRankOnStatusMonitorsAsync(string type, int[] itemsIds, RequestOptions requestOptions = null)
```

#### Parameters

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

Type of status monitors to reorder ("contact", "project", etc.)

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

The ids of the items in the order you want

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

This method has no return value


## Related topics

- [SuperOffice.WebApi.Agents.SaintAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.SaintAgent.md)
- [SuperOffice.WebApi.Data.SaintConfiguration](/en/api/reference/webapi/SuperOffice.WebApi.Data.SaintConfiguration.md)
- [SuperOffice.WebApi.Agents](/en/api/reference/webapi/SuperOffice.WebApi.Agents.md)
- [SuperOffice.WebApi.Data.StatusMonitor](/en/api/reference/webapi/SuperOffice.WebApi.Data.StatusMonitor.md)
- [SuperOffice.WebApi.Data.StatusMonitorPeriods](/en/api/reference/webapi/SuperOffice.WebApi.Data.StatusMonitorPeriods.md)
- [SuperOffice.WebApi.Agents.AgentBase](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AgentBase.md)