Flexible Hierarchy Records (GET)

Search the org for records of a specified object type whose name matches your search text, scoped to the configuration of a relationship graph definition. Use this API to find any record that you can add as a node to a flexible hierarchy. Unlike the node search, this API searches all records of the specified object and works in orgs that have probabilistic encryption enabled on the name field.

Resource 

1/connect/flexible-hierarchies/relationship-graph-definitions/GRAPH_DEFINITION_ID/records

Resource Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/flexible-hierarchies/relationship-graph-definitions/06_JRG000000001_AMA2/records

Available Version 

68.0

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
graphDefinitionIdStringID of the relationship graph definition whose configuration scopes the search.Required68.0
entityTypeStringAPI name of the object to search, such as Account. The object must be part of the relationship graph definition’s configuration.Optional68.0
searchQueryStringText to match against the name of the records of the specified object.Optional68.0

Response Body for GET 

Flexible Hierarchy Record Search Response