Chilkat Online Tools

Delphi (DLL) / Salesforce Platform APIs / Get List View Metadata per Id

Back to Collection Items

var

begin
CkHttp_putAuthToken(http,'<access_token>');success := CkHttp_QuickGetSb(http,'https://domain.com/services/data/v{{version}}/ui-api/list-info/:LIST_VIEW_ID',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);fieldApiName := CkJsonObject__stringOf(jResp,'displayColumns[i].fieldApiName');label := CkJsonObject__stringOf(jResp,'displayColumns[i].label');lookupId := CkJsonObject__stringOf(jResp,'displayColumns[i].lookupId');sortable := CkJsonObject_BoolOf(jResp,'displayColumns[i].sortable');i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'filteredByInfo');CkJsonObject_putI(jResp,i);i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'objectApiNames');CkJsonObject_putI(jResp,i);i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'orderedByInfo');CkJsonObject_putI(jResp,i);fieldApiName := CkJsonObject__stringOf(jResp,'orderedByInfo[i].fieldApiName');isAscending := CkJsonObject_BoolOf(jResp,'orderedByInfo[i].isAscending');label := CkJsonObject__stringOf(jResp,'orderedByInfo[i].label');i := i + 1;

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