Get Record Detail Actions
- Resource
-
/ui-api/actions/record/${recordIds}
recordIds—A single record ID, or a comma-delimited list of 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 some standard buttons and quick actions. To get information about all the actions on this page, make this request:
GET /services/data/v64.0/ui-api/actions/record/001R0000003IDlwIAG
The request returns a list of actions on the page and the URLs of the request and subrequests.
- 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