Flexible Hierarchies

Use the Flexible Hierarchy APIs to get the root records that match a relationship graph definition, create or update hierarchies by applying rules, monitor rule-based generation jobs, check whether hierarchies are in sync, get hierarchy snapshots, and validate multiple hierarchies asynchronously.

Flexible Hierarchy Bulk Validation (POST)
Validate multiple flexible hierarchies asynchronously by providing a list of IDs, applying filter criteria, or selecting all draft hierarchies.
Flexible Hierarchy Records (GET)
Search the org for records of a specified object type whose name matches your search text, scoped to the configuration of a relationship graph definition. Use this API to find any record that you can add as a node to a flexible hierarchy. Unlike the node search, this API searches all records of the specified object and works in orgs that have probabilistic encryption enabled on the name field.
Flexible Hierarchy Root Records (GET)
Get the records that match the root filter defined in a relationship graph definition. Use this API to preview the records that are eligible for rule-based hierarchy creation before starting a hierarchy generation job.
Flexible Hierarchy Apply Rules (POST)
Create new flexible hierarchies or update existing hierarchies asynchronously by applying the rules defined in a relationship graph definition. Use the operationMode parameter to create hierarchies for matching root records or to re-apply the rules so that existing hierarchies stay in sync with the source data. This API runs asynchronously and returns an ID to track the request.
Flexible Hierarchy Job Runs (GET)
Get a paginated list of job runs for the org's rule-based hierarchy generation jobs.
Flexible Hierarchy Job Run by ID (GET, DELETE)
Get the details of a rule-based hierarchy generation job run or delete a job run by job run ID.
Flexible Hierarchy Job Run Items (GET)
Get a paginated list of job run items that are associated with a job run. Use this API to review which root records succeeded or failed and to inspect error messages for failures.
Flexible Hierarchy Job Run Item by ID (GET)
Get the details of a job run item by item ID.
Flexible Hierarchy Check Synchronization (POST)
Evaluate whether one or more rule-based flexible hierarchies are synchronized with their source data. This API runs asynchronously and returns a request ID that you can use to track the evaluation through the job run and job run item resources.
Flexible Hierarchy Snapshots (GET)
Get a paginated list of snapshots for a specific flexible hierarchy. Each snapshot represents the hierarchy's structure as it existed when it was captured, and includes metadata such as the captured date, version number, and node count.
Flexible Hierarchy Snapshot by Version (GET)
Get a single snapshot version of a flexible hierarchy, including its captured nodes and relationships. Use this API to load the full tree for a specific version selected from the snapshot history.
Flexible Hierarchy Snapshot Search (GET)
Search the nodes in a specific flexible hierarchy snapshot version to find the nodes by display name, optionally filtered by object type.