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 Info Post Input

Info to create a list.

Example

This example uses a request body to create the metadata for an account list view.

1POST /services/data/v67.0/ui-api/list-info/Account

1{
2"listViewApiName": "MyAccountListView",
3"filteredByInfo": [
4  {
5  "fieldApiName": "Name",
6  "operandLabels": [ "This", "That"],
7  "operator": "Equals"
8  },
9  {
10  "fieldApiName": "Phone",
11  "operandLabels": [ "919"],
12  "operator": "StartsWith"
13  },
14{
15  "fieldApiName": "AnnualRevenue",
16  "operandLabels": [ "1000000"],
17  "operator": "GreaterThan"
18  }
19],
20"filterLogicString" : "(1 OR 2) AND 3",
21"label": "Accounts opened this year",
22"scope": {
23  "apiName": "entity",
24  "entityId": "00Gxx000000sjI8",
25  "relatedEntityId": "701xx000003HZ7X"
26},
27"visibility": "Public"
28}

Properties

Name	Type	Description	Required or Optional	Available Version
`displayColumns`	String[]	Display columns (field API names) for the list.	Optional	61.0
`filterLogicString`	String	Filter logic string, such as (1 OR 2) and 3. Indexes start with 1.	Optional	61.0
`filteredByInfo`	List Filter By Info Input[]	Filtering information for the list.	Optional	61.0
`label`	String	List’s display label, for example, All Accounts.	Optional	61.0
`listShares`	String[]	Objects the list is shared with, if visibility is shared. For role sharing, use `Role.RoleAPIName`. For group sharing, use `groupType.GroupApiName`, where `groupType` is one of the `type` values for the Group object.	Optional	61.0
`listViewApiName`	String	API name for the list. This property is optional but strongly recommended. If unspecified, a default API name is generated.	Optional	61.0
`scope`	List Scope Input	Scope information for the list.	Optional	61.0
`visibility`	String	List’s visibility. One of these values: `Private` `Public` `Shared`	Optional	61.0

User Interface API Developer Guide

List Info Post Input

See Also