Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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:

1PATCH /services/data/v67.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

User Interface API Developer Guide

List Order By Input

See Also