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

# <a id="SuperOffice_WebApi_Data_CustomObjectDefinition" /> Class CustomObjectDefinition

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

Carrier object for CustomObjectDefinition.
Schema definition for a Custom Object: the underlying table and its fields.

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

#### Inheritance

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

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_CustomObjectDefinition_Description" /> Description

Description of the Custom Object.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectDefinition_DisplayField" /> DisplayField

Name of the field used to represent a row in lists and previews.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectDefinition_Fields" /> Fields

Field definitions for this Custom Object.

```csharp theme={null}
public virtual CustomObjectField[] Fields { get; set; }
```

#### Property Value

[CustomObjectField](SuperOffice.WebApi.Data.CustomObjectField.md)\[]

### <a id="SuperOffice_WebApi_Data_CustomObjectDefinition_Flags" /> Flags

Bitmask of ExtraTableFlag values.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomObjectDefinition_IconId" /> IconId

Icon binary-object id used in the UI.

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

#### Property Value

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

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

Primary key in the extra-tables table.

```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_CustomObjectDefinition_Name" /> Name

Database table name of the Custom Object, e.g. 'y\_equipment'.

```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_CustomObjectDefinition_Title" /> Title

User-visible title of the Custom Object.

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.CustomObjectAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.CustomObjectAgent.md)
- [SuperOffice.WebApi.Agents.ICustomObjectAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ICustomObjectAgent.md)
- [SuperOffice.WebApi.Data.CustomObject GetCustomObjectDefinitionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject_GetCustomObjectDefinitionRequest.md)
- [SuperOffice.WebApi.Data.CustomObject](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject.md)
- [SuperOffice.WebApi.Data.CustomObjectField](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObjectField.md)
- [SuperOffice.WebApi.Data.CustomObject SaveCustomObjectRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomObject_SaveCustomObjectRequest.md)