ModelingHierarchy

Hierarchy definition in the model. A hierarchy is defined by a list of levels, each defined by a column

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

hierarchyId

The hierarchy's System ID

-

string

uuid

levels

The hierarchy levels

-

ModelingHierarchyLevel []

displayName

The hierarchy's Display Name

-

string

uniqueName

The hierarchy's Unique identifier

-

string

displayFolder

The hierarchy's display folder name

-

string

description

The hierarchy's description

-

string

isAggregatable

Is it possible to aggregate by this hierarchy

-

boolean

hasDefaultMember

Does this hierarchy have a default member

-

boolean

hierarchyType

The hierarchy's type

-

HierarchyType

hierarchyCategory

Predefined hierarchy category

-

HierarchyCategory

parentKeySourceColumnUniqueName

Parent-Child hierarchy's parent column

-

string

keySourceColumnUniqueName

Parent-Child hierarchy's key column

-

string

orderSourceColumnUniqueName

Parent-Child hierarchy's order column

-

string

captionSourceColumnUniqueName

Parent-Child hierarchy's caption column

-

string

unaryOperatorSourceColumnUniqueName

Parent-Child hierarchy's unary-operator column

-

string

parentChildRollupType

Parent-Child hierarchy's rollup type

-

ParentChildRollupType

parentChildOrphanHandlingType

Parent-Child hierarchy's handling for orphan nodes

-

ParentChildOrphanHandlingType

orderColumnUniqueNameOrNullIfSelf

-

string

captionColumnUniqueNameOrNullIfSelf

-

string

startingLevel

-

integer

int32