Chilkat Online Tools

Node.js / Salesforce Platform APIs / Get Lookup Field Actions

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/lookup/:SOBJECT_API_NAMES",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

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

    // {
    //   "actions": {
    //     "Account": {
    //       "actions": [
    //         {
    //           "actionListContext": "Lookup",
    //           "actionTarget": null,
    //           "actionTargetType": "Invoke",
    //           "apiName": "CreateFromLookup",
    //           "externalId": "00D58000000arpq:Account::Lookup:Desktop:StandardButton:CreateFromLookup",
    //           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png",
    //           "id": "0JV4H0000327596WAA",
    //           "isMassAction": "false",
    //           "label": "New",
    //           "lwcComponent": null,
    //           "primaryColor": "1B96FF",
    //           "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/lookup/Account"
    //     }
    //   },
    //   "eTag": "1b573078964111c994670eea1c038003",
    //   "url": "/services/data/v58.0/ui-api/actions/lookup/Account"
    // }

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

    var actionListContext;
    var actionTarget;
    var actionTargetType;
    var apiName;
    var externalId;
    var iconUrl;
    var id;
    var isMassAction;
    var label;
    var lwcComponent;
    var primaryColor;
    var relatedListRecordId;
    var relatedSourceObject;
    var section;
    var sourceObject;
    var subtype;
    var targetObject;
    var targetUrl;
    var v_type;

    var v_Url = jResp.StringOf("actions.Account.url");
    var eTag = jResp.StringOf("eTag");
    var url = jResp.StringOf("url");
    var i = 0;
    var count_i = jResp.SizeOfArray("actions.Account.actions");
    while (i < count_i) {
        jResp.I = i;
        actionListContext = jResp.StringOf("actions.Account.actions[i].actionListContext");
        actionTarget = jResp.StringOf("actions.Account.actions[i].actionTarget");
        actionTargetType = jResp.StringOf("actions.Account.actions[i].actionTargetType");
        apiName = jResp.StringOf("actions.Account.actions[i].apiName");
        externalId = jResp.StringOf("actions.Account.actions[i].externalId");
        iconUrl = jResp.StringOf("actions.Account.actions[i].iconUrl");
        id = jResp.StringOf("actions.Account.actions[i].id");
        isMassAction = jResp.StringOf("actions.Account.actions[i].isMassAction");
        label = jResp.StringOf("actions.Account.actions[i].label");
        lwcComponent = jResp.StringOf("actions.Account.actions[i].lwcComponent");
        primaryColor = jResp.StringOf("actions.Account.actions[i].primaryColor");
        relatedListRecordId = jResp.StringOf("actions.Account.actions[i].relatedListRecordId");
        relatedSourceObject = jResp.StringOf("actions.Account.actions[i].relatedSourceObject");
        section = jResp.StringOf("actions.Account.actions[i].section");
        sourceObject = jResp.StringOf("actions.Account.actions[i].sourceObject");
        subtype = jResp.StringOf("actions.Account.actions[i].subtype");
        targetObject = jResp.StringOf("actions.Account.actions[i].targetObject");
        targetUrl = jResp.StringOf("actions.Account.actions[i].targetUrl");
        v_type = jResp.StringOf("actions.Account.actions[i].type");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("actions.Account.links");
    while (i < count_i) {
        jResp.I = i;
        i = i+1;
    }


}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get Lookup Field 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/lookup/:SOBJECT_API_NAMES",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "actions",
        "lookup",
        ":SOBJECT_API_NAMES"
      ],
      "variable": [
        {
          "key": "SOBJECT_API_NAMES",
          "value": "",
          "description": "A lookup field name, or a comma-delimited list of lookup field names."
        }
      ]
    },
    "description": "Get the actions on Lightning pages (FlexiPages)."
  },
  "response": [
    {
      "name": "Get Lookup Field Actions",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/lookup/:SOBJECT_API_NAMES",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "actions",
            "lookup",
            ":SOBJECT_API_NAMES"
          ],
          "variable": [
            {
              "key": "SOBJECT_API_NAMES",
              "value": "Account",
              "description": "A lookup field name, or a comma-delimited list of lookup field names."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 11:47:33 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": "\"1b573078964111c994670eea1c038003--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\": \"Lookup\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"CreateFromLookup\",\n                    \"externalId\": \"00D58000000arpq:Account::Lookup:Desktop:StandardButton:CreateFromLookup\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png\",\n                    \"id\": \"0JV4H0000327596WAA\",\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            \"links\": [],\n            \"url\": \"/services/data/v58.0/ui-api/actions/lookup/Account\"\n        }\n    },\n    \"eTag\": \"1b573078964111c994670eea1c038003\",\n    \"url\": \"/services/data/v58.0/ui-api/actions/lookup/Account\"\n}"
    }
  ]
}