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.

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 

1/connect/flexible-hierarchies/HIERARCHY_ID/snapshots/VERSION_NUMBER

Resource Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/flexible-hierarchies/0_H1XX0000004_FH1_EAM/snapshots/3

Available Version 

68.0

HTTP Methods 

GET

Path Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
hierarchyIdStringID of the flexible hierarchy associated with the snapshot.Required68.0
versionNumberStringVersion number of the snapshot to get the snapshot details for. Specify a positive integer.Required68.0

Query Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
nodeIdStringID of the captured node to center the response on. If not specified, the snapshot’s root node is used.Optional68.0
offsetIntegerNumber of snapshot nodes to skip before returning results. The default value is 0.Optional68.0
pageSizeIntegerMaximum number of snapshot nodes to return on a page. Specify a value from 1 through 10,000. The default value is 1000.Optional68.0
sortFieldStringField that’s used to sort the returned child nodes.Optional68.0
sortOrderStringSort order of the returned child nodes.Optional68.0

Response Body for GET 

Flexible Hierarchy Snapshot Response