Chilkat Online Tools

Android / Salesforce Platform APIs / Get List View Metadata per Id

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

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

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/list-info/:LIST_VIEW_ID",sbResponseBody);
    if (success == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = http.get_LastStatus();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, http.lastHeader());
        Log.i(TAG, "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

    String fieldApiName;
    String lookupId;
    boolean sortable;
    boolean isAscending;

    boolean cloneable = jResp.BoolOf("cloneable");
    boolean createable = jResp.BoolOf("createable");
    boolean deletable = jResp.BoolOf("deletable");
    String eTag = jResp.stringOf("eTag");
    String filterLogicString = jResp.stringOf("filterLogicString");
    String label = jResp.stringOf("label");
    String Id = jResp.stringOf("listReference.id");
    String ListViewApiName = jResp.stringOf("listReference.listViewApiName");
    String ObjectApiName = jResp.stringOf("listReference.objectApiName");
    String v_Type = jResp.stringOf("listReference.type");
    boolean updateable = jResp.BoolOf("updateable");
    int Site = jResp.IntOf("userPreferences.columnWidths.Site");
    int ColumnWidthsType = jResp.IntOf("userPreferences.columnWidths.Type");
    int BillingCountry = jResp.IntOf("userPreferences.columnWidths.BillingCountry");
    int Owner_Alias = jResp.IntOf("userPreferences.columnWidths.\"Owner.Alias\"");
    int Phone = jResp.IntOf("userPreferences.columnWidths.Phone");
    int Name = jResp.IntOf("userPreferences.columnWidths.Name");
    boolean ColumnWrapSite = jResp.BoolOf("userPreferences.columnWrap.Site");
    boolean ColumnWrapType = jResp.BoolOf("userPreferences.columnWrap.Type");
    boolean ColumnWrapBillingCountry = jResp.BoolOf("userPreferences.columnWrap.BillingCountry");
    boolean ColumnWrapOwner_Alias = jResp.BoolOf("userPreferences.columnWrap.\"Owner.Alias\"");
    boolean ColumnWrapPhone = jResp.BoolOf("userPreferences.columnWrap.Phone");
    boolean ColumnWrapName = jResp.BoolOf("userPreferences.columnWrap.Name");
    String visibility = jResp.stringOf("visibility");
    boolean visibilityEditable = jResp.BoolOf("visibilityEditable");
    int i = 0;
    int 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;
        }

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

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

    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;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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