User Interface API Developer Guide
jNewer Version Available
List Record Collection
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| count | Integer | The total count of records returned. | Small, 43.0 | 43.0 |
| currentPageToken | String | The token for the current page of records. | Small, 43.0 | 43.0 |
| currentPageUrl | String | The URL of the current page of records. | Small, 43.0 | 43.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, 48.0 | 48.0 |
| listInfoETag | String | An ETag that indicates whether the metadata has changed. | Small, 42.0 | 42.0 |
| listReference | List Reference | The list the records belong to. | Small, 48.0 | 48.0 |
| nextPageToken | String | The token for the next page of records. | Small, 43.0 | 43.0 |
| nextPageUrl | String | The URL of the next page of records. | Small, 43.0 | 43.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, 48.0 | 48.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 50. | Small, 48.0 | 48.0 |
| previousPageToken | String | The token for the previous page of records. | Small, 43.0 | 43.0 |
| previousPageUrl | String | The URL of the previous page of records. | Small, 43.0 | 43.0 |
| records | Record[] | A collection of records. | Small, 43.0 | 43.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, 48.0 | 48.0 |