Flexible Hierarchy Root Records Response

Output representation of the root records that match the root filter defined on a relationship graph definition, grouped by whether each record already has a hierarchy or not.

JSON Example 

1{
2  "rootObjectApiName": "Account",
3  "rootRecordsWithoutHierarchy": [
4    {
5      "id": "001xx000003GZ39AAG",
6      "name": "Name1"
7    },
8    {
9      "id": "001xx000003GZ40AAH",
10      "name": "Name2"
11    },
12    {
13      "id": "001xx000003GZ41AAI",
14      "name": "Name3"
15    }
16  ],
17  "rootRecordsWithHierarchy": [
18    {
19      "id": "001xx000003GZ42AAJ",
20      "name": "Name4"
21    }
22  ],
23  "hasMoreRecords": true,
24  "responseStatus": {
25    "statusCode": 200,
26    "message": "Root records were retrieved."
27  }
28}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
hasMoreRecordsBooleanIndicates whether more matching records are available beyond the current page (true) or not (false).Big, 68.068.0
responseStatusFlexible Hierarchy StatusHTTP status code and message for the request.Big, 68.068.0
rootObjectApiNameStringAPI name of the object that contains the matching root records.Big, 68.068.0
rootRecordsWithHierarchyFlexible Hierarchy Root Record Details[]List of root records that match the root filter and already have a hierarchy. Each record includes its ID and name.Big, 68.068.0
rootRecordsWithoutHierarchyFlexible Hierarchy Root Record Details[]List of root records that match the root filter and don’t have a hierarchy. Each record includes its ID and name.Big, 68.068.0