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.

The search is limited to the snapshot version that you specify. Each result is a captured node whose display name matches searchQuery. Set entityType to the API name of one captured object, or to all to search every object in that snapshot.

Resource 

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

Resource Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/flexible-hierarchies/0_H1XX0000004_FH1_EAM/snapshots/3/actions/search?searchQuery={text}&entityType={objectApiName}

Available Version 

68.0

HTTP Methods 

GET

Path Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
hierarchyIdStringID of the flexible hierarchy that the snapshot belongs to.Required68.0
versionNumberStringVersion number of the snapshot to search within.Required68.0

Query Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
entityTypeStringAPI name of the object whose snapshot nodes to search. Specify all to search all objects within the specified snapshot version.Required68.0
searchQueryStringText to search in the node name field of the snapshot.Required68.0

Response Body for GET 

Flexible Hierarchy Search