Hierarchy.md

Hierarchy Vocabulary

Namespace: com.sap.vocabularies.Hierarchy.v1

Terms for Hierarchies

Terms

Term	Type	Description
RecursiveHierarchy (Experimental)	RecursiveHierarchyType?	Defines a recursive hierarchy.

RecursiveHierarchyType (Experimental)

Property	Type	Description
ParentNodeProperty	PropertyPath	Property holding the parent hierarchy node value
ExternalKeyProperty	PropertyPath	Property holding the external key value for a node
ValueProperty	PropertyPath?	Property for whose values the hierarchy is defined
DescendantCountProperty	PropertyPath?	Property holding the number of descendants of a node The descendant count of a node is the number of its descendants in the hierarchy structure of the result considering only those nodes matching any specified $filter and $search. A property holding descendant counts has an integer data type.
DrillStateProperty	PropertyPath?	Property holding the drill state of a node The drill state is indicated by one of the following string values: collapsed, expanded, leaf. For an expanded node, its children are included in the result collection. For a collapsed node, the children are included in the entity set, but they are not part of the result collection. Retrieving them requires a relaxed filter expression or a separate request filtering on the parent node ID with the ID of the collapsed node. A leaf does not have any child in the entity set.
SiblingRankProperty	PropertyPath?	Property holding the sibling rank of a node The sibling rank of a node is the index of the node in the sequence of all nodes with the same parent created by preorder traversal of the hierarchy structure after evaluating the $filter expression in the request excluding any conditions on key properties. The first sibling is at position 0.
PreorderRankProperty	PropertyPath?	Property holding the preorder rank of a node The preorder rank of a node expresses its position in the sequence of nodes created from preorder traversal of the hierarchy structure after evaluating the $filter expression in the request excluding any conditions on key properties. The first node in preorder traversal has rank 0.