Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
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
llCloneable = loJResp.BoolOf("cloneable")
llCreateable = loJResp.BoolOf("createable")
llDeletable = loJResp.BoolOf("deletable")
lcETag = loJResp.StringOf("eTag")
lcFilterLogicString = loJResp.StringOf("filterLogicString")
lcLabel = loJResp.StringOf("label")
lcId = loJResp.StringOf("listReference.id")
lcListViewApiName = loJResp.StringOf("listReference.listViewApiName")
lcObjectApiName = loJResp.StringOf("listReference.objectApiName")
lcV_Type = loJResp.StringOf("listReference.type")
llUpdateable = loJResp.BoolOf("updateable")
lnSite = loJResp.IntOf("userPreferences.columnWidths.Site")
lnColumnWidthsType = loJResp.IntOf("userPreferences.columnWidths.Type")
lnBillingCountry = loJResp.IntOf("userPreferences.columnWidths.BillingCountry")
lnOwner_Alias = loJResp.IntOf('userPreferences.columnWidths."Owner.Alias"')
lnPhone = loJResp.IntOf("userPreferences.columnWidths.Phone")
lnName = loJResp.IntOf("userPreferences.columnWidths.Name")
llColumnWrapSite = loJResp.BoolOf("userPreferences.columnWrap.Site")
llColumnWrapType = loJResp.BoolOf("userPreferences.columnWrap.Type")
llColumnWrapBillingCountry = loJResp.BoolOf("userPreferences.columnWrap.BillingCountry")
llColumnWrapOwner_Alias = loJResp.BoolOf('userPreferences.columnWrap."Owner.Alias"')
llColumnWrapPhone = loJResp.BoolOf("userPreferences.columnWrap.Phone")
llColumnWrapName = loJResp.BoolOf("userPreferences.columnWrap.Name")
lcVisibility = loJResp.StringOf("visibility")
llVisibilityEditable = loJResp.BoolOf("visibilityEditable")
i = 0
lnCount_i = loJResp.SizeOfArray("displayColumns")
do while i < lnCount_i
loJResp.I = i
lcFieldApiName = loJResp.StringOf("displayColumns[i].fieldApiName")
lcLabel = loJResp.StringOf("displayColumns[i].label")
lcLookupId = loJResp.StringOf("displayColumns[i].lookupId")
llSortable = loJResp.BoolOf("displayColumns[i].sortable")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("filteredByInfo")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("objectApiNames")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("orderedByInfo")
do while i < lnCount_i
loJResp.I = i
lcFieldApiName = loJResp.StringOf("orderedByInfo[i].fieldApiName")
llIsAscending = loJResp.BoolOf("orderedByInfo[i].isAscending")
lcLabel = loJResp.StringOf("orderedByInfo[i].label")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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 Metadata per 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 list view metadata."
},
"response": [
{
"name": "Get List View Metadata per 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:56:56 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}"
}
]
}
