Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/services/data/v{{version}}/ui-api/actions/list-view/:LIST_VIEW_IDS',$sbResponseBody);
if ($success == false) {
print $http->lastErrorText() . "\n";
exit;
}
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->get_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": {
// "00B58000002ssinEAA": {
// "actions": [
// {
// "actionListContext": "ListView",
// "actionTarget": null,
// "actionTargetType": "Invoke",
// "apiName": "EditFilter",
// "externalId": "00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:EditFilter",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/filter_120.png",
// "id": "0JV4H0000132177WAA",
// "isMassAction": "false",
// "label": "Filter",
// "lwcComponent": null,
// "primaryColor": "0176D3",
// "relatedListRecordId": null,
// "relatedSourceObject": null,
// "section": "Page",
// "sourceObject": "00B58000002ssinEAA",
// "subtype": null,
// "targetObject": "Account",
// "targetUrl": null,
// "type": "StandardButton"
// },
// {
// "actionListContext": "ListView",
// "actionTarget": null,
// "actionTargetType": "Invoke",
// "apiName": "ListSort",
// "externalId": "00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:ListSort",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/sort_120.png",
// "id": "0JV4H0000132178WAA",
// "isMassAction": "false",
// "label": "Sort",
// "lwcComponent": null,
// "primaryColor": "FF538A",
// "relatedListRecordId": null,
// "relatedSourceObject": null,
// "section": "Page",
// "sourceObject": "00B58000002ssinEAA",
// "subtype": null,
// "targetObject": "Account",
// "targetUrl": null,
// "type": "StandardButton"
// },
// {
// "actionListContext": "ListView",
// "actionTarget": null,
// "actionTargetType": "Invoke",
// "apiName": "New",
// "externalId": "00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:New",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png",
// "id": "0JV4H0000132179WAA",
// "isMassAction": "false",
// "label": "New",
// "lwcComponent": null,
// "primaryColor": "1B96FF",
// "relatedListRecordId": null,
// "relatedSourceObject": null,
// "section": "Page",
// "sourceObject": "00B58000002ssinEAA",
// "subtype": null,
// "targetObject": "Account",
// "targetUrl": null,
// "type": "StandardButton"
// },
// {
// "actionListContext": "ListView",
// "actionTarget": null,
// "actionTargetType": null,
// "apiName": "PrintableListView",
// "externalId": "00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:PrintableListView",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
// "id": "0JV4H0000132180WAA",
// "isMassAction": "false",
// "label": "Printable View",
// "lwcComponent": null,
// "primaryColor": null,
// "relatedListRecordId": null,
// "relatedSourceObject": null,
// "section": "Page",
// "sourceObject": "00B58000002ssinEAA",
// "subtype": null,
// "targetObject": "Account",
// "targetUrl": null,
// "type": "StandardButton"
// }
// ],
// "links": [
// ],
// "url": "/services/data/v58.0/ui-api/actions/list-view/00B58000002ssinEAA"
// }
// },
// "eTag": "6f6e964d38807defe01bd28d144c9c0e",
// "url": "/services/data/v58.0/ui-api/actions/list-view/00B58000002ssinEAA"
// }
// 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.00B58000002ssinEAA.url');
$eTag = $jResp->stringOf('eTag');
$url = $jResp->stringOf('url');
$i = 0;
$count_i = $jResp->SizeOfArray('actions.00B58000002ssinEAA.actions');
while ($i < $count_i) {
$jResp->put_I($i);
$actionListContext = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].actionListContext');
$actionTarget = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].actionTarget');
$actionTargetType = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].actionTargetType');
$apiName = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].apiName');
$externalId = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].externalId');
$iconUrl = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].iconUrl');
$id = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].id');
$isMassAction = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].isMassAction');
$label = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].label');
$lwcComponent = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].lwcComponent');
$primaryColor = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].primaryColor');
$relatedListRecordId = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].relatedListRecordId');
$relatedSourceObject = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].relatedSourceObject');
$section = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].section');
$sourceObject = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].sourceObject');
$subtype = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].subtype');
$targetObject = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].targetObject');
$targetUrl = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].targetUrl');
$v_type = $jResp->stringOf('actions.00B58000002ssinEAA.actions[i].type');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('actions.00B58000002ssinEAA.links');
while ($i < $count_i) {
$jResp->put_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/list-view/:LIST_VIEW_IDS
Postman Collection Item JSON
{
"name": "Get List View Header 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/list-view/:LIST_VIEW_IDS",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"list-view",
":LIST_VIEW_IDS"
],
"variable": [
{
"key": "LIST_VIEW_IDS",
"value": "",
"description": "A single list view ID, or a comma-delimited list of list view IDs."
}
]
},
"description": "Get the actions on records in related lists."
},
"response": [
{
"name": "Get List View Header Actions",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/list-view/:LIST_VIEW_IDS",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"list-view",
":LIST_VIEW_IDS"
],
"variable": [
{
"key": "LIST_VIEW_IDS",
"value": "00B58000002ssinEAA",
"description": "A single list view ID, or a comma-delimited list of list view IDs."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 11:39:25 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": "\"6f6e964d38807defe01bd28d144c9c0e--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 \"00B58000002ssinEAA\": {\n \"actions\": [\n {\n \"actionListContext\": \"ListView\",\n \"actionTarget\": null,\n \"actionTargetType\": \"Invoke\",\n \"apiName\": \"EditFilter\",\n \"externalId\": \"00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:EditFilter\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/filter_120.png\",\n \"id\": \"0JV4H0000132177WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Filter\",\n \"lwcComponent\": null,\n \"primaryColor\": \"0176D3\",\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"00B58000002ssinEAA\",\n \"subtype\": null,\n \"targetObject\": \"Account\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n },\n {\n \"actionListContext\": \"ListView\",\n \"actionTarget\": null,\n \"actionTargetType\": \"Invoke\",\n \"apiName\": \"ListSort\",\n \"externalId\": \"00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:ListSort\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/sort_120.png\",\n \"id\": \"0JV4H0000132178WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Sort\",\n \"lwcComponent\": null,\n \"primaryColor\": \"FF538A\",\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"00B58000002ssinEAA\",\n \"subtype\": null,\n \"targetObject\": \"Account\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n },\n {\n \"actionListContext\": \"ListView\",\n \"actionTarget\": null,\n \"actionTargetType\": \"Invoke\",\n \"apiName\": \"New\",\n \"externalId\": \"00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:New\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png\",\n \"id\": \"0JV4H0000132179WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"New\",\n \"lwcComponent\": null,\n \"primaryColor\": \"1B96FF\",\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"00B58000002ssinEAA\",\n \"subtype\": null,\n \"targetObject\": \"Account\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n },\n {\n \"actionListContext\": \"ListView\",\n \"actionTarget\": null,\n \"actionTargetType\": null,\n \"apiName\": \"PrintableListView\",\n \"externalId\": \"00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:PrintableListView\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n \"id\": \"0JV4H0000132180WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Printable View\",\n \"lwcComponent\": null,\n \"primaryColor\": null,\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"00B58000002ssinEAA\",\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/list-view/00B58000002ssinEAA\"\n }\n },\n \"eTag\": \"6f6e964d38807defe01bd28d144c9c0e\",\n \"url\": \"/services/data/v58.0/ui-api/actions/list-view/00B58000002ssinEAA\"\n}"
}
]
}
