autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sFieldApiName
Local $sLookupId
Local $bSortable
Local $bIsAscending
Local $bCloneable = $oJResp.BoolOf("cloneable")
Local $bCreateable = $oJResp.BoolOf("createable")
Local $bDeletable = $oJResp.BoolOf("deletable")
Local $sETag = $oJResp.StringOf("eTag")
Local $sFilterLogicString = $oJResp.StringOf("filterLogicString")
Local $sLabel = $oJResp.StringOf("label")
Local $sId = $oJResp.StringOf("listReference.id")
Local $sListViewApiName = $oJResp.StringOf("listReference.listViewApiName")
Local $sObjectApiName = $oJResp.StringOf("listReference.objectApiName")
Local $sV_Type = $oJResp.StringOf("listReference.type")
Local $bUpdateable = $oJResp.BoolOf("updateable")
Local $iSite = $oJResp.IntOf("userPreferences.columnWidths.Site")
Local $iColumnWidthsType = $oJResp.IntOf("userPreferences.columnWidths.Type")
Local $iBillingCountry = $oJResp.IntOf("userPreferences.columnWidths.BillingCountry")
Local $iOwner_Alias = $oJResp.IntOf("userPreferences.columnWidths.""Owner.Alias""")
Local $iPhone = $oJResp.IntOf("userPreferences.columnWidths.Phone")
Local $iName = $oJResp.IntOf("userPreferences.columnWidths.Name")
Local $bColumnWrapSite = $oJResp.BoolOf("userPreferences.columnWrap.Site")
Local $bColumnWrapType = $oJResp.BoolOf("userPreferences.columnWrap.Type")
Local $bColumnWrapBillingCountry = $oJResp.BoolOf("userPreferences.columnWrap.BillingCountry")
Local $bColumnWrapOwner_Alias = $oJResp.BoolOf("userPreferences.columnWrap.""Owner.Alias""")
Local $bColumnWrapPhone = $oJResp.BoolOf("userPreferences.columnWrap.Phone")
Local $bColumnWrapName = $oJResp.BoolOf("userPreferences.columnWrap.Name")
Local $sVisibility = $oJResp.StringOf("visibility")
Local $bVisibilityEditable = $oJResp.BoolOf("visibilityEditable")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("displayColumns")
While $i < $iCount_i
$oJResp.I = $i
$sFieldApiName = $oJResp.StringOf("displayColumns[i].fieldApiName")
$sLabel = $oJResp.StringOf("displayColumns[i].label")
$sLookupId = $oJResp.StringOf("displayColumns[i].lookupId")
$bSortable = $oJResp.BoolOf("displayColumns[i].sortable")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("filteredByInfo")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("objectApiNames")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("orderedByInfo")
While $i < $iCount_i
$oJResp.I = $i
$sFieldApiName = $oJResp.StringOf("orderedByInfo[i].fieldApiName")
$bIsAscending = $oJResp.BoolOf("orderedByInfo[i].isAscending")
$sLabel = $oJResp.StringOf("orderedByInfo[i].label")
$i = $i + 1
Wend
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}"
}
]
}
