VB6 / Salesforce Platform APIs / Get List View Records and Metadata API Name
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",sbResponseBody)
If (success = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print http.LastHeader
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "cloneable": true,
' "createable": true,
' "deletable": true,
' "displayColumns": [
' {
' "fieldApiName": "Name",
' "label": "Account Name",
' "lookupId": "Id",
' "sortable": true
' },
' {
' "fieldApiName": "Site",
' "label": "Account Site",
' "lookupId": null,
' "sortable": true
' },
' {
' "fieldApiName": "Phone",
' "label": "Phone",
' "lookupId": null,
' "sortable": true
' },
' {
' "fieldApiName": "Type",
' "label": "Type",
' "lookupId": null,
' "sortable": true
' },
' {
' "fieldApiName": "BillingCountry",
' "label": "Billing Country",
' "lookupId": null,
' "sortable": true
' },
' {
' "fieldApiName": "Owner.Alias",
' "label": "Account Owner Alias",
' "lookupId": "Owner.Id",
' "sortable": true
' }
' ],
' "eTag": "55ebdd0de6c2f1e17f63bf4581d64f76",
' "filterLogicString": null,
' "filteredByInfo": [
' ],
' "label": "All Accounts",
' "listReference": {
' "id": "00B58000002ssinEAA",
' "listViewApiName": "AllAccounts",
' "objectApiName": "Account",
' "type": "listView"
' },
' "objectApiNames": [
' ],
' "orderedByInfo": [
' {
' "fieldApiName": "BillingCountry",
' "isAscending": false,
' "label": "Billing Country"
' }
' ],
' "updateable": true,
' "userPreferences": {
' "columnWidths": {
' "Site": -1,
' "Type": -1,
' "BillingCountry": -1,
' "Owner.Alias": -1,
' "Phone": -1,
' "Name": -1
' },
' "columnWrap": {
' "Site": false,
' "Type": false,
' "BillingCountry": false,
' "Owner.Alias": false,
' "Phone": false,
' "Name": false
' }
' },
' "visibility": "Public",
' "visibilityEditable": true
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim fieldApiName As String
Dim lookupId As String
Dim sortable As Long
Dim isAscending As Long
Dim cloneable As Long
cloneable = jResp.BoolOf("cloneable")
Dim createable As Long
createable = jResp.BoolOf("createable")
Dim deletable As Long
deletable = jResp.BoolOf("deletable")
Dim eTag As String
eTag = jResp.StringOf("eTag")
Dim filterLogicString As String
filterLogicString = jResp.StringOf("filterLogicString")
Dim label As String
label = jResp.StringOf("label")
Dim Id As String
Id = jResp.StringOf("listReference.id")
Dim ListViewApiName As String
ListViewApiName = jResp.StringOf("listReference.listViewApiName")
Dim ObjectApiName As String
ObjectApiName = jResp.StringOf("listReference.objectApiName")
Dim v_Type As String
v_Type = jResp.StringOf("listReference.type")
Dim updateable As Long
updateable = jResp.BoolOf("updateable")
Dim Site As Long
Site = jResp.IntOf("userPreferences.columnWidths.Site")
Dim ColumnWidthsType As Long
ColumnWidthsType = jResp.IntOf("userPreferences.columnWidths.Type")
Dim BillingCountry As Long
BillingCountry = jResp.IntOf("userPreferences.columnWidths.BillingCountry")
Dim Owner_Alias As Long
Owner_Alias = jResp.IntOf("userPreferences.columnWidths.""Owner.Alias""")
Dim Phone As Long
Phone = jResp.IntOf("userPreferences.columnWidths.Phone")
Dim Name As Long
Name = jResp.IntOf("userPreferences.columnWidths.Name")
Dim ColumnWrapSite As Long
ColumnWrapSite = jResp.BoolOf("userPreferences.columnWrap.Site")
Dim ColumnWrapType As Long
ColumnWrapType = jResp.BoolOf("userPreferences.columnWrap.Type")
Dim ColumnWrapBillingCountry As Long
ColumnWrapBillingCountry = jResp.BoolOf("userPreferences.columnWrap.BillingCountry")
Dim ColumnWrapOwner_Alias As Long
ColumnWrapOwner_Alias = jResp.BoolOf("userPreferences.columnWrap.""Owner.Alias""")
Dim ColumnWrapPhone As Long
ColumnWrapPhone = jResp.BoolOf("userPreferences.columnWrap.Phone")
Dim ColumnWrapName As Long
ColumnWrapName = jResp.BoolOf("userPreferences.columnWrap.Name")
Dim visibility As String
visibility = jResp.StringOf("visibility")
Dim visibilityEditable As Long
visibilityEditable = jResp.BoolOf("visibilityEditable")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("displayColumns")
Do While i < count_i
jResp.I = i
fieldApiName = jResp.StringOf("displayColumns[i].fieldApiName")
label = jResp.StringOf("displayColumns[i].label")
lookupId = jResp.StringOf("displayColumns[i].lookupId")
sortable = jResp.BoolOf("displayColumns[i].sortable")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("filteredByInfo")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("objectApiNames")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("orderedByInfo")
Do While i < count_i
jResp.I = i
fieldApiName = jResp.StringOf("orderedByInfo[i].fieldApiName")
isAscending = jResp.BoolOf("orderedByInfo[i].isAscending")
label = jResp.StringOf("orderedByInfo[i].label")
i = i + 1
Loop
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME
Postman Collection Item JSON
{
"name": "Get List View Records and Metadata API Name",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-info",
":SOBJECT_API_NAME",
":LIST_VIEW_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "",
"description": "Object API name"
},
{
"key": "LIST_VIEW_API_NAME",
"value": "",
"description": "List view API name"
}
]
},
"description": "Returns record data and metadata for a list view."
},
"response": [
{
"name": "Get List View Records and Metadata API Name",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-info",
":SOBJECT_API_NAME",
":LIST_VIEW_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account",
"description": "Object API name"
},
{
"key": "LIST_VIEW_API_NAME",
"value": "AllAccounts",
"description": "List view API name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 09:58:32 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "ETag",
"value": "\"55ebdd0de6c2f1e17f63bf4581d64f76--gzip\""
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"cloneable\": true,\n \"createable\": true,\n \"deletable\": true,\n \"displayColumns\": [\n {\n \"fieldApiName\": \"Name\",\n \"label\": \"Account Name\",\n \"lookupId\": \"Id\",\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Site\",\n \"label\": \"Account Site\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Phone\",\n \"label\": \"Phone\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Type\",\n \"label\": \"Type\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"BillingCountry\",\n \"label\": \"Billing Country\",\n \"lookupId\": null,\n \"sortable\": true\n },\n {\n \"fieldApiName\": \"Owner.Alias\",\n \"label\": \"Account Owner Alias\",\n \"lookupId\": \"Owner.Id\",\n \"sortable\": true\n }\n ],\n \"eTag\": \"55ebdd0de6c2f1e17f63bf4581d64f76\",\n \"filterLogicString\": null,\n \"filteredByInfo\": [],\n \"label\": \"All Accounts\",\n \"listReference\": {\n \"id\": \"00B58000002ssinEAA\",\n \"listViewApiName\": \"AllAccounts\",\n \"objectApiName\": \"Account\",\n \"type\": \"listView\"\n },\n \"objectApiNames\": [],\n \"orderedByInfo\": [\n {\n \"fieldApiName\": \"BillingCountry\",\n \"isAscending\": false,\n \"label\": \"Billing Country\"\n }\n ],\n \"updateable\": true,\n \"userPreferences\": {\n \"columnWidths\": {\n \"Site\": -1,\n \"Type\": -1,\n \"BillingCountry\": -1,\n \"Owner.Alias\": -1,\n \"Phone\": -1,\n \"Name\": -1\n },\n \"columnWrap\": {\n \"Site\": false,\n \"Type\": false,\n \"BillingCountry\": false,\n \"Owner.Alias\": false,\n \"Phone\": false,\n \"Name\": false\n }\n },\n \"visibility\": \"Public\",\n \"visibilityEditable\": true\n}"
}
]
}
