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

# <a id="SuperOffice_WebApi_Data_FieldMetadata" /> Class FieldMetadata

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

Carrier object for FieldMetadata.
This is used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields

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

#### Inheritance

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

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_FieldMetadata_Access" /> Access

Access restrictions on the field
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public FieldAccess? Access { get; set; }
```

#### Property Value

[FieldAccess](SuperOffice.WebApi.Data.FieldAccess.md)?

#### See Also

[FieldMetadata](SuperOffice.WebApi.Data.FieldMetadata.md).[Access\_String](SuperOffice.WebApi.Data.FieldMetadata.md#SuperOffice_WebApi_Data_FieldMetadata_Access_String)

### <a id="SuperOffice_WebApi_Data_FieldMetadata_Access_String" /> Access\_String

Access restrictions on the field
Raw string enum value.

```csharp theme={null}
[JsonProperty("Access")]
public string Access_String { get; set; }
```

#### Property Value

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

#### See Also

[FieldMetadata](SuperOffice.WebApi.Data.FieldMetadata.md).[Access](SuperOffice.WebApi.Data.FieldMetadata.md#SuperOffice_WebApi_Data_FieldMetadata_Access)

### <a id="SuperOffice_WebApi_Data_FieldMetadata_DefaultValue" /> DefaultValue

A default value for the field.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldMetadata_DisplayDescription" /> DisplayDescription

Tooltip for the field name.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldMetadata_DisplayName" /> DisplayName

Localized field name – shown in the GUI

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldMetadata_FieldKey" /> FieldKey

Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldMetadata_FieldType" /> FieldType

String, int, decimal, etc.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public FieldMetadataType? FieldType { get; set; }
```

#### Property Value

[FieldMetadataType](SuperOffice.WebApi.Data.FieldMetadataType.md)?

#### See Also

[FieldMetadata](SuperOffice.WebApi.Data.FieldMetadata.md).[FieldType\_String](SuperOffice.WebApi.Data.FieldMetadata.md#SuperOffice_WebApi_Data_FieldMetadata_FieldType_String)

### <a id="SuperOffice_WebApi_Data_FieldMetadata_FieldType_String" /> FieldType\_String

String, int, decimal, etc.
Raw string enum value.

```csharp theme={null}
[JsonProperty("FieldType")]
public string FieldType_String { get; set; }
```

#### Property Value

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

#### See Also

[FieldMetadata](SuperOffice.WebApi.Data.FieldMetadata.md).[FieldType](SuperOffice.WebApi.Data.FieldMetadata.md#SuperOffice_WebApi_Data_FieldMetadata_FieldType)

### <a id="SuperOffice_WebApi_Data_FieldMetadata_ListName" /> ListName

MDO List provider name for list fields

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldMetadata_MaxLength" /> MaxLength

Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.)

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

#### Property Value

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

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

A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FieldMetadata_ShowInSearch" /> ShowInSearch

True if this field is displayed in search result

```csharp theme={null}
public virtual bool ShowInSearch { get; set; }
```

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.FieldMetadataDictionary](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldMetadataDictionary.md)
- [SuperOffice.WebApi.Data.FieldMetadataType](/en/api/reference/webapi/SuperOffice.WebApi.Data.FieldMetadataType.md)
- [SuperOffice.WebApi.Data.ErpConnectionData](/en/api/reference/webapi/SuperOffice.WebApi.Data.ErpConnectionData.md)
- [SuperOffice.WebApi.Agents.ErpSyncAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ErpSyncAgent.md)
- [SuperOffice.WebApi.Agents.IErpSyncAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IErpSyncAgent.md)
- [SuperOffice.WebApi.Data.CustomObjectMetadata](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObjectMetadata.md)