Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcActionListContext
LOCAL lcActionTarget
LOCAL lcActionTargetType
LOCAL lcApiName
LOCAL lcExternalId
LOCAL lcIconUrl
LOCAL lcId
LOCAL lcIsMassAction
LOCAL lcLabel
LOCAL lcLwcComponent
LOCAL lcPrimaryColor
LOCAL lcRelatedListRecordId
LOCAL lcRelatedSourceObject
LOCAL lcSection
LOCAL lcSourceObject
LOCAL lcSubtype
LOCAL lcTargetObject
LOCAL lcTargetUrl
LOCAL lcV_type
LOCAL lcV_Url
LOCAL lcETag
LOCAL lcUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list/:RELATED_LIST_IDS",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "actions": {
* "00158000006QBOhAAO": {
* "actions": [
* {
* "actionListContext": "RelatedList",
* "actionTarget": null,
* "actionTargetType": "Invoke",
* "apiName": "NewContact",
* "externalId": "00D58000000arpq:00158000006QBOhAAO::RelatedList:Desktop:StandardButton:NewContact",
* "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png",
* "id": "0JV4H0000119415WAA",
* "isMassAction": "false",
* "label": "New",
* "lwcComponent": null,
* "primaryColor": "5867E8",
* "relatedListRecordId": null,
* "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/Contacts"
* }
* },
* "eTag": "a20a5831cc59f674f527261d7469d62d",
* "url": "/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list/Contacts"
* }
* 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/:RELATED_LIST_IDS
Postman Collection Item JSON
{
"name": "Get Related List 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/:RELATED_LIST_IDS",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"record",
":RECORD_ID",
"related-list",
":RELATED_LIST_IDS"
],
"query": [
{
"key": "actionTypes",
"value": "",
"description": "The action type (`CustomButton`, `ProductivityAction`, `QuickAction` or `StandardButton`)",
"disabled": true
},
{
"key": "apiNames",
"value": "",
"description": "The API names of one or more actions to be retrieved. Use this parameter only when passing `retrievalMode=All`.",
"disabled": true
},
{
"key": "formFactor",
"value": "",
"description": "The layout display size (`Large` (default), `Medium` or `Small`).",
"disabled": true
},
{
"key": "retrievalMode",
"value": "",
"description": "When the action context is Record, this parameter indicates which actions to retrieve from the record page. Either `All` or `PageLayout` (default).",
"disabled": true
},
{
"key": "sections",
"value": "",
"description": "The section of the user interface that the actions reside in (`ActivityComposer`, `CollaborateComposer`, `Page` or `SingleActionLinks`).",
"disabled": true
}
],
"variable": [
{
"key": "RECORD_ID",
"value": "",
"description": "Record ID"
},
{
"key": "RELATED_LIST_IDS",
"value": "",
"description": "Optional. A related list name, or a comma-delimited list of related list names."
}
]
},
"description": "Get the actions on record detail pages."
},
"response": [
{
"name": "Get Related List Actions",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list/:RELATED_LIST_IDS",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"record",
":RECORD_ID",
"related-list",
":RELATED_LIST_IDS"
],
"variable": [
{
"key": "RECORD_ID",
"value": "0014H00002LbR7QQAV",
"description": "Record ID"
},
{
"key": "RELATED_LIST_IDS",
"value": "Contacts",
"description": "A related list name, or a comma-delimited list of related list names."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 11:27:08 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": "\"a20a5831cc59f674f527261d7469d62d--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\": \"RelatedList\",\n \"actionTarget\": null,\n \"actionTargetType\": \"Invoke\",\n \"apiName\": \"NewContact\",\n \"externalId\": \"00D58000000arpq:00158000006QBOhAAO::RelatedList:Desktop:StandardButton:NewContact\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png\",\n \"id\": \"0JV4H0000119415WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"New\",\n \"lwcComponent\": null,\n \"primaryColor\": \"5867E8\",\n \"relatedListRecordId\": null,\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/Contacts\"\n }\n },\n \"eTag\": \"a20a5831cc59f674f527261d7469d62d\",\n \"url\": \"/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list/Contacts\"\n}"
}
]
}
