Chilkat Tools

autoit / Salesforce Platform APIs / Get Record Edit Page Actions

; 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/actions/record/:RECORD_ID/record-edit",$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)

; {
;   "actions": {
;     "0014H00002LbR7QQAV": {
;       "actions": [
;         {
;           "actionListContext": "RecordEdit",
;           "actionTarget": null,
;           "actionTargetType": "Invoke",
;           "apiName": "SaveEdit",
;           "externalId": "00D58000000arpq:0014H00002LbR7QQAV::RecordEdit:Desktop:StandardButton:SaveEdit",
;           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
;           "id": "0JV4H0000350887WAA",
;           "isMassAction": "false",
;           "label": "Save",
;           "lwcComponent": null,
;           "primaryColor": null,
;           "relatedListRecordId": null,
;           "relatedSourceObject": null,
;           "section": "Page",
;           "sourceObject": "0014H00002LbR7QQAV",
;           "subtype": "LightningWebComponent_Action",
;           "targetObject": "Account",
;           "targetUrl": null,
;           "type": "StandardButton"
;         },
;         {
;           "actionListContext": "RecordEdit",
;           "actionTarget": null,
;           "actionTargetType": "Invoke",
;           "apiName": "SaveAndNew",
;           "externalId": "00D58000000arpq:0014H00002LbR7QQAV::RecordEdit:Desktop:StandardButton:SaveAndNew",
;           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
;           "id": "0JV4H0000350888WAA",
;           "isMassAction": "false",
;           "label": "Save & New",
;           "lwcComponent": null,
;           "primaryColor": null,
;           "relatedListRecordId": null,
;           "relatedSourceObject": null,
;           "section": "Page",
;           "sourceObject": "0014H00002LbR7QQAV",
;           "subtype": "LightningWebComponent_Action",
;           "targetObject": "Account",
;           "targetUrl": null,
;           "type": "StandardButton"
;         },
;         {
;           "actionListContext": "RecordEdit",
;           "actionTarget": null,
;           "actionTargetType": "Invoke",
;           "apiName": "CancelEdit",
;           "externalId": "00D58000000arpq:0014H00002LbR7QQAV::RecordEdit:Desktop:StandardButton:CancelEdit",
;           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
;           "id": "0JV4H0000350889WAA",
;           "isMassAction": "false",
;           "label": "Cancel",
;           "lwcComponent": null,
;           "primaryColor": null,
;           "relatedListRecordId": null,
;           "relatedSourceObject": null,
;           "section": "Page",
;           "sourceObject": "0014H00002LbR7QQAV",
;           "subtype": "LightningWebComponent_Action",
;           "targetObject": "Account",
;           "targetUrl": null,
;           "type": "StandardButton"
;         }
;       ],
;       "links": [
;       ],
;       "url": "/services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/record-edit"
;     }
;   },
;   "eTag": "550367168889732c414e90f1a22d15af",
;   "url": "/services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/record-edit"
; }

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

Local $sActionListContext
Local $sActionTarget
Local $sActionTargetType
Local $sApiName
Local $sExternalId
Local $sIconUrl
Local $sId
Local $sIsMassAction
Local $sLabel
Local $sLwcComponent
Local $sPrimaryColor
Local $sRelatedListRecordId
Local $sRelatedSourceObject
Local $section
Local $sourceObject
Local $subtype
Local $sTargetObject
Local $sTargetUrl
Local $sV_type

Local $sV_Url = $oJResp.StringOf("actions.0014H00002LbR7QQAV.url")
Local $sETag = $oJResp.StringOf("eTag")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("actions.0014H00002LbR7QQAV.actions")
While $i < $iCount_i
    $oJResp.I = $i
    $sActionListContext = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].actionListContext")
    $sActionTarget = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].actionTarget")
    $sActionTargetType = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].actionTargetType")
    $sApiName = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].apiName")
    $sExternalId = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].externalId")
    $sIconUrl = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].iconUrl")
    $sId = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].id")
    $sIsMassAction = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].isMassAction")
    $sLabel = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].label")
    $sLwcComponent = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].lwcComponent")
    $sPrimaryColor = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].primaryColor")
    $sRelatedListRecordId = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].relatedListRecordId")
    $sRelatedSourceObject = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].relatedSourceObject")
    $section = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].section")
    $sourceObject = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].sourceObject")
    $subtype = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].subtype")
    $sTargetObject = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].targetObject")
    $sTargetUrl = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].targetUrl")
    $sV_type = $oJResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].type")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("actions.0014H00002LbR7QQAV.links")
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/actions/record/:RECORD_ID/record-edit

Postman Collection Item JSON

{
  "name": "Get Record Edit Page 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/record/:RECORD_ID/record-edit",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "actions",
        "record",
        ":RECORD_ID",
        "record-edit"
      ],
      "variable": [
        {
          "key": "RECORD_ID",
          "value": "",
          "description": "Record ID"
        }
      ]
    },
    "description": "Get the actions on record detail pages."
  },
  "response": [
    {
      "name": "Get Record Edit Page Actions",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/record-edit",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "actions",
            "record",
            ":RECORD_ID",
            "record-edit"
          ],
          "variable": [
            {
              "key": "RECORD_ID",
              "value": "0014H00002LbR7QQAV",
              "description": "Record ID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:17:45 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": "\"550367168889732c414e90f1a22d15af--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        \"0014H00002LbR7QQAV\": {\n            \"actions\": [\n                {\n                    \"actionListContext\": \"RecordEdit\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"SaveEdit\",\n                    \"externalId\": \"00D58000000arpq:0014H00002LbR7QQAV::RecordEdit:Desktop:StandardButton:SaveEdit\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n                    \"id\": \"0JV4H0000350887WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Save\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": null,\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"0014H00002LbR7QQAV\",\n                    \"subtype\": \"LightningWebComponent_Action\",\n                    \"targetObject\": \"Account\",\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                },\n                {\n                    \"actionListContext\": \"RecordEdit\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"SaveAndNew\",\n                    \"externalId\": \"00D58000000arpq:0014H00002LbR7QQAV::RecordEdit:Desktop:StandardButton:SaveAndNew\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n                    \"id\": \"0JV4H0000350888WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Save &amp; New\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": null,\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"0014H00002LbR7QQAV\",\n                    \"subtype\": \"LightningWebComponent_Action\",\n                    \"targetObject\": \"Account\",\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                },\n                {\n                    \"actionListContext\": \"RecordEdit\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"CancelEdit\",\n                    \"externalId\": \"00D58000000arpq:0014H00002LbR7QQAV::RecordEdit:Desktop:StandardButton:CancelEdit\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n                    \"id\": \"0JV4H0000350889WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Cancel\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": null,\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"0014H00002LbR7QQAV\",\n                    \"subtype\": \"LightningWebComponent_Action\",\n                    \"targetObject\": \"Account\",\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                }\n            ],\n            \"links\": [],\n            \"url\": \"/services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/record-edit\"\n        }\n    },\n    \"eTag\": \"550367168889732c414e90f1a22d15af\",\n    \"url\": \"/services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/record-edit\"\n}"
    }
  ]
}

Chilkat Online Tools

autoit / Salesforce Platform APIs / Get Record Edit Page Actions

Curl Command

Postman Collection Item JSON