Chilkat Online Tools

PowerBuilder / Salesforce Platform APIs / Get Record Edit Page Actions

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_ActionListContext
string ls_ActionTarget
string ls_ActionTargetType
string ls_ApiName
string ls_ExternalId
string ls_IconUrl
string ls_Id
string ls_IsMassAction
string ls_Label
string ls_LwcComponent
string ls_PrimaryColor
string ls_RelatedListRecordId
string ls_RelatedSourceObject
string ls_Section
string ls_SourceObject
string ls_Subtype
string ls_TargetObject
string ls_TargetUrl
string ls_V_type
string ls_V_Url
string ls_ETag
string ls_Url
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/record-edit",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

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

ls_V_Url = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.url")
ls_ETag = loo_JResp.StringOf("eTag")
ls_Url = loo_JResp.StringOf("url")
i = 0
li_Count_i = loo_JResp.SizeOfArray("actions.0014H00002LbR7QQAV.actions")
do while i < li_Count_i
    loo_JResp.I = i
    ls_ActionListContext = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].actionListContext")
    ls_ActionTarget = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].actionTarget")
    ls_ActionTargetType = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].actionTargetType")
    ls_ApiName = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].apiName")
    ls_ExternalId = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].externalId")
    ls_IconUrl = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].iconUrl")
    ls_Id = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].id")
    ls_IsMassAction = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].isMassAction")
    ls_Label = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].label")
    ls_LwcComponent = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].lwcComponent")
    ls_PrimaryColor = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].primaryColor")
    ls_RelatedListRecordId = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].relatedListRecordId")
    ls_RelatedSourceObject = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].relatedSourceObject")
    ls_Section = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].section")
    ls_SourceObject = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].sourceObject")
    ls_Subtype = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].subtype")
    ls_TargetObject = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].targetObject")
    ls_TargetUrl = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].targetUrl")
    ls_V_type = loo_JResp.StringOf("actions.0014H00002LbR7QQAV.actions[i].type")
    i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("actions.0014H00002LbR7QQAV.links")
do while i < li_Count_i
    loo_JResp.I = i
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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