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

# <a id="SuperOffice_WebApi_Data_ForeignKey" /> Class ForeignKey

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

Carrier object for ForeignKey.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[ForeignKey](SuperOffice.WebApi.Data.ForeignKey.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)

## Constructors

### <a id="SuperOffice_WebApi_Data_ForeignKey__ctor" /> ForeignKey()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_ForeignKey_CreatedBy" /> CreatedBy

Name of the person that created the foreign key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_CreatedDate" /> CreatedDate

Registered when

```csharp theme={null}
public virtual DateTime CreatedDate { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_Key" /> Key

Subkey (optional)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_RecordId" /> RecordId

Record in the referenced table

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_TableName" /> TableName

Table name, transformed to and from numeric table id by the service layer

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_UpdatedBy" /> UpdatedBy

Name of the person that last updated the foreign key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_UpdatedDate" /> UpdatedDate

Last updated when

```csharp theme={null}
public virtual DateTime UpdatedDate { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ForeignKey_Value" /> Value

Key value

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.ForeignSystem AddForeignKeyRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignSystem_AddForeignKeyRequest.md)
- [SuperOffice.WebApi.Data.ForeignSystem SaveForeignKeyRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignSystem_SaveForeignKeyRequest.md)
- [SuperOffice.WebApi.Data.ForeignSystem DeleteForeignKeyRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignSystem_DeleteForeignKeyRequest.md)
- [SuperOffice.WebApi.Agents.ForeignSystemAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ForeignSystemAgent.md)
- [SuperOffice.WebApi.Agents.IForeignSystemAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IForeignSystemAgent.md)
- [SuperOffice.WebApi.Data.ForeignAppEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignAppEntity.md)