User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Get a Batch of Related List Actions with a Request Body
Get the actions on a batch of related lists for a record. This resource uses the POST
method so you can enter request parameters in the request body instead using complex URL
parameters.
- Resources
-
/ui-api/actions/record/${recordIds}/related-list/batch- recordIds—The 15 or 18 character ID of a record.
- Available Version
- 57.0
- HTTP Method
- POST
- 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.
POST /services/data/v64.0/ui-api/actions/record/001R0000003IDlwIAG/related-list/batch{ "relatedListsActionParameters": [ { "relatedListId": "Contacts", "apiNames": [ "New" ], "retrievalMode": "All" }, { "relatedListId": "Opportunities", "apiNames": ["New" ], "retrievalMode": "All" } ] } - Request Parameters
-
Parameter Name Type Description Required or Optional Available Version listRecordActionsQuery Action Related Lists Batch Input The data for a batch of related list actions. Optional 57.0 - Response Body
- Simplified Batch Results