Actionable List Definitions Records

The response representation of an actionable list definition along with the associated records, column metadata, and pagination details.

JSON Example

1{
2  "pageLimit": 200,
3  "offset": 0,
4  "count": 1250,
5  "orderBy": "Name",
6  "sortOrder": "ASC",
7  "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2Fe1025a17-0ff7-bcb9-204c",
8  "dataColumns": [
9    {
10      "dataType": "Text",
11      "sourceColumnName": "ID",
12      "columnApiName": "Account.Id"
13    },
14    {
15      "dataType": "Text",
16      "sourceColumnName": "Name",
17      "columnApiName": "Account.Name"
18    },
19    {
20      "dataType": "Number",
21      "sourceColumnName": "AnnualRevenue",
22      "columnApiName": "Account.AnnualRevenue"
23    }
24  ],
25  "data": [
26    {
27      "rowData": {
28        "Account.Id": "0015g00000ABC123",
29        "Account.Name": "Acme Corp",
30        "Account.AnnualRevenue": "5000000"
31      }
32    },
33    {
34      "rowData": {
35        "Account.Id": "0015g00000XYZ789",
36        "Account.Name": "Tech Solutions Inc",
37        "Account.AnnualRevenue": "2500000"
38      }
39    }
40  ]
41}

Properties

Property Name	Type	Description
`count`	Integer	Total number of records that are returned.
`data`	Actionable List Definitions Data Row[]	List of rows that are returned. Each row represents a single record, mapping the column names to their specific values. See Actionable List Definitions Data Row.
`dataColumns`	Actionable List Definitions Data Column[]	Details of the dataset columns and their metadata. See Actionable List Definitions Data Column.
`offset`	Integer	Number of records that are skipped before returning results.
`orderBy`	String	Name of the column by which the records are sorted.
`pageLimit`	Integer	Maximum number of records that are returned on a page.
`queryId`	String	A unique identifier that’s used to retrieve the remaining records from a long-running query. If the initial request doesn’t return the complete dataset, the response includes a new query ID. Pass this latest query ID in your subsequent request to fetch the next batch of results.
`sortOrder`	String	Direction by which the result is sorted, such as ascending or descending.