Foxpro / Salesforce Platform APIs / Get List View Records and Metadata API Name
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcFieldApiName
LOCAL lcLookupId
LOCAL lnSortable
LOCAL lnIsAscending
LOCAL lnCloneable
LOCAL lnCreateable
LOCAL lnDeletable
LOCAL lcETag
LOCAL lcFilterLogicString
LOCAL lcLabel
LOCAL lcId
LOCAL lcListViewApiName
LOCAL lcObjectApiName
LOCAL lcV_Type
LOCAL lnUpdateable
LOCAL lnSite
LOCAL lnColumnWidthsType
LOCAL lnBillingCountry
LOCAL lnOwner_Alias
LOCAL lnPhone
LOCAL lnName
LOCAL lnColumnWrapSite
LOCAL lnColumnWrapType
LOCAL lnColumnWrapBillingCountry
LOCAL lnColumnWrapOwner_Alias
LOCAL lnColumnWrapPhone
LOCAL lnColumnWrapName
LOCAL lcVisibility
LOCAL lnVisibilityEditable
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
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
lnCloneable = loJResp.BoolOf("cloneable")
lnCreateable = loJResp.BoolOf("createable")
lnDeletable = 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")
lnUpdateable = 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")
lnColumnWrapSite = loJResp.BoolOf("userPreferences.columnWrap.Site")
lnColumnWrapType = loJResp.BoolOf("userPreferences.columnWrap.Type")
lnColumnWrapBillingCountry = loJResp.BoolOf("userPreferences.columnWrap.BillingCountry")
lnColumnWrapOwner_Alias = loJResp.BoolOf('userPreferences.columnWrap."Owner.Alias"')
lnColumnWrapPhone = loJResp.BoolOf("userPreferences.columnWrap.Phone")
lnColumnWrapName = loJResp.BoolOf("userPreferences.columnWrap.Name")
lcVisibility = loJResp.StringOf("visibility")
lnVisibilityEditable = 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")
lnSortable = 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")
lnIsAscending = 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 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}"
}
]
}
