Chilkat Online Tools

Objective-C / Salesforce Platform APIs / Get Related List Actions

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list/:RELATED_LIST_IDS" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// 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

NSString *actionListContext = 0;
NSString *actionTarget = 0;
NSString *actionTargetType = 0;
NSString *apiName = 0;
NSString *externalId = 0;
NSString *iconUrl = 0;
NSString *id = 0;
NSString *isMassAction = 0;
NSString *label = 0;
NSString *lwcComponent = 0;
NSString *primaryColor = 0;
NSString *relatedListRecordId = 0;
NSString *relatedSourceObject = 0;
NSString *section = 0;
NSString *sourceObject = 0;
NSString *subtype = 0;
NSString *targetObject = 0;
NSString *targetUrl = 0;
NSString *v_type = 0;

NSString *v_Url = [jResp StringOf: @"actions.00158000006QBOhAAO.url"];
NSString *eTag = [jResp StringOf: @"eTag"];
NSString *url = [jResp StringOf: @"url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"actions.00158000006QBOhAAO.actions"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: 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;
}

i = 0;
count_i = [[jResp SizeOfArray: @"actions.00158000006QBOhAAO.links"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    i = i + 1;
}

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}"
    }
  ]
}