Hierarchy management APIs
Learn about the hierarchy management APIs used to create and manage hierarchies.
The Hierarchy management APIs provide access to node based hierarchy data in Reltio. It lets you retrieve hierarchy views, search hierarchy members, manage parent-child connections, work with hierarchies and hierarchy versions, and import hierarchy data in bulk.
Hierarchy management APIs complement the hierarchy experience in the Profile view. While the UI helps business users explore and manage hierarchies interactively, these APIs provide a programmatic way to retrieve the same structures and apply controlled changes at scale.
Who are Hierarchy Management APIs for?
This content is curated for these Reltio user roles defined in topic About roles:
Developer
Reltio Configurator
System Administrator
What you can do with these APIs
Hierarchy management APIs support the following use cases:
- retrieve the hierarchy position of an object
- return all available paths from an object to its roots
- list direct parents or children in a hierarchy instance
- search hierarchy members by label
- create or update hierarchy connections with effective dates
- identify which hierarchies or versions include a specific object
- create new hierarchies and hierarchy versions
- clone an existing hierarchy, version, or instance
- delete hierarchy connections, hierarchies, or hierarchy versions
- import hierarchy data in bulk from supported file formats
Why these APIs matter
Hierarchy data can change over time and can exist in multiple versions. These APIs give you a consistent way to retrieve hierarchy state for a specific date, manage hierarchy structures, and automate hierarchy maintenance without relying on manual UI actions.
List of APIs
The following table lists the hierarchy management APIs and describes the purpose of each API.
| API | Purpose |
|---|---|
| Get hierarchy view for an object | Returns one path from the requested object to a root in a hierarchy instance. |
| Get hierarchy paths for an object | Returns all available root paths for the requested object in a hierarchy instance. |
| Returns a flat list of child objects for the requested object. | |
| List parent objects in a hierarchy instance | Returns a flat list of parent objects for the requested object. |
| Search hierarchy labels in a hierarchy instance | Returns matching objects and their label paths in a hierarchy instance. |
| Get a hierarchy connection by ID | Returns the definition of a hierarchy connection. |
| Create hierarchy connections | Creates one or more hierarchy connections in a hierarchy instance. |
| Delete hierarchy connections | Deletes one or more hierarchy connections. |
| List hierarchy instances for an object | Returns the hierarchy instances in which an object participates. |
| List hierarchies for an object | Returns the hierarchies in which an object participates, without version details. |
| List hierarchy versions for an object | Returns the versions of a hierarchy in which an object participates. |
| Get a hierarchy by ID | Returns hierarchy metadata. |
| List hierarchy versions | Returns all versions for a hierarchy. |
| Get a hierarchy version by ID | Returns metadata for a single hierarchy version. |
| Get a hierarchy instance by ID | Returns metadata for a hierarchy instance. |
| Create a hierarchy | Creates a hierarchy and, optionally, its first version and first connection. |
| Create a hierarchy version | Creates a hierarchy version and, optionally, its first connection. |
| Clone an unversioned hierarchy instance | Creates a new hierarchy by cloning an existing hierarchy. |
| Clone a hierarchy version | Creates a new hierarchy version by cloning an existing hierarchy version. |
| Clone a versioned hierarchy instance | Creates a new hierarchy by cloning an existing hierarchy instance. |
| Update a hierarchy by ID | Updates hierarchy metadata. |
| Update a hierarchy version by ID | Updates hierarchy version metadata. |
| Delete a hierarchy by ID | Deletes a hierarchy. |
| Delete a hierarchy version by ID | Deletes a hierarchy version. |
| Import a hierarchy | Imports hierarchy data from a CSV or JSON file. |