Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get Related List Record Actions

Get the actions on records in related lists.

Resource

1/ui-api/actions/record/${recordId}/related-list-record/${relatedListRecordIds}

relatedListRecordIds—A related list record ID, or a comma-delimited list of related list record IDs.

Available Version

41.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 a Contacts related list, and one of the Contacts has a record ID of 003R0000007qfC7. To get information about the actions for this contact, make this request:

1GET /services/data/v67.0/ui-api/actions/record/001R0000003IDlwIAG/related-list-record/003R0000007qfC7

The request returns a list of actions for the contact and the URLs of the request and subrequests.

1{
2        "actionListContext" : "RelatedListRecord",
3        "actionTarget" : null,
4        "actionTargetType" : "Invoke",
5        "apiName" : "Delete",
6        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedListRecord:Phone:StandardButton:Delete",
7        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/delete_120.png",
8        "id" : "0JVR00000000014OAA",
9        "isMassAction" : "false",
10        "label" : "Delete",
11        "primaryColor" : "E6717C",
12        "relatedListRecordId" : "003R0000007qfC7",
13        "relatedSourceObject" : "Contacts",
14        "section" : "Page",
15        "sourceObject" : "001R0000003IDlwIAG",
16        "subtype" : null,
17        "targetObject" : "Contact",
18        "targetUrl" : null,
19        "type" : "StandardButton"
20      }
21
22... Additional actions removed for brevity ...
23
24],
25      "links" : [ ],
26      "url" : "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/related-list-record/003R0000007qfC7"
27    }
28  },
29  "url" : "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/related-list-record/003R0000007qfC7"
30}

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

Action

User Interface API Developer Guide

Get Related List Record Actions