User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Get Related List Records with a Request Body
Returns record data for up to 1,999 records in a related list. This
resource uses the POST method to let you enter request parameters in the request body instead of
the URL.
- Resources
-
/ui-api/related-list-records/${parentRecordId}/${relatedListId} -
- parentRecordId—The ID of the record you want to get related lists for.
- relatedListId—The API name of a supported related list for that object, such as Contacts. In API version 62.0 and later, relatedListId supports the API name of a child relationship.
- Available Version
- 55.0
- HTTP Method
- POST
- Example
- To get record data for the Contacts related list for the account record 001xx000003GYOpAAO, use this request.
-
POST /ui-api/related-list-records/001xx000003GYOpAAO/Contacts -
{ "fields": ["Name", "Id", "Birthdate"], "optionalFields": ["Email"], "sortBy": ["CreatedDate"], "pageSize": 10, "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}" } - Request Parameters
-
Parameter Name Type Description Required or Optional Available Version listRecordsQuery Related List Records Input The record data for the related list. Required 55.0 - Response Body
- Related List Record Collection