Flexible Hierarchy Root Records (GET)

Get the records that match the root filter defined in a relationship graph definition. Use this API to preview the records that are eligible for rule-based hierarchy creation before starting a hierarchy generation job.

Resource 

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

Resource Example 

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

Available Version 

68.0

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
graphDefinitionIdStringID of the relationship graph definition that defines the root filter used to identify eligible records.Required68.0
offsetIntegerNumber of records to skip before returning results. Specify a value from 0 through 2,000. The default value is 0.Optional68.0
pageSizeIntegerMaximum number of records to return on a page. Specify a value from 1 through 10,000. The default value is 1,000.Optional68.0
searchTextStringText to search root records whose name contains the specified text. If specified, the trimmed value must be 2 through 10,000 characters. If not specified, no name filtering is applied.Optional68.0

Response Body for GET 

Flexible Hierarchy Root Records Response