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
/connect/flexible-hierarchies/hierarchyId/snapshots/versionNumber/actions/search
Resource Example
https://yourInstance.salesforce.com/services/data/v68.0/connect/flexible-hierarchies/0H1xx0000004FH1EAM/snapshots/3/actions/search?searchQuery={text}&entityType={objectApiName}
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 that the snapshot belongs to. | Required | 68.0 |
| versionNumber | String | Version number of the snapshot to search within. | Required | 68.0 |
Query Parameters for GET
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| entityType | String | API name of the object whose snapshot nodes to search. Specify all to search all objects within the specified snapshot version. | Required | 68.0 |
| searchQuery | String | Text to search in the node name field of the snapshot. | Required | 68.0 |