Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *actionListContext;
const wchar_t *actionTarget;
const wchar_t *actionTargetType;
const wchar_t *apiName;
const wchar_t *externalId;
const wchar_t *iconUrl;
const wchar_t *id;
const wchar_t *isMassAction;
const wchar_t *label;
const wchar_t *lwcComponent;
const wchar_t *primaryColor;
const wchar_t *relatedListRecordId;
const wchar_t *relatedSourceObject;
const wchar_t *section;
const wchar_t *sourceObject;
const wchar_t *subtype;
const wchar_t *targetObject;
const wchar_t *targetUrl;
const wchar_t *v_type;
const wchar_t *v_Url;
const wchar_t *eTag;
const wchar_t *url;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://domain.com/services/data/v{{version}}/ui-api/actions/list-view/:LIST_VIEW_IDS",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
v_Url = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.url");
eTag = CkJsonObjectW_stringOf(jResp,L"eTag");
url = CkJsonObjectW_stringOf(jResp,L"url");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"actions.00B58000002ssinEAA.actions");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
actionListContext = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].actionListContext");
actionTarget = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].actionTarget");
actionTargetType = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].actionTargetType");
apiName = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].apiName");
externalId = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].externalId");
iconUrl = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].iconUrl");
id = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].id");
isMassAction = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].isMassAction");
label = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].label");
lwcComponent = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].lwcComponent");
primaryColor = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].primaryColor");
relatedListRecordId = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].relatedListRecordId");
relatedSourceObject = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].relatedSourceObject");
section = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].section");
sourceObject = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].sourceObject");
subtype = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].subtype");
targetObject = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].targetObject");
targetUrl = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].targetUrl");
v_type = CkJsonObjectW_stringOf(jResp,L"actions.00B58000002ssinEAA.actions[i].type");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"actions.00B58000002ssinEAA.links");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
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}"
}
]
}
