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

List Order By Input

Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.
Example
This example uses a request body to update the metadata for the Contracts related list for the Account object:
PATCH /services/data/v64.0/ui-api/related-list-info/Account/Contracts
{ 
  "orderedByInfo" : [{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }],
  "userPreferences" : {
    "columnWidths" : {
        "Name" : -1
    },
    "columnWrap" : {
        "Name" : false
    }
  }
}
Properties
Name Type Description Required or Optional Available Version
fieldApiName String The API name for the field. Optional 50.0
isAscending Boolean Indicates whether the list column is ascending or descending. Optional 50.0