Get a Batch of Related List Actions with URL Parameters

Get the actions on a batch of related lists for a record via URL parameters.

Resources

1/ui-api/actions/record/${recordIds}/related-list/batch/${relatedListIds}

recordIds—The 15 or 18 character ID of a record.
relatedListIds—(Optional) A comma-delimited list of related list IDs. When this parameter isn’t specified, the request returns all related list actions for the specified record.

Available Version

50.0

HTTP Method

GET

Example

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has some related lists, including tasks and events. To get information about all the related list actions on this page, make this request.

1GET /services/data/v59.0/ui-api/actions/record/001R0000003IDlwIAG/related-list/batch

The request returns a list of related list actions on the page and the URLs of the request and subrequests.

1{
2  "actions" : {
3    "001R0000003IDlwIAG" : {
4      "actions" : [ {
5        "actionListContext" : "RelatedList",
6        "actionTarget" : null,
7        "actionTargetType" : "Invoke",
8        "apiName" : "NewTask",
9        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedList:Phone:StandardButton:NewTask",
10        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new_task_120.png",
11        "id" : "0JVR00000000036OAA",
12        "isMassAction" : "false",
13        "label" : "New Task",
14        "primaryColor" : "4BC076",
15        "relatedListRecordId" : null,
16        "relatedSourceObject" : "OpenActivities",
17        "section" : "Page",
18        "sourceObject" : "001R0000003IDlwIAG",
19        "subtype" : null,
20        "targetObject" : "Task",
21        "targetUrl" : null,
22        "type" : "StandardButton"
23      }, {
24        "actionListContext" : "RelatedList",
25        "actionTarget" : null,
26        "actionTargetType" : "Invoke",
27        "apiName" : "NewEvent",
28        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedList:Phone:StandardButton:NewEvent",
29        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new_event_120.png",
30        "id" : "0JVR00000000037OAA",
31        "isMassAction" : "false",
32        "label" : "New Event",
33        "primaryColor" : "EB7092",
34        "relatedListRecordId" : null,
35        "relatedSourceObject" : "OpenActivities",
36        "section" : "Page",
37        "sourceObject" : "001R0000003IDlwIAG",
38        "subtype" : null,
39        "targetObject" : "Event",
40        "targetUrl" : null,
41        "type" : "StandardButton"
42      }
43
44... Additional actions removed for brevity ...
45
46],
47      "links" : [ ],
48      "url" : "/services/data/v59.0/ui-api/actions/record/001R0000003IDlwIAG/related-list"
49    }
50  },
51  "url" : "/services/data/v59.0/ui-api/actions/record/001R0000003IDlwIAG/related-list"
52}

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`actionTypes`	String[]	The action type. One or more of these values: `CustomButton`—A button that opens a URL or Visualforce page or executes JavaScript. `ProductivityAction`—A pre-defined Salesforce action, attached to a limited set of objects. `QuickAction`—A global or object-specific action. `StandardButton`—A pre-defined Salesforce button, such as New, Edit, and Delete.	Optional	41.0
`apiNames`	String[]	The API names of one or more actions to be retrieved. Use this parameter only when passing `retrievalMode=All`.	Optional	49.0
`formFactor`	String	The layout display size. One of these values: `Large`—(Default) Use this value to get a layout for desktop display size. `Medium`—Use this value to get a layout for tablet display size. `Small`—Use this value to get a layout for phone display size.	Optional	41.0
`retrievalMode`	String	When the action context is `Record`, this parameter indicates which actions to retrieve from the record page. One of these values: `All`—Retrieves all actions specified in the `apiNames` parameter. `PageLayout`—(Default) Retrieves actions from the page layout.	Optional	49.0
`sections`	String[]	The section of the user interface that the actions reside in. One or more of these values: `ActivityComposer` `CollaborateComposer` `Page` `SingleActionLinks`	Optional	41.0

Response Body

Simplified Batch Results

User Interface API Developer Guide

Get a Batch of Related List Actions with URL Parameters