User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
Lists
Get List View Metadata
Get a Batch of List View Metadata
Update List View Metadata
Delete List View Metadata
Get List Views for an Object
Create a List View for an Object
Get Metadata for a List View Object
Get List View Records with URL Parameters
Get List View Records with a Request Body
Get List View Preferences
Update List View Preferences
Get Related Lists for an Object
Get Related List Records with URL Parameters
Get Related List Records with a Request Body
Get Related List Metadata
Get Related List Record Count
Get a Batch of Related List Metadata
Get a Batch of Related List Records with URL Parameters
Get a Batch of Related List Records with a Request Body
Get a Batch of Related List Record Counts
Update Related List Metadata
Get Related List User Preferences
Get a Batch of Related List User Preferences
Update Related List User Preferences
Apps
Get Active Theme
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Get a Batch of Related List Metadata

Returns metadata for a batch of related lists in a page layout.
Resource
/ui-api/related-list-info/batch/${parentObjectApiName}/${relatedListNames}
  • parentObjectApiName—A supported object, such as Account.
  • relatedListNames—Comma-separated IDs of supported related lists for that object.
Available Version
50.0
HTTP Method
GET
Example

To get information about the Contracts and Work Orders related lists for the Account object, make this request.

GET /services/data/v64.0/ui-api/related-list-info/batch/Account/Contracts,WorkOrders
Request Parameters
Parameter Name Type Description Required or Optional Available Version
recordTypeId Id The ID of the record type (RecordType object) for the record. If not provided, the default record type is used. Optional 50.0
Response Body
Simplified Batch Results