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

# <a id="SuperOffice_WebApi_Data_HierarchyEntity" /> Class HierarchyEntity

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

Carrier object for HierarchyEntity.
Folder structures

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[HierarchyEntity](SuperOffice.WebApi.Data.HierarchyEntity.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 HierarchyEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var hierarchyEntity = agent.GetHierarchyEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_HierarchyEntity__ctor" /> HierarchyEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_Children" /> Children

Sub-items, if any.

```csharp theme={null}
public virtual HierarchyEntity[] Children { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_Domain" /> Domain

Domain seperating the different hierarchy
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[HierarchyEntity](SuperOffice.WebApi.Data.HierarchyEntity.md).[Domain\_String](SuperOffice.WebApi.Data.HierarchyEntity.md#SuperOffice_WebApi_Data_HierarchyEntity_Domain_String)

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_Domain_String" /> Domain\_String

Domain seperating the different hierarchy
Raw string enum value.

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

#### Property Value

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

#### See Also

[HierarchyEntity](SuperOffice.WebApi.Data.HierarchyEntity.md).[Domain](SuperOffice.WebApi.Data.HierarchyEntity.md#SuperOffice_WebApi_Data_HierarchyEntity_Domain)

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_Fullname" /> Fullname

The full name of this category, i.e. Foo/bar/test.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_HierarchyId" /> HierarchyId

The primary key (auto-incremented)

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

#### Property Value

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

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

Name of this hierarchy folder.

```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_HierarchyEntity_ParentId" /> ParentId

Parent table

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_Registered" /> Registered

Registered when

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_RegisteredAssociateId" /> RegisteredAssociateId

Registered by whom

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_Updated" /> Updated

Last updated when

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_HierarchyEntity_UpdatedAssociateId" /> UpdatedAssociateId

Last updated by whom

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Data.List UpdateHierarchyFromPathRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_UpdateHierarchyFromPathRequest.md)
- [SuperOffice.WebApi.Data.EmailFlow](/en/api/reference/webapi/SuperOffice.WebApi.Data.EmailFlow.md)
- [SuperOffice.WebApi.Data.CRMScriptEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.CRMScriptEntity.md)
- [SuperOffice.WebApi.Data.List AddHierarchyToPathRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_AddHierarchyToPathRequest.md)