Query Records Result

Output representation of the results when querying context records and their child records.

The result contains one entry for each data path in the request. Use isSuccess to see whether the query succeeded. Each entry links the data path to its Query Context Record Result, which contains the returned records.

JSON Example

1{
2  "contextQueryRecordListId": "8c1f2a40-6b2e-4d1a-9c55-1e2b7a9d4f10",
3  "isSuccess": true,
4  "queryResults": [
5    {
6      "dataPath": [
7        "001xx000003GaX6AAK"
8      ],
9      "queryResult": {
10        "contextId": "7bc695bc-f38b-4a94-8a95-0caa50f3da53",
11        "isDone": true,
12        "isSuccess": true,
13        "queryRecords": [
14          {
15            "childQueryRecords": [],
16            "record": {
17              "attributesAndValues": {
18                "Name": "Acme Corp",
19                "Industry": "Manufacturing",
20                "Type": "Prospect"
21              },
22              "businessObjectType": "Account",
23              "childBusinessObjectTypes": [
24                "OpportunityItem",
25                "OrderItem"
26              ],
27              "contextDataRecordId": "001xx000003GaX6AAK",
28              "currentState": "CREATED",
29              "lastUpdatedTimeStamp": "2023-10-11 04:46:13.804"
30            }
31          }
32        ]
33      }
34    }
35  ]
36}

Properties

Property Name Type Description Filter Group and Version Available Version
contextQuery​RecordListId String Unique ID of this query records result. Small, 60.0 60.0
isSuccess Boolean Indicates whether the query is successful (true) or not (false). Small, 60.0 60.0
queryResults Query Context Record Result Data[] List of query results, one for each data path. Small, 60.0 60.0