Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// 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
lcV_Url = loJResp.StringOf("actions.00158000006QBOhAAO.url")
lcETag = loJResp.StringOf("eTag")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("actions.00158000006QBOhAAO.actions")
do while i < lnCount_i
loJResp.I = i
lcActionListContext = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].actionListContext")
lcActionTarget = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].actionTarget")
lcActionTargetType = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].actionTargetType")
lcApiName = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].apiName")
lcExternalId = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].externalId")
lcIconUrl = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].iconUrl")
lcId = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].id")
lcIsMassAction = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].isMassAction")
lcLabel = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].label")
lcLwcComponent = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].lwcComponent")
lcPrimaryColor = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].primaryColor")
lcRelatedListRecordId = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].relatedListRecordId")
lcRelatedSourceObject = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].relatedSourceObject")
lcSection = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].section")
lcSourceObject = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].sourceObject")
lcSubtype = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].subtype")
lcTargetObject = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].targetObject")
lcTargetUrl = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].targetUrl")
lcV_type = loJResp.StringOf("actions.00158000006QBOhAAO.actions[i].type")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("actions.00158000006QBOhAAO.links")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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}"
}
]
}
