Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/ui-api/list-info/:LIST_VIEW_ID",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
fieldApiName.s
lookupId.s
sortable.i
isAscending.i
cloneable.i = CkJsonObject::ckBoolOf(jResp,"cloneable")
createable.i = CkJsonObject::ckBoolOf(jResp,"createable")
deletable.i = CkJsonObject::ckBoolOf(jResp,"deletable")
eTag.s = CkJsonObject::ckStringOf(jResp,"eTag")
filterLogicString.s = CkJsonObject::ckStringOf(jResp,"filterLogicString")
label.s = CkJsonObject::ckStringOf(jResp,"label")
Id.s = CkJsonObject::ckStringOf(jResp,"listReference.id")
ListViewApiName.s = CkJsonObject::ckStringOf(jResp,"listReference.listViewApiName")
ObjectApiName.s = CkJsonObject::ckStringOf(jResp,"listReference.objectApiName")
v_Type.s = CkJsonObject::ckStringOf(jResp,"listReference.type")
updateable.i = CkJsonObject::ckBoolOf(jResp,"updateable")
Site.i = CkJsonObject::ckIntOf(jResp,"userPreferences.columnWidths.Site")
ColumnWidthsType.i = CkJsonObject::ckIntOf(jResp,"userPreferences.columnWidths.Type")
BillingCountry.i = CkJsonObject::ckIntOf(jResp,"userPreferences.columnWidths.BillingCountry")
Owner_Alias.i = CkJsonObject::ckIntOf(jResp,"userPreferences.columnWidths." + Chr(34) + "Owner.Alias" + Chr(34))
Phone.i = CkJsonObject::ckIntOf(jResp,"userPreferences.columnWidths.Phone")
Name.i = CkJsonObject::ckIntOf(jResp,"userPreferences.columnWidths.Name")
ColumnWrapSite.i = CkJsonObject::ckBoolOf(jResp,"userPreferences.columnWrap.Site")
ColumnWrapType.i = CkJsonObject::ckBoolOf(jResp,"userPreferences.columnWrap.Type")
ColumnWrapBillingCountry.i = CkJsonObject::ckBoolOf(jResp,"userPreferences.columnWrap.BillingCountry")
ColumnWrapOwner_Alias.i = CkJsonObject::ckBoolOf(jResp,"userPreferences.columnWrap." + Chr(34) + "Owner.Alias" + Chr(34))
ColumnWrapPhone.i = CkJsonObject::ckBoolOf(jResp,"userPreferences.columnWrap.Phone")
ColumnWrapName.i = CkJsonObject::ckBoolOf(jResp,"userPreferences.columnWrap.Name")
visibility.s = CkJsonObject::ckStringOf(jResp,"visibility")
visibilityEditable.i = CkJsonObject::ckBoolOf(jResp,"visibilityEditable")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"displayColumns")
While i < count_i
CkJsonObject::setCkI(jResp, i)
fieldApiName = CkJsonObject::ckStringOf(jResp,"displayColumns[i].fieldApiName")
label = CkJsonObject::ckStringOf(jResp,"displayColumns[i].label")
lookupId = CkJsonObject::ckStringOf(jResp,"displayColumns[i].lookupId")
sortable = CkJsonObject::ckBoolOf(jResp,"displayColumns[i].sortable")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"filteredByInfo")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"objectApiNames")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"orderedByInfo")
While i < count_i
CkJsonObject::setCkI(jResp, i)
fieldApiName = CkJsonObject::ckStringOf(jResp,"orderedByInfo[i].fieldApiName")
isAscending = CkJsonObject::ckBoolOf(jResp,"orderedByInfo[i].isAscending")
label = CkJsonObject::ckStringOf(jResp,"orderedByInfo[i].label")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/list-info/:LIST_VIEW_ID
Postman Collection Item JSON
{
"name": "Get List View Metadata per Id",
"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/:LIST_VIEW_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-info",
":LIST_VIEW_ID"
],
"variable": [
{
"key": "LIST_VIEW_ID",
"value": "",
"description": "List view ID"
}
]
},
"description": "Returns list view metadata."
},
"response": [
{
"name": "Get List View Metadata per Id",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/list-info/:LIST_VIEW_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-info",
":LIST_VIEW_ID"
],
"variable": [
{
"key": "LIST_VIEW_ID",
"value": "00B58000002ssinEAA",
"description": "List view ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 09:56:15 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}"
}
]
}
