User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Related List Record Collection
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| count | Integer | The total count of records returned. | Small, 50.0 | 50.0 |
| currentPageToken | String | The token for the current page of records. | Small, 50.0 | 50.0 |
| currentPageUrl | String | The URL of the current page of records. | Small, 50.0 | 50.0 |
| fields | String[] | The list of fields requested when these records were fetched. If a field isn’t available to the user, an error occurs. | Small, 50.0 | 50.0 |
| listInfoETag | String | An ETag that indicates whether the metadata has changed. | Small, 50.0 | 50.0 |
| listReference | Related List Reference | The reference to the related list that contains the records. | Small, 50.0 | 50.0 |
| nextPageToken | String | The token for the next page of records. | Small, 50.0 | 50.0 |
| nextPageUrl | String | The URL of the next page of records. | Small, 50.0 | 50.0 |
| optionalFields | String[] | The list of optional fields requested when these records were fetched. If a field isn’t available to the user, no error occurs and the field isn’t included in the response. | Small, 50.0 | 50.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 50. | Small, 50.0 | 50.0 |
| previousPageToken | String | The token for the previous page of records. | Small, 50.0 | 50.0 |
| previousPageUrl | String | The URL of the previous page of records. | Small, 50.0 | 50.0 |
| records | Record[] | A collection of records. | Small, 50.0 | 50.0 |
| sortBy | String | The API name of the field the list view is sorted by. If the name is preceded with -, the sort order is descending. | Small, 50.0 | 50.0 |
| where | String | The filter applied to returned records, in GraphQL syntax. For example, { and: [ { StageName: { eq: \"Prospecting\" } }, { Account: { Name: { eq: \"Dickenson plc\" } } } ] } filters an Opportunity related list to show only opportunities in the Prospecting stage that are linked to the “Dickenson plc” account. | Small, 55.0 | 55.0 |