User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
List Order By Input
List User Preference Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Record Input
Related List Input
User Interface API Response Bodies
Supported Objects
PDF

Newer Version Available

This content describes an older version of this product. View Latest

List Order By Input

Information describing how to order a related list. Currently, related lists can be sorted 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:
1PATCH /services/data/v54.0/ui-api/related-list-info/Account/Contracts
1{ 
2  "orderedByInfo" : [{ 
3    "fieldApiName": "Name",
4    "isAscending" : true
5  }],
6  "userPreferences" : {
7    "columnWidths" : {
8        "Name" : -1
9    },
10    "columnWrap" : {
11        "Name" : false
12    }
13  }
14}
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