Skip to main content
Version: Next

listHierarchyNodesByTags

GET 

/hierarchies/:hierarchyId/hierarchy-nodes/by-tags

Returns a flat paginated list of HierarchyNode objects belonging to the given hierarchy, derived from nodes that match the provided tag IDs and traversed according to the direction parameter.

The service operates in two phases:

  1. Tag matching — all nodes in hierarchyId that have at least one of the tag IDs in filter[tagIds] are identified as starting points.
  2. Traversal — from each starting point, the hierarchy is traversed according to direction:
    • Down — includes the matched nodes and all their descendants (recursively).
    • Up — includes the matched nodes and all their ancestors up to the root.
    • Full — includes the matched nodes plus both their ancestors and descendants.

The result is a deduplicated flat list. The tag-matched nodes are always included in the result.

To access the service you need at least one of the following permissions:

Permission (one of)
listHierarchies

Request

Responses

HierarchyNode list response.