User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Get Photo Actions
- Resource
-
/ui-api/actions/photo/${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 a Group tab with a record ID of 0F9R00000000182KAA . To get information about the photo actions on the tab, make this request:
GET /services/data/v64.0/ui-api/actions/photo/0F9R00000000182KAAThe request returns a list of photo actions on the tab and the URLs of the request and subrequests.
{ "actions" : { "0F9R00000000182KAA" : { "actions" : [ { "actionListContext" : "Photo", "actionTarget" : null, "actionTargetType" : "Invoke", "apiName" : "ViewPhotoAction", "externalId" : "00DR00000008n7M:0F9R00000000182KAA::Photo:Phone:StandardButton:ViewPhotoAction", "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/email_120.png", "id" : "0JVR00000000035OAA", "isMassAction" : "false", "label" : "View Photo", "primaryColor" : "95AEC5", "relatedListRecordId" : null, "relatedSourceObject" : null, "section" : "Page", "sourceObject" : "0F9R00000000182KAA", "subtype" : null, "targetObject" : null, "targetUrl" : null, "type" : "StandardButton" } ... Additional actions removed for brevity ... ], "links" : [ ], "url" : "/services/data/v41.0/ui-api/actions/photo/0F9R00000000182KAA" } }, "url" : "/services/data/v41.0/ui-api/actions/photo/0F9R00000000182KAA" } - 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