Action Related List Single Batch Input

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

JSON example

To get information about the actions for the Contacts and Opportunities related lists on an Account record page, use this request with parameters in a request body.

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

1{
2  "relatedListsActionParameters":
3  [
4    {
5      "relatedListId": "Contacts",
6      "apiNames": [ "New" ],
7      "retrievalMode": "All"
8    },
9    {
10      "relatedListId": "Opportunities",
11      "apiNames": ["New" ],
12      "retrievalMode": "All"
13    }
14  ]
15}

Properties

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	57.0
`apiNames`	String[]	The API names of one or more actions to be retrieved. Use this parameter only when passing `retrievalMode=All`.	Optional	57.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	57.0
`relatedListId`	String	The ID of the related list.	Optional	57.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	57.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	57.0

User Interface API Developer Guide

Action Related List Single Batch Input

See Also