Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
actionListContext: WideString;
actionTarget: WideString;
actionTargetType: WideString;
apiName: WideString;
externalId: WideString;
iconUrl: WideString;
id: WideString;
isMassAction: WideString;
label: WideString;
lwcComponent: WideString;
primaryColor: WideString;
relatedListRecordId: WideString;
relatedSourceObject: WideString;
section: WideString;
sourceObject: WideString;
subtype: WideString;
targetObject: WideString;
targetUrl: WideString;
v_type: WideString;
v_Url: WideString;
eTag: WideString;
url: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS',sbResponseBody.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(http.LastHeader);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "actions": {
// "00158000006QBOhAAO": {
// "actions": [
// {
// "actionListContext": "RelatedListRecord",
// "actionTarget": null,
// "actionTargetType": "Invoke",
// "apiName": "Edit",
// "externalId": "00D58000000arpq:00158000006QBOhAAO::RelatedListRecord:Desktop:StandardButton:Edit",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/edit_120.png",
// "id": "0JV4H0000122896WAA",
// "isMassAction": "false",
// "label": "Edit",
// "lwcComponent": null,
// "primaryColor": "06A59A",
// "relatedListRecordId": "00358000006woxwAAA",
// "relatedSourceObject": "Contacts",
// "section": "Page",
// "sourceObject": "00158000006QBOhAAO",
// "subtype": null,
// "targetObject": "Contact",
// "targetUrl": null,
// "type": "StandardButton"
// },
// {
// "actionListContext": "RelatedListRecord",
// "actionTarget": null,
// "actionTargetType": "Invoke",
// "apiName": "Delete",
// "externalId": "00D58000000arpq:00158000006QBOhAAO::RelatedListRecord:Desktop:StandardButton:Delete",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/delete_120.png",
// "id": "0JV4H0000122897WAA",
// "isMassAction": "false",
// "label": "Delete",
// "lwcComponent": null,
// "primaryColor": "FF538A",
// "relatedListRecordId": "00358000006woxwAAA",
// "relatedSourceObject": "Contacts",
// "section": "Page",
// "sourceObject": "00158000006QBOhAAO",
// "subtype": null,
// "targetObject": "Contact",
// "targetUrl": null,
// "type": "StandardButton"
// }
// ],
// "links": [
// ],
// "url": "/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list-record/00358000006woxwAAA"
// }
// },
// "eTag": "f29ba79a7eda15543fca804e0e88bea6",
// "url": "/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list-record/00358000006woxwAAA"
// }
// 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.00158000006QBOhAAO.url');
eTag := jResp.StringOf('eTag');
url := jResp.StringOf('url');
i := 0;
count_i := jResp.SizeOfArray('actions.00158000006QBOhAAO.actions');
while i < count_i do
begin
jResp.I := i;
actionListContext := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].actionListContext');
actionTarget := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].actionTarget');
actionTargetType := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].actionTargetType');
apiName := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].apiName');
externalId := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].externalId');
iconUrl := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].iconUrl');
id := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].id');
isMassAction := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].isMassAction');
label := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].label');
lwcComponent := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].lwcComponent');
primaryColor := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].primaryColor');
relatedListRecordId := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].relatedListRecordId');
relatedSourceObject := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].relatedSourceObject');
section := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].section');
sourceObject := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].sourceObject');
subtype := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].subtype');
targetObject := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].targetObject');
targetUrl := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].targetUrl');
v_type := jResp.StringOf('actions.00158000006QBOhAAO.actions[i].type');
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('actions.00158000006QBOhAAO.links');
while i < count_i do
begin
jResp.I := i;
i := i + 1;
end;
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS
Postman Collection Item JSON
{
"name": "Get Related List Record 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/related-list-record/:RELATED_LIST_RECORD_IDS",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"record",
":RECORD_ID",
"related-list-record",
":RELATED_LIST_RECORD_IDS"
],
"variable": [
{
"key": "RECORD_ID",
"value": "",
"description": "Record ID"
},
{
"key": "RELATED_LIST_RECORD_IDS",
"value": "",
"description": "A related list record ID, or a comma-delimited list of related list record IDs."
}
]
},
"description": "Get the actions on records in related lists."
},
"response": [
{
"name": "Get Related List Record Actions",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"record",
":RECORD_ID",
"related-list-record",
":RELATED_LIST_RECORD_IDS"
],
"variable": [
{
"key": "RECORD_ID",
"value": "00158000006QBOhAAO",
"description": "Record ID"
},
{
"key": "RELATED_LIST_RECORD_IDS",
"value": "00358000006woxwAAA",
"description": "A related list record ID, or a comma-delimited list of related list record IDs."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 11:37:18 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": "\"f29ba79a7eda15543fca804e0e88bea6--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 \"00158000006QBOhAAO\": {\n \"actions\": [\n {\n \"actionListContext\": \"RelatedListRecord\",\n \"actionTarget\": null,\n \"actionTargetType\": \"Invoke\",\n \"apiName\": \"Edit\",\n \"externalId\": \"00D58000000arpq:00158000006QBOhAAO::RelatedListRecord:Desktop:StandardButton:Edit\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/edit_120.png\",\n \"id\": \"0JV4H0000122896WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Edit\",\n \"lwcComponent\": null,\n \"primaryColor\": \"06A59A\",\n \"relatedListRecordId\": \"00358000006woxwAAA\",\n \"relatedSourceObject\": \"Contacts\",\n \"section\": \"Page\",\n \"sourceObject\": \"00158000006QBOhAAO\",\n \"subtype\": null,\n \"targetObject\": \"Contact\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n },\n {\n \"actionListContext\": \"RelatedListRecord\",\n \"actionTarget\": null,\n \"actionTargetType\": \"Invoke\",\n \"apiName\": \"Delete\",\n \"externalId\": \"00D58000000arpq:00158000006QBOhAAO::RelatedListRecord:Desktop:StandardButton:Delete\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/delete_120.png\",\n \"id\": \"0JV4H0000122897WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Delete\",\n \"lwcComponent\": null,\n \"primaryColor\": \"FF538A\",\n \"relatedListRecordId\": \"00358000006woxwAAA\",\n \"relatedSourceObject\": \"Contacts\",\n \"section\": \"Page\",\n \"sourceObject\": \"00158000006QBOhAAO\",\n \"subtype\": null,\n \"targetObject\": \"Contact\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n }\n ],\n \"links\": [],\n \"url\": \"/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list-record/00358000006woxwAAA\"\n }\n },\n \"eTag\": \"f29ba79a7eda15543fca804e0e88bea6\",\n \"url\": \"/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list-record/00358000006woxwAAA\"\n}"
}
]
}
