Chilkat Tools

phpAx / Salesforce Platform APIs / Get Record Edit Page Actions

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/record-edit',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

$v_Url = $jResp->stringOf('actions.0014H00002LbR7QQAV.url');
$eTag = $jResp->stringOf('eTag');
$url = $jResp->stringOf('url');
$i = 0;
$count_i = $jResp->SizeOfArray('actions.0014H00002LbR7QQAV.actions');
while ($i < $count_i) {
    $jResp->I = $i;
    $actionListContext = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].actionListContext');
    $actionTarget = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].actionTarget');
    $actionTargetType = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].actionTargetType');
    $apiName = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].apiName');
    $externalId = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].externalId');
    $iconUrl = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].iconUrl');
    $id = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].id');
    $isMassAction = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].isMassAction');
    $label = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].label');
    $lwcComponent = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].lwcComponent');
    $primaryColor = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].primaryColor');
    $relatedListRecordId = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].relatedListRecordId');
    $relatedSourceObject = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].relatedSourceObject');
    $section = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].section');
    $sourceObject = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].sourceObject');
    $subtype = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].subtype');
    $targetObject = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].targetObject');
    $targetUrl = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].targetUrl');
    $v_type = $jResp->stringOf('actions.0014H00002LbR7QQAV.actions[i].type');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('actions.0014H00002LbR7QQAV.links');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}


?>

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

phpAx / Salesforce Platform APIs / Get Record Edit Page Actions

Curl Command

Postman Collection Item JSON