Chilkat Online Tools

C# / Salesforce Platform APIs / Get Lightning Page Actions

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

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

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "actions": {
//     "Sample_Lightning_page": {
//       "actions": [
//         {
//           "actionListContext": "Flexipage",
//           "actionTarget": "/services/data/v58.0/quickActions/LogACall/describe",
//           "actionTargetType": "Describe",
//           "apiName": "Global.LogACall",
//           "externalId": "00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png",
//           "id": "0JV4H0000295294WAA",
//           "isMassAction": "false",
//           "label": "Log a Call",
//           "lwcComponent": null,
//           "primaryColor": "06A59A",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": null,
//           "sourceObject": "Sample_Lightning_page",
//           "subtype": "LogACall",
//           "targetObject": "Task",
//           "targetUrl": null,
//           "type": "QuickAction"
//         },
//         {
//           "actionListContext": "Flexipage",
//           "actionTarget": "/services/data/v58.0/quickActions/NewAccount/describe",
//           "actionTargetType": "Describe",
//           "apiName": "Global.NewAccount",
//           "externalId": "00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png",
//           "id": "0JV4H0000295295WAA",
//           "isMassAction": "false",
//           "label": "New Account",
//           "lwcComponent": null,
//           "primaryColor": "5867E8",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": null,
//           "sourceObject": "Sample_Lightning_page",
//           "subtype": "Create",
//           "targetObject": "Account",
//           "targetUrl": null,
//           "type": "QuickAction"
//         }
//       ],
//       "links": [
//       ],
//       "url": "/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page"
//     }
//   },
//   "eTag": "ff4486597111fb5e059e5dab793c8231",
//   "url": "/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page"
// }

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

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

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

i = 0;
count_i = jResp.SizeOfArray("actions.Sample_Lightning_page.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/flexipage/:FLEXIPAGE_NAMES

Postman Collection Item JSON

{
  "name": "Get Lightning 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/flexipage/:FLEXIPAGE_NAMES",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "actions",
        "flexipage",
        ":FLEXIPAGE_NAMES"
      ],
      "variable": [
        {
          "key": "FLEXIPAGE_NAMES",
          "value": "",
          "description": "A Lightning page name, or a comma-delimited list of Lightning page names."
        }
      ]
    },
    "description": "Get the actions on Lightning pages (FlexiPages)."
  },
  "response": [
    {
      "name": "Get Lightning Page Actions",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "actions",
            "flexipage",
            ":FLEXIPAGE_NAMES"
          ],
          "variable": [
            {
              "key": "FLEXIPAGE_NAMES",
              "value": "Sample_Lightning_page",
              "description": "A Lightning page name, or a comma-delimited list of Lightning page names."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 11:45:49 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": "\"ff4486597111fb5e059e5dab793c8231--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        \"Sample_Lightning_page\": {\n            \"actions\": [\n                {\n                    \"actionListContext\": \"Flexipage\",\n                    \"actionTarget\": \"/services/data/v58.0/quickActions/LogACall/describe\",\n                    \"actionTargetType\": \"Describe\",\n                    \"apiName\": \"Global.LogACall\",\n                    \"externalId\": \"00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png\",\n                    \"id\": \"0JV4H0000295294WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Log a Call\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"06A59A\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": null,\n                    \"sourceObject\": \"Sample_Lightning_page\",\n                    \"subtype\": \"LogACall\",\n                    \"targetObject\": \"Task\",\n                    \"targetUrl\": null,\n                    \"type\": \"QuickAction\"\n                },\n                {\n                    \"actionListContext\": \"Flexipage\",\n                    \"actionTarget\": \"/services/data/v58.0/quickActions/NewAccount/describe\",\n                    \"actionTargetType\": \"Describe\",\n                    \"apiName\": \"Global.NewAccount\",\n                    \"externalId\": \"00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png\",\n                    \"id\": \"0JV4H0000295295WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"New Account\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"5867E8\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": null,\n                    \"sourceObject\": \"Sample_Lightning_page\",\n                    \"subtype\": \"Create\",\n                    \"targetObject\": \"Account\",\n                    \"targetUrl\": null,\n                    \"type\": \"QuickAction\"\n                }\n            ],\n            \"links\": [],\n            \"url\": \"/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page\"\n        }\n    },\n    \"eTag\": \"ff4486597111fb5e059e5dab793c8231\",\n    \"url\": \"/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page\"\n}"
    }
  ]
}