User Interface API Developer Guide
jNote: 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.
Work with Actions
You can use the actions endpoints to fetch lists of actions, but not to execute actions. It’s handy to get a list of actions if you want to use quick actions, if you have Visualforce overrides, or if you want to determine CRUD based on visible actions. For example, if a New action exists, then a user can create a record.
- Get Actions for a Record Detail Page
-
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:
1GET /services/data/v67.0/ui-api/actions/record/001R0000003IDlwIAGThe request returns a list of actions on the page and the URLs of the request and subrequests.
- Filter the Action Results
-
To filter the results returned by the Actions resources, use the following request parameters:
- actionTypes—The action type.
- formFactor—The layout display size.
- sections—The section of the user interface that the action resides in.
For example, to filter a record actions request so that it includes only standard button actions, set the actionTypes parameter to StandardButton.
1GET /services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG?actionTypes=StandardButton