List Info Input

Info to update a list.

Example

This example uses a request body to update the metadata for a list view. The object API name is Account and the list view API name is AllAccounts.

1PATCH /services/data/v62.0/ui-api/list-info/Account/AllAccounts

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

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.	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 Input

See Also