TCL / Salesforce Platform APIs / Get List View Records and Metadata API Name
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set cloneable [CkJsonObject_BoolOf $jResp "cloneable"]
set createable [CkJsonObject_BoolOf $jResp "createable"]
set deletable [CkJsonObject_BoolOf $jResp "deletable"]
set eTag [CkJsonObject_stringOf $jResp "eTag"]
set filterLogicString [CkJsonObject_stringOf $jResp "filterLogicString"]
set label [CkJsonObject_stringOf $jResp "label"]
set Id [CkJsonObject_stringOf $jResp "listReference.id"]
set ListViewApiName [CkJsonObject_stringOf $jResp "listReference.listViewApiName"]
set ObjectApiName [CkJsonObject_stringOf $jResp "listReference.objectApiName"]
set v_Type [CkJsonObject_stringOf $jResp "listReference.type"]
set updateable [CkJsonObject_BoolOf $jResp "updateable"]
set Site [CkJsonObject_IntOf $jResp "userPreferences.columnWidths.Site"]
set ColumnWidthsType [CkJsonObject_IntOf $jResp "userPreferences.columnWidths.Type"]
set BillingCountry [CkJsonObject_IntOf $jResp "userPreferences.columnWidths.BillingCountry"]
set Owner_Alias [CkJsonObject_IntOf $jResp "userPreferences.columnWidths.\"Owner.Alias\""]
set Phone [CkJsonObject_IntOf $jResp "userPreferences.columnWidths.Phone"]
set Name [CkJsonObject_IntOf $jResp "userPreferences.columnWidths.Name"]
set ColumnWrapSite [CkJsonObject_BoolOf $jResp "userPreferences.columnWrap.Site"]
set ColumnWrapType [CkJsonObject_BoolOf $jResp "userPreferences.columnWrap.Type"]
set ColumnWrapBillingCountry [CkJsonObject_BoolOf $jResp "userPreferences.columnWrap.BillingCountry"]
set ColumnWrapOwner_Alias [CkJsonObject_BoolOf $jResp "userPreferences.columnWrap.\"Owner.Alias\""]
set ColumnWrapPhone [CkJsonObject_BoolOf $jResp "userPreferences.columnWrap.Phone"]
set ColumnWrapName [CkJsonObject_BoolOf $jResp "userPreferences.columnWrap.Name"]
set visibility [CkJsonObject_stringOf $jResp "visibility"]
set visibilityEditable [CkJsonObject_BoolOf $jResp "visibilityEditable"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "displayColumns"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set fieldApiName [CkJsonObject_stringOf $jResp "displayColumns[i].fieldApiName"]
set label [CkJsonObject_stringOf $jResp "displayColumns[i].label"]
set lookupId [CkJsonObject_stringOf $jResp "displayColumns[i].lookupId"]
set sortable [CkJsonObject_BoolOf $jResp "displayColumns[i].sortable"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "filteredByInfo"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "objectApiNames"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "orderedByInfo"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set fieldApiName [CkJsonObject_stringOf $jResp "orderedByInfo[i].fieldApiName"]
set isAscending [CkJsonObject_BoolOf $jResp "orderedByInfo[i].isAscending"]
set label [CkJsonObject_stringOf $jResp "orderedByInfo[i].label"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
