Class MasterDataHierarchyDetail

Namespace

BiExcellence.OpenBi.Api.MasterData

Assembly

BiExcellence.OpenBi.Api.Client.dll

A hierarchy defined over a master data object, including its full node tree (flat list; each node references its parent by ParentId). Used as both the request and response body.

public sealed record MasterDataHierarchyDetail : IMasterDataHierarchyDetail

Inheritance

object

MasterDataHierarchyDetail

Implements

IMasterDataHierarchyDetail

Properties

Caption

The display text of the hierarchy. On a write, an empty caption is replaced by HierarchyName.

[JsonPropertyName("caption")]
public string? Caption { get; init; }

Property Value

string

HierarchyName

The technical name of the hierarchy, unique per master data object - the hierarchyName of GetHierarchyAsync(IOpenBiApiClient, string, string, CancellationToken).

[JsonPropertyName("hierarchyName")]
public string? HierarchyName { get; init; }

Property Value

string

Nodes

Every node of the hierarchy as a flat list; ParentId links each node to its parent.

[JsonPropertyName("nodes")]
public MasterDataHierarchyNode[]? Nodes { get; init; }

Property Value

MasterDataHierarchyNode[]