> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.History

# <a id="SuperOffice_WebApi_Data_History" /> Class History

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

Carrier object for History.
The usage history of the currently logged in user is represented as History objects.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[History](SuperOffice.WebApi.Data.History.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get History 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ViewStateAgent(configuration);
var history = agent.GetHistory( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_History__ctor" /> History()

Default constructor - defaults any enum props to 0.

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

## Properties

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

Owner of history list

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_History_HistoryId" /> HistoryId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_History_HistoryName" /> HistoryName

The name of the history list, for instance contact. Represents the history table's TableId field

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

#### Property Value

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

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

Id of the history item, for instance a contact id. Represents the history table's RecordId field, if the item is based on a history table record

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_History_ItemInfo" /> ItemInfo

Extra information on the history item, e.g. The Associate Type for an associate or other relevant info.

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

#### Property Value

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

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

Name of the history item, for instance contact name

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_History_Rank" /> Rank

Sort order, indexed so it can used for sorting in the query

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.HistoryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.HistoryRequest.md)
- [SuperOffice.WebApi.Data.TargetRevisionHistory](/en/api/reference/webapi/SuperOffice.WebApi.Data.TargetRevisionHistory.md)
- [SuperOffice.WebApi.Data.MDO GetListWithHistoryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.MDO_GetListWithHistoryRequest.md)
- [SuperOffice.WebApi.Data.ViewState SaveHistoriesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ViewState_SaveHistoriesRequest.md)
- [SuperOffice.WebApi.Data.Targets GetTargetRevisionHistoryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Targets_GetTargetRevisionHistoryRequest.md)
- [SuperOffice.WebApi.Data.ViewState GetHistoriesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ViewState_GetHistoriesRequest.md)