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.
The response is centered on one captured node. Specify nodeId to load that node. If you don't specify nodeId, the snapshot's root node is used. Pagination and sort parameters apply to that node's direct children.
Resource
/connect/flexible-hierarchies/hierarchyId/snapshots/versionNumber
Resource Example
https://yourInstance.salesforce.com/services/data/v68.0/connect/flexible-hierarchies/0H1xx0000004FH1EAM/snapshots/3
Available Version
68.0
HTTP Methods
GET
Path Parameters for GET
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| hierarchyId | String | ID of the flexible hierarchy associated with the snapshot. | Required | 68.0 |
| versionNumber | String | Version number of the snapshot to get the snapshot details for. Specify a positive integer. | Required | 68.0 |
Query Parameters for GET
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| nodeId | String | ID of the captured node to center the response on. If not specified, the snapshot's root node is used. | Optional | 68.0 |
| offset | Integer | Number of snapshot nodes to skip before returning results. The default value is 0. | Optional | 68.0 |
| pageSize | Integer | Maximum number of snapshot nodes to return on a page. Specify a value from 1 through 10,000. The default value is 1000. | Optional | 68.0 |
| sortField | String | Field that's used to sort the returned child nodes. | Optional | 68.0 |
| sortOrder | String | Sort order of the returned child nodes. | Optional | 68.0 |