Chilkat Online Tools

Ruby / Salesforce Platform APIs / Get List View Metadata per API Name

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

cloneable = jResp.BoolOf("cloneable")
createable = jResp.BoolOf("createable")
deletable = jResp.BoolOf("deletable")
eTag = jResp.stringOf("eTag")
filterLogicString = jResp.stringOf("filterLogicString")
label = jResp.stringOf("label")
Id = jResp.stringOf("listReference.id")
ListViewApiName = jResp.stringOf("listReference.listViewApiName")
ObjectApiName = jResp.stringOf("listReference.objectApiName")
v_Type = jResp.stringOf("listReference.type")
updateable = jResp.BoolOf("updateable")
Site = jResp.IntOf("userPreferences.columnWidths.Site")
ColumnWidthsType = jResp.IntOf("userPreferences.columnWidths.Type")
BillingCountry = jResp.IntOf("userPreferences.columnWidths.BillingCountry")
Owner_Alias = jResp.IntOf("userPreferences.columnWidths.\"Owner.Alias\"")
Phone = jResp.IntOf("userPreferences.columnWidths.Phone")
Name = jResp.IntOf("userPreferences.columnWidths.Name")
ColumnWrapSite = jResp.BoolOf("userPreferences.columnWrap.Site")
ColumnWrapType = jResp.BoolOf("userPreferences.columnWrap.Type")
ColumnWrapBillingCountry = jResp.BoolOf("userPreferences.columnWrap.BillingCountry")
ColumnWrapOwner_Alias = jResp.BoolOf("userPreferences.columnWrap.\"Owner.Alias\"")
ColumnWrapPhone = jResp.BoolOf("userPreferences.columnWrap.Phone")
ColumnWrapName = jResp.BoolOf("userPreferences.columnWrap.Name")
visibility = jResp.stringOf("visibility")
visibilityEditable = jResp.BoolOf("visibilityEditable")
i = 0
count_i = jResp.SizeOfArray("displayColumns")
while i < count_i
    jResp.put_I(i)
    fieldApiName = jResp.stringOf("displayColumns[i].fieldApiName")
    label = jResp.stringOf("displayColumns[i].label")
    lookupId = jResp.stringOf("displayColumns[i].lookupId")
    sortable = jResp.BoolOf("displayColumns[i].sortable")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("filteredByInfo")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("objectApiNames")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("orderedByInfo")
while i < count_i
    jResp.put_I(i)
    fieldApiName = jResp.stringOf("orderedByInfo[i].fieldApiName")
    isAscending = jResp.BoolOf("orderedByInfo[i].isAscending")
    label = jResp.stringOf("orderedByInfo[i].label")
    i = i + 1
end

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}"
    }
  ]
}