Output representation of the captured structure of a flexible hierarchy snapshot,
lazily loaded one context node at a time.
JSON Example
{
"contextNode": {
"id": "0HNxx0000004N02EAM",
"predecessorNodeId": "0HNxx0000004N01EAM",
"referenceRecordId": "001xx000003GZ40AAG",
"referenceRecordType": "Account",
"referenceRecordTypeLabel": "Account",
"role": "Region",
"totalChildrenCount": 4,
"displayValues": [
{
"fieldName": "Name",
"fieldLabel": "Account Name",
"fieldType": "String",
"fieldValue": "EMEA Region",
"isLookup": false,
"isNameField": true
}
],
"summaryValues": []
},
"ancestorNodes": [
{
"id": "0HNxx0000004N01EAM",
"referenceRecordId": "001xx000003GZ39AAG",
"referenceRecordType": "Account",
"referenceRecordTypeLabel": "Account",
"role": "Root",
"totalChildrenCount": 2,
"displayValues": [],
"summaryValues": []
}
],
"ancestorRelations": [
{
"id": "0HRxx0000004R01EAM",
"predecessorNodeId": "0HNxx0000004N01EAM",
"successorNodeId": "0HNxx0000004N02EAM",
"displayValues": []
}
],
"childNodes": [
{
"id": "0HNxx0000004N03EAM",
"predecessorNodeId": "0HNxx0000004N02EAM",
"referenceRecordId": "001xx000003GZ41AAG",
"referenceRecordType": "Account",
"referenceRecordTypeLabel": "Account",
"role": "Country",
"totalChildrenCount": 0,
"displayValues": [],
"summaryValues": []
}
],
"childRelations": [
{
"id": "0HRxx0000004R02EAM",
"predecessorNodeId": "0HNxx0000004N02EAM",
"successorNodeId": "0HNxx0000004N03EAM",
"displayValues": []
}
],
"pathToRoot": [
"0HNxx0000004N02EAM",
"0HNxx0000004N01EAM"
],
"pagination": {
"hasNext": false,
"offset": 0,
"pageSize": 1000,
"totalChildNodes": 4
},
"hierarchyConfiguration": {
"id": "0RGDxx0000004GD1EAM",
"relationshipGraphDefinitionVersion": "1",
"entityDisplayFields": [
{
"entityName": "Account",
"entityLabel": "Account",
"graphViewFields": [
"Name"
],
"gridViewFields": [
"Name"
]
}
],
"relationshipList": [
{
"parentNodeEntityApiName": "Account",
"childNodeEntityApiName": "Account"
}
],
"summaryRollupList": []
},
"snapshotMetadata": {
"hierarchyId": "0H1xx0000004FH1EAM",
"capturedAt": "2026-07-20T08:27:26.000Z",
"locale": "en_US",
"navigationPolicy": "Standard",
"schemaVersion": 1,
"totalNodes": 16,
"totalRelationshipCount": 15,
"captureContext": {
"accessModel": "reResolveInUserContext",
"runAsIntegrationUser": false
}
},
"responseStatus": {
"statusCode": 200,
"message": "Snapshot retrieved."
}
}
Properties
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| ancestorNodes | Flexible Hierarchy Snapshot Node Details[] | Context node's ancestor nodes, ordered from the immediate parent up to the root. | Big, 68.0 | 68.0 |
| ancestorRelations | Flexible Hierarchy Snapshot Relationship Details[] | Parent-child connections along the ancestor chain. | Big, 68.0 | 68.0 |
| childNodes | Flexible Hierarchy Snapshot Node Details[] | Paginated list of the context node's direct children. | Big, 68.0 | 68.0 |
| childRelations | Flexible Hierarchy Snapshot Relationship Details[] | Parent-child connections from the context node to the returned child nodes. | Big, 68.0 | 68.0 |
| contextNode | Flexible Hierarchy Snapshot Node Details | Node that's specified in the request. This is the node identified by nodeId, or the snapshot's root node when nodeId isn't specified. | Big, 68.0 | 68.0 |
| hierarchyConfiguration | Flexible Hierarchy Snapshot Hierarchy Configuration Details | Frozen configuration for the snapshot, including entity display fields, relationships, and rollup definitions. | Big, 68.0 | 68.0 |
| pagination | Flexible Hierarchy Pagination Details | Pagination details for the childNodes array. | Big, 68.0 | 68.0 |
| pathToRoot | String[] | Node IDs from the context node up to the root, inclusive, ordered with the context node first. | Big, 68.0 | 68.0 |
| responseStatus | Flexible Hierarchy Status | HTTP status code and message for the API request. | Big, 68.0 | 68.0 |
| snapshotMetadata | Flexible Hierarchy Snapshot Metadata Details | Metadata about the snapshot, including capture time, schema version, and provenance. | Big, 68.0 | 68.0 |