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-ui/:SOBJECT_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)
# {
# "count": 6,
# "currentPageToken": "0",
# "currentPageUrl": "/services/data/v58.0/ui-api/list-ui/Account?pageSize=20&pageToken=0",
# "eTag": "7a9cf6dc597cbc985bab8a26df2f1752",
# "lists": [
# {
# "apiName": "AllAccounts",
# "id": "00B58000002ssinEAA",
# "label": "All Accounts",
# "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/AllAccounts"
# },
# {
# "apiName": "MyAccounts",
# "id": "00B58000002ssivEAA",
# "label": "My Accounts",
# "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/MyAccounts"
# },
# {
# "apiName": "NewLastWeek",
# "id": "00B58000002ssiHEAQ",
# "label": "New Last Week",
# "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/NewLastWeek"
# },
# {
# "apiName": "NewThisWeek",
# "id": "00B58000002ssi6EAA",
# "label": "New This Week",
# "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/NewThisWeek"
# },
# {
# "apiName": "PlatinumandGoldSLACustomers",
# "id": "00B58000002ssiXEAQ",
# "label": "Platinum and Gold SLA Customers",
# "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/PlatinumandGoldSLACustomers"
# },
# {
# "apiName": "RecentlyViewedAccounts",
# "id": "00B58000002ssimEAA",
# "label": "Recently Viewed Accounts",
# "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/RecentlyViewedAccounts"
# }
# ],
# "nextPageToken": null,
# "nextPageUrl": null,
# "objectApiName": "Account",
# "pageSize": 20,
# "previousPageToken": null,
# "previousPageUrl": null,
# "queryString": null,
# "recentListsOnly": false
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set count [CkJsonObject_IntOf $jResp "count"]
set currentPageToken [CkJsonObject_stringOf $jResp "currentPageToken"]
set currentPageUrl [CkJsonObject_stringOf $jResp "currentPageUrl"]
set eTag [CkJsonObject_stringOf $jResp "eTag"]
set nextPageToken [CkJsonObject_stringOf $jResp "nextPageToken"]
set nextPageUrl [CkJsonObject_stringOf $jResp "nextPageUrl"]
set objectApiName [CkJsonObject_stringOf $jResp "objectApiName"]
set pageSize [CkJsonObject_IntOf $jResp "pageSize"]
set previousPageToken [CkJsonObject_stringOf $jResp "previousPageToken"]
set previousPageUrl [CkJsonObject_stringOf $jResp "previousPageUrl"]
set queryString [CkJsonObject_stringOf $jResp "queryString"]
set recentListsOnly [CkJsonObject_BoolOf $jResp "recentListsOnly"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "lists"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set apiName [CkJsonObject_stringOf $jResp "lists[i].apiName"]
set id [CkJsonObject_stringOf $jResp "lists[i].id"]
set label [CkJsonObject_stringOf $jResp "lists[i].label"]
set listUiUrl [CkJsonObject_stringOf $jResp "lists[i].listUiUrl"]
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-ui/:SOBJECT_API_NAME
Postman Collection Item JSON
{
"name": "Get List View for an Object",
"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-ui/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-ui",
":SOBJECT_API_NAME"
],
"query": [
{
"key": "pageSize",
"value": "",
"description": "The number of list records viewed at one time. The default value is 20. Value can be 1–2000.",
"disabled": true
},
{
"key": "pageToken",
"value": "",
"description": "A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0.",
"disabled": true
},
{
"key": "q",
"value": "",
"description": "Query list views that contain certain key words.",
"disabled": true
},
{
"key": "recentListsOnly",
"value": "true",
"description": "Show only recently viewed lists.",
"disabled": true
}
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account",
"description": "Object API name"
}
]
},
"description": "Returns a collection of list views associated with an object."
},
"response": [
{
"name": "Get List View for an Object",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/list-ui/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-ui",
":SOBJECT_API_NAME"
],
"query": [
{
"key": "pageSize",
"value": null,
"description": "The number of list records viewed at one time. The default value is 20. Value can be 1–2000.",
"disabled": true
},
{
"key": "pageToken",
"value": null,
"description": "A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0.",
"disabled": true
},
{
"key": "q",
"value": null,
"description": "Query list views that contain certain key words.",
"disabled": true
},
{
"key": "recentListsOnly",
"value": "true",
"description": "Show only recently viewed lists.",
"disabled": true
}
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account",
"description": "Object API name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 09:49:33 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": "\"7a9cf6dc597cbc985bab8a26df2f1752--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 \"count\": 6,\n \"currentPageToken\": \"0\",\n \"currentPageUrl\": \"/services/data/v58.0/ui-api/list-ui/Account?pageSize=20&pageToken=0\",\n \"eTag\": \"7a9cf6dc597cbc985bab8a26df2f1752\",\n \"lists\": [\n {\n \"apiName\": \"AllAccounts\",\n \"id\": \"00B58000002ssinEAA\",\n \"label\": \"All Accounts\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/AllAccounts\"\n },\n {\n \"apiName\": \"MyAccounts\",\n \"id\": \"00B58000002ssivEAA\",\n \"label\": \"My Accounts\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/MyAccounts\"\n },\n {\n \"apiName\": \"NewLastWeek\",\n \"id\": \"00B58000002ssiHEAQ\",\n \"label\": \"New Last Week\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/NewLastWeek\"\n },\n {\n \"apiName\": \"NewThisWeek\",\n \"id\": \"00B58000002ssi6EAA\",\n \"label\": \"New This Week\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/NewThisWeek\"\n },\n {\n \"apiName\": \"PlatinumandGoldSLACustomers\",\n \"id\": \"00B58000002ssiXEAQ\",\n \"label\": \"Platinum and Gold SLA Customers\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/PlatinumandGoldSLACustomers\"\n },\n {\n \"apiName\": \"RecentlyViewedAccounts\",\n \"id\": \"00B58000002ssimEAA\",\n \"label\": \"Recently Viewed Accounts\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/RecentlyViewedAccounts\"\n }\n ],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"objectApiName\": \"Account\",\n \"pageSize\": 20,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"queryString\": null,\n \"recentListsOnly\": false\n}"
}
]
}
