Chilkat Online Tools

lianja / Salesforce Platform APIs / Get MRU List View Actions

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/mru-list/:SOBJECT_API_NAMES",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

// {
//   "actions": {
//     "Account": {
//       "actions": [
//         {
//           "actionListContext": "MruList",
//           "actionTarget": null,
//           "actionTargetType": "Invoke",
//           "apiName": "New",
//           "externalId": "00D58000000arpq:Account::MruList:Desktop:StandardButton:New",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png",
//           "id": "0JV4H0000102212WAA",
//           "isMassAction": "false",
//           "label": "New",
//           "lwcComponent": null,
//           "primaryColor": "1B96FF",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": "Page",
//           "sourceObject": "Account",
//           "subtype": null,
//           "targetObject": "Account",
//           "targetUrl": null,
//           "type": "StandardButton"
//         },
//         {
//           "actionListContext": "MruList",
//           "actionTarget": null,
//           "actionTargetType": null,
//           "apiName": "MruListSort",
//           "externalId": "00D58000000arpq:Account::MruList:Desktop:StandardButton:MruListSort",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/sort_120.png",
//           "id": "0JV4H0000102213WAA",
//           "isMassAction": "false",
//           "label": "Sort",
//           "lwcComponent": null,
//           "primaryColor": "FF538A",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": "Page",
//           "sourceObject": "Account",
//           "subtype": null,
//           "targetObject": "Account",
//           "targetUrl": null,
//           "type": "StandardButton"
//         }
//       ],
//       "links": [
//       ],
//       "url": "/services/data/v58.0/ui-api/actions/mru-list/Account"
//     }
//   },
//   "eTag": "e40070982f76ef03ffdc6f70e91b9321",
//   "url": "/services/data/v58.0/ui-api/actions/mru-list/Account"
// }

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

lcV_Url = loJResp.StringOf("actions.Account.url")
lcETag = loJResp.StringOf("eTag")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("actions.Account.actions")
do while i < lnCount_i
    loJResp.I = i
    lcActionListContext = loJResp.StringOf("actions.Account.actions[i].actionListContext")
    lcActionTarget = loJResp.StringOf("actions.Account.actions[i].actionTarget")
    lcActionTargetType = loJResp.StringOf("actions.Account.actions[i].actionTargetType")
    lcApiName = loJResp.StringOf("actions.Account.actions[i].apiName")
    lcExternalId = loJResp.StringOf("actions.Account.actions[i].externalId")
    lcIconUrl = loJResp.StringOf("actions.Account.actions[i].iconUrl")
    lcId = loJResp.StringOf("actions.Account.actions[i].id")
    lcIsMassAction = loJResp.StringOf("actions.Account.actions[i].isMassAction")
    lcLabel = loJResp.StringOf("actions.Account.actions[i].label")
    lcLwcComponent = loJResp.StringOf("actions.Account.actions[i].lwcComponent")
    lcPrimaryColor = loJResp.StringOf("actions.Account.actions[i].primaryColor")
    lcRelatedListRecordId = loJResp.StringOf("actions.Account.actions[i].relatedListRecordId")
    lcRelatedSourceObject = loJResp.StringOf("actions.Account.actions[i].relatedSourceObject")
    lcSection = loJResp.StringOf("actions.Account.actions[i].section")
    lcSourceObject = loJResp.StringOf("actions.Account.actions[i].sourceObject")
    lcSubtype = loJResp.StringOf("actions.Account.actions[i].subtype")
    lcTargetObject = loJResp.StringOf("actions.Account.actions[i].targetObject")
    lcTargetUrl = loJResp.StringOf("actions.Account.actions[i].targetUrl")
    lcV_type = loJResp.StringOf("actions.Account.actions[i].type")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("actions.Account.links")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get MRU List View Actions",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/mru-list/:SOBJECT_API_NAMES",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "actions",
        "mru-list",
        ":SOBJECT_API_NAMES"
      ],
      "variable": [
        {
          "key": "SOBJECT_API_NAMES",
          "value": "",
          "description": "An object name, or a comma-delimited list of object names."
        }
      ]
    },
    "description": "Get the header actions on the most recently used (MRU) list view for objects."
  },
  "response": [
    {
      "name": "Get MRU List View Actions",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/mru-list/:SOBJECT_API_NAMES",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "actions",
            "mru-list",
            ":SOBJECT_API_NAMES"
          ],
          "variable": [
            {
              "key": "SOBJECT_API_NAMES",
              "value": "Account",
              "description": "An object name, or a comma-delimited list of object names."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 11:48:01 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": "\"e40070982f76ef03ffdc6f70e91b9321--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    \"actions\": {\n        \"Account\": {\n            \"actions\": [\n                {\n                    \"actionListContext\": \"MruList\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"New\",\n                    \"externalId\": \"00D58000000arpq:Account::MruList:Desktop:StandardButton:New\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png\",\n                    \"id\": \"0JV4H0000102212WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"New\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"1B96FF\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"Account\",\n                    \"subtype\": null,\n                    \"targetObject\": \"Account\",\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                },\n                {\n                    \"actionListContext\": \"MruList\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": null,\n                    \"apiName\": \"MruListSort\",\n                    \"externalId\": \"00D58000000arpq:Account::MruList:Desktop:StandardButton:MruListSort\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/sort_120.png\",\n                    \"id\": \"0JV4H0000102213WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Sort\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"FF538A\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"Account\",\n                    \"subtype\": null,\n                    \"targetObject\": \"Account\",\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                }\n            ],\n            \"links\": [],\n            \"url\": \"/services/data/v58.0/ui-api/actions/mru-list/Account\"\n        }\n    },\n    \"eTag\": \"e40070982f76ef03ffdc6f70e91b9321\",\n    \"url\": \"/services/data/v58.0/ui-api/actions/mru-list/Account\"\n}"
    }
  ]
}