Chilkat Online Tools

Ruby / Salesforce Platform APIs / Get Related List Record Actions

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    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
    jResp.put_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
    jResp.put_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}"
    }
  ]
}