Chilkat Online Tools

autoit / Salesforce Platform APIs / Get Most Recently Used List View Metadata

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "cloneable": false,
;   "createable": true,
;   "deletable": false,
;   "displayColumns": [
;     {
;       "fieldApiName": "Name",
;       "label": "Account Name",
;       "lookupId": null,
;       "sortable": true
;     },
;     {
;       "fieldApiName": "Site",
;       "label": "Account Site",
;       "lookupId": null,
;       "sortable": true
;     },
;     {
;       "fieldApiName": "Phone",
;       "label": "Phone",
;       "lookupId": null,
;       "sortable": true
;     },
;     {
;       "fieldApiName": "Owner.Alias",
;       "label": "Account Owner Alias",
;       "lookupId": null,
;       "sortable": true
;     }
;   ],
;   "eTag": "4c63719f66dbb57c7cb86c2effc5f08b",
;   "filterLogicString": null,
;   "filteredByInfo": [
;   ],
;   "label": "Recently Viewed",
;   "listReference": {
;     "id": null,
;     "listViewApiName": null,
;     "objectApiName": "Account",
;     "type": "mru"
;   },
;   "objectApiNames": [
;   ],
;   "orderedByInfo": [
;   ],
;   "updateable": false,
;   "userPreferences": {
;     "columnWidths": {
;       "Site": -1,
;       "Owner.Alias": -1,
;       "Phone": -1,
;       "Name": -1
;     },
;     "columnWrap": {
;       "Site": false,
;       "Owner.Alias": false,
;       "Phone": false,
;       "Name": false
;     }
;   },
;   "visibility": "Public",
;   "visibilityEditable": false
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sFieldApiName
Local $sLookupId
Local $bSortable

Local $bCloneable = $oJResp.BoolOf("cloneable")
Local $bCreateable = $oJResp.BoolOf("createable")
Local $bDeletable = $oJResp.BoolOf("deletable")
Local $sETag = $oJResp.StringOf("eTag")
Local $sFilterLogicString = $oJResp.StringOf("filterLogicString")
Local $sLabel = $oJResp.StringOf("label")
Local $sId = $oJResp.StringOf("listReference.id")
Local $sListViewApiName = $oJResp.StringOf("listReference.listViewApiName")
Local $sObjectApiName = $oJResp.StringOf("listReference.objectApiName")
Local $sV_Type = $oJResp.StringOf("listReference.type")
Local $bUpdateable = $oJResp.BoolOf("updateable")
Local $iSite = $oJResp.IntOf("userPreferences.columnWidths.Site")
Local $iOwner_Alias = $oJResp.IntOf("userPreferences.columnWidths.""Owner.Alias""")
Local $iPhone = $oJResp.IntOf("userPreferences.columnWidths.Phone")
Local $iName = $oJResp.IntOf("userPreferences.columnWidths.Name")
Local $bColumnWrapSite = $oJResp.BoolOf("userPreferences.columnWrap.Site")
Local $bColumnWrapOwner_Alias = $oJResp.BoolOf("userPreferences.columnWrap.""Owner.Alias""")
Local $bColumnWrapPhone = $oJResp.BoolOf("userPreferences.columnWrap.Phone")
Local $bColumnWrapName = $oJResp.BoolOf("userPreferences.columnWrap.Name")
Local $sVisibility = $oJResp.StringOf("visibility")
Local $bVisibilityEditable = $oJResp.BoolOf("visibilityEditable")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("displayColumns")
While $i < $iCount_i
    $oJResp.I = $i
    $sFieldApiName = $oJResp.StringOf("displayColumns[i].fieldApiName")
    $sLabel = $oJResp.StringOf("displayColumns[i].label")
    $sLookupId = $oJResp.StringOf("displayColumns[i].lookupId")
    $bSortable = $oJResp.BoolOf("displayColumns[i].sortable")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("filteredByInfo")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("objectApiNames")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("orderedByInfo")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME

Postman Collection Item JSON

{
  "name": "Get Most Recently Used List View Metadata",
  "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/mru-list-info/:SOBJECT_API_NAME",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "mru-list-info",
        ":SOBJECT_API_NAME"
      ],
      "variable": [
        {
          "key": "SOBJECT_API_NAME",
          "value": "",
          "description": "Object API name"
        }
      ]
    },
    "description": "Returns metadata for an object’s most recently viewed (MRU) list view."
  },
  "response": [
    {
      "name": "Get Most Recently Used List View Metadata",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/mru-list-info/:SOBJECT_API_NAME",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "mru-list-info",
            ":SOBJECT_API_NAME"
          ],
          "variable": [
            {
              "key": "SOBJECT_API_NAME",
              "value": "Account",
              "description": "Object API name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:00:00 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": "\"4c63719f66dbb57c7cb86c2effc5f08b--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\": false,\n    \"createable\": true,\n    \"deletable\": false,\n    \"displayColumns\": [\n        {\n            \"fieldApiName\": \"Name\",\n            \"label\": \"Account Name\",\n            \"lookupId\": null,\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\": \"Owner.Alias\",\n            \"label\": \"Account Owner Alias\",\n            \"lookupId\": null,\n            \"sortable\": true\n        }\n    ],\n    \"eTag\": \"4c63719f66dbb57c7cb86c2effc5f08b\",\n    \"filterLogicString\": null,\n    \"filteredByInfo\": [],\n    \"label\": \"Recently Viewed\",\n    \"listReference\": {\n        \"id\": null,\n        \"listViewApiName\": null,\n        \"objectApiName\": \"Account\",\n        \"type\": \"mru\"\n    },\n    \"objectApiNames\": [],\n    \"orderedByInfo\": [],\n    \"updateable\": false,\n    \"userPreferences\": {\n        \"columnWidths\": {\n            \"Site\": -1,\n            \"Owner.Alias\": -1,\n            \"Phone\": -1,\n            \"Name\": -1\n        },\n        \"columnWrap\": {\n            \"Site\": false,\n            \"Owner.Alias\": false,\n            \"Phone\": false,\n            \"Name\": false\n        }\n    },\n    \"visibility\": \"Public\",\n    \"visibilityEditable\": false\n}"
    }
  ]
}