Chilkat Online Tools

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

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // 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

    var fieldApiName: String?
    var lookupId: String?
    var sortable: Bool
    var isAscending: Bool

    var cloneable: Bool = jResp.BoolOf("cloneable")
    var createable: Bool = jResp.BoolOf("createable")
    var deletable: Bool = jResp.BoolOf("deletable")
    var eTag: String? = jResp.StringOf("eTag")
    var filterLogicString: String? = jResp.StringOf("filterLogicString")
    var label: String? = jResp.StringOf("label")
    var Id: String? = jResp.StringOf("listReference.id")
    var ListViewApiName: String? = jResp.StringOf("listReference.listViewApiName")
    var ObjectApiName: String? = jResp.StringOf("listReference.objectApiName")
    var v_Type: String? = jResp.StringOf("listReference.type")
    var updateable: Bool = jResp.BoolOf("updateable")
    var Site: Int = jResp.IntOf("userPreferences.columnWidths.Site").intValue
    var ColumnWidthsType: Int = jResp.IntOf("userPreferences.columnWidths.Type").intValue
    var BillingCountry: Int = jResp.IntOf("userPreferences.columnWidths.BillingCountry").intValue
    var Owner_Alias: Int = jResp.IntOf("userPreferences.columnWidths.\"Owner.Alias\"").intValue
    var Phone: Int = jResp.IntOf("userPreferences.columnWidths.Phone").intValue
    var Name: Int = jResp.IntOf("userPreferences.columnWidths.Name").intValue
    var ColumnWrapSite: Bool = jResp.BoolOf("userPreferences.columnWrap.Site")
    var ColumnWrapType: Bool = jResp.BoolOf("userPreferences.columnWrap.Type")
    var ColumnWrapBillingCountry: Bool = jResp.BoolOf("userPreferences.columnWrap.BillingCountry")
    var ColumnWrapOwner_Alias: Bool = jResp.BoolOf("userPreferences.columnWrap.\"Owner.Alias\"")
    var ColumnWrapPhone: Bool = jResp.BoolOf("userPreferences.columnWrap.Phone")
    var ColumnWrapName: Bool = jResp.BoolOf("userPreferences.columnWrap.Name")
    var visibility: String? = jResp.StringOf("visibility")
    var visibilityEditable: Bool = jResp.BoolOf("visibilityEditable")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("displayColumns").intValue
    while i < count_i {
        jResp.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
    }

    i = 0
    count_i = jResp.SizeOfArray("filteredByInfo").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("objectApiNames").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("orderedByInfo").intValue
    while i < count_i {
        jResp.I = i
        fieldApiName = jResp.StringOf("orderedByInfo[i].fieldApiName")
        isAscending = jResp.BoolOf("orderedByInfo[i].isAscending")
        label = jResp.StringOf("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/: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}"
    }
  ]
}