Create a List View for an Object

Create a list view associated with an object.

Resource

1/ui-api/list-info/${objectApiName}

Available version

61.0

HTTP methods

POST

Example

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

1POST /services/data/v65.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}

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`listInfoInput`	List Info Post Input	Info to create a list.	Required	61.0

Response body for POST

List Info

User Interface API Developer Guide

Create a List View for an Object