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
User Interface API Request Bodies
Action Input
Action Related List Single Batch Input
Action Related Lists Batch Input
Batch Record Input
Batch Operation Input
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
List Filter By Info Input
List Info Input
List Info Post Input
List Order By Input
List Preferences Input
List Records Input
List Scope Input
List User Preference Input
Lookup Post Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Perform Action Input
Record Input
Related List Input
Related List Records Input
Related List Records Batch Input
Related List User Preferences Input
User Interface API Response Bodies
User Interface API Appendices
PDF

Related List Records Batch Input

Get record data for a batch of related lists.
JSON example
To get record data for the Contacts and Opportunities related lists for the account record 001xx000003GYOpAAO, use the following request.
POST /ui-api/related-list-records/batch/001xx000003GYOpAAO
{
    "relatedListParameters":
    [
        {
            "relatedListId": "Contacts",
            "fields": ["Name", "Id", "Birthdate"],
            "optionalFields": ["Email"],
            "sortBy": ["CreatedDate"],
            "pageSize": 10,
            "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
        },
        {
            "relatedListId": "Opportunities",
            "fields": ["Name", "Id"],
            "optionalFields": ["Email"],
            "sortBy": ["CreatedDate"],
            "pageSize": 10,
            "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
        }
    ]
}
Properties
Parameter Name Type Description Required or Optional Available Version
relatedListId String The ID of the related list that you want to get records for. Required 55.0
fields String[] Fields queried for the records returned. These fields are included in the response body and don’t create visible columns. If the field isn’t available to the user, an error occurs. Optional 55.0
optionalFields String[] Additional fields queried for the records returned. These fields are included in the response body and don’t create visible columns. If the field isn’t available to the user, no error occurs and the field isn’t included in the records. Optional 55.0
pageSize Integer The number of records from all lists in the request viewed at one time. The default value is 50. Value can be 1–1999. Optional 55.0
sortBy String[] The API names of the fields that the related list is sorted by. If the name is preceded with -, the sort order is descending. For example, Name sorts by name in ascending order. -CreatedDate sorts by created date in descending order.

In API version 63.0 and later, you can sort by up to five fields. If a field is invalid or isn’t accessible to the context user, this parameter is ignored, but no error occurs.

 Optional 55.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. Optional 55.0