Salesforce1 App Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Tell Me More: Actions and the REST API
The REST API contains a number of resources and calls that you can use when
working with actions.
Publisher Quick Actions
Use the Publisher Quick Actions resource to return a list of actions as well as custom fields and objects that appear in the feed. The resource uses a URI of the format services/data/v31.0/quickActions/.
- Global Actions
To return global actions, use: services/data/v31.0/quickActions/
A call to this resource returns information about the global actions including our Shipify canvas custom action as shown in this snippet of the response:1... 2 { 3 "urls" : { 4 "quickAction" : "/services/data/v31.0/ 5 quickActions/LogACall", 6 "defaultValues" : "/services/data/v31.0/ 7 quickActions/LogACall/defaultValues", 8 "describe" : "/services/data/v31.0/ 9 quickActions/LogACall/describe" 10 }, 11 "name" : "LogACall", 12 "type" : "LogACall", 13 "label" : "Log a Call" 14 }, 15 { 16 "urls" : { 17 "quickAction" : "/services/data/v31.0/ 18 quickActions/Shipify", 19 "describe" : "/services/data/v31.0/ 20 quickActions/Shipify/describe" 21 }, 22 "name" : "Shipify", 23 "type" : "Canvas", 24 "label" : "Shipify" 25 }, 26...- Object Actions
To return a specific object’s actions, as well as global actions, use: services/data/v31.0/sobjects/object/quickActions/
The call /services/data/v31.0/sobjects/Invoice__c/quickActions returns information about global actions as well as the Invoice Create_Delivery action, as shown in this snippet of the response:1... 2 { "urls" : { 3 "quickAction" : "/services/data/v31.0/ 4 quickActions/Shipify", 5 "describe" : "/services/data/v31.0/ 6 quickActions/Shipify3/describe" 7 }, 8 "name" : "Shipify", 9 "type" : "Canvas", 10 "label" : "Shipify3" 11 }, 12 { 13 "urls" : { 14 "defaultValuesTemplate" : "/services/data/v31.0/ 15 sobjects/Invoice__c/quickActions/Create_Delivery/ 16 defaultValues/{ID}", 17 "quickAction" : "/services/data/v31.0/ 18 sobjects/Invoice__c/quickActions/Create_Delivery", 19 "defaultValues" : "/services/data/v31.0/ 20 sobjects/Invoice__c/quickActions/Create_Delivery/ 21 defaultValues", 22 "describe" : "/services/data/v31.0/ 23 sobjects/Invoice__c/quickActions/Create_Delivery/ 24 describe" 25 }, 26 "name" : "Invoice__c.Create_Delivery", 27 "type" : "Create", 28 "label" : "Create Delivery" 29 }, 30...- Specific Actions
To return a specific action, use: services/data/v31.0/sobjects/object/quickActions/{action name}
The call /services/data/v31.0/sobjects/Invoice__c/ quickActions/Create_Delivery returns information about only the Create_Delivery action, as shown in this response:1{ 2 "colors": [ 3 { 4 "theme": "theme4", 5 "color": "AA8E0A", 6 "context": "primary" 7 }, 8 { 9 "theme": "theme3", 10 "color": "AA8E0A", 11 "context": "primary" 12 } 13 ], 14 "miniIconUrl": "https://instance.salesforce.com/img/ 15 icon/custom51_100/truck16.png", 16 "sourceSobjectType": "Invoice__c", 17 "targetParentField": "Invoice__c", 18 "targetRecordTypeId": null, 19 "targetSobjectType": "Delivery__c", 20 "visualforcePageName": null, 21 "iconUrl": "https://instance.salesforce.com/img/ 22 icon/custom51_100/truck32.png", 23 "iconName": null, 24 "canvasApplicationName": null, 25 "height": null, 26 "icons": [ 27 { 28 "url": "https://instance.salesforce.com/img/ 29 icon/custom51_100/truck32.png", 30 "height": 32, 31 "theme": "theme3", 32 "width": 32, 33 "contentType": "image/png" 34 }, 35 { 36 "url": "https://instance.salesforce.com/img/ 37 icon/custom51_100/truck16.png", 38 "height": 16, 39 "theme": "theme3", 40 "width": 16, 41 "contentType": "image/png" 42 }, 43... 44 ], 45 "layout": { 46 "layoutRows": [{ 47 "layoutItems": [ 48 { 49 "layoutComponents": [{ 50 "details": { 51 "namePointing": false, 52 "custom": true, 53 "htmlFormatted": false, 54 "dependentPicklist": false, 55 "calculatedFormula": null, 56 "defaultValueFormula": null, 57 "defaultedOnCreate": false, 58 "digits": 0, 59 "groupable": true, 60 "permissionable": false, 61 "referenceTo": ["Invoice__c"], 62 "relationshipOrder": 0, 63 "soapType": "tns:ID", 64 "nameField": false, 65 "sortable": true, 66 "filterable": true, 67 "restrictedPicklist": false, 68 "caseSensitive": false, 69 "calculated": false, 70 "scale": 0, 71 "nillable": false, 72 "externalId": false, 73 "idLookup": false, 74 "controllerName": null, 75 "deprecatedAndHidden": false, 76 "inlineHelpText": null, 77 "writeRequiresMasterRead": false, 78 "createable": true, 79 "updateable": false, 80 "relationshipName": "Invoice__r", 81 "autoNumber": false, 82 "unique": false, 83 "picklistValues": [], 84 "displayLocationInDecimal": false, 85 "cascadeDelete": true, 86 "restrictedDelete": false, 87 "length": 18, 88 "name": "Invoice__c", 89 "type": "reference", 90 "defaultValue": null, 91 "byteLength": 18, 92 "label": "Invoice", 93 "precision": 0 94 }, 95 "displayLines": 1, 96 "tabOrder": 1, 97 "value": "Invoice__c", 98 "type": "Field" 99 }], 100 "placeholder": false, 101 "editable": true, 102 "required": true, 103 "label": "Invoice" 104 }, 105 { 106 "layoutComponents": [], 107 "placeholder": true, 108 "editable": false, 109 "required": false, 110 "label": "" 111 } 112 ], 113 "numItems": 2 114 }], 115 "useCollapsibleSection": false, 116 "useHeading": false, 117 "columns": 2, 118 "heading": null, 119 "rows": 1 120 }, 121 "defaultValues": [], 122 "width": null, 123 "urls": { 124 "defaultValuesTemplate": "/services/data/v31.0/ 125 sobjects/Invoice__c/quickActions/ 126 Create_Delivery/defaultValues/{ID}", 127 "quickAction": "/services/data/v31.0/ 128 sobjects/Invoice__c/quickActions/Create_Delivery", 129 "defaultValues": "/services/data/v31.0/ 130 sobjects/Invoice__c/quickActions/ 131 Create_Delivery/defaultValues", 132 "describe": "/services/data/v31.0/ 133 sobjects/Invoice__c/quickActions/ 134 Create_Delivery/describe" 135 }, 136 "name": "Invoice__c.Create_Delivery", 137 "type": "Create", 138 "label": "Create Delivery" 139}- Action Details
To return a specific action’s descriptive detail, use: services/data/v31.0/sobjects/object/quickActions/{action name}/describe/
- Action Default Values and Field Values
To return a specific action’s default values, including default field values, use: services/data/v31.0/sobjects/object/quickActions/{action name}/defaultValues/
The call /services/data/v31.0/sobjects/Invoice__c/ quickActions/Create_Data/defaultValues returns information about defaults for the Invoice Create_Delivery action, as shown in this snippet of the response:1... 2{ 3 "attributes":{ 4 "type":"Delivery__c" 5 } 6} 7...- Action Default Values
To return the default values for an action, use: /services/data/v31.0/subjects/ object/quickActions/{action name}/defaultValues/{parent id}
Describe Layouts
Use the global describe layouts resource to get global layout information for objects, including action objects. The resource uses a URI of the format: services/data/v31.0/ sobjects/Global/describe/layouts/
A call to this
resource returns layout information for the global actions (including
our Shipify canvas custom action), as shown in this response:
1{
2 "recordTypeSelectorRequired":[
3 false
4 ],
5 "recordTypeMappings":[
6
7 ],
8 "layouts":[
9 {
10 "relatedLists":[
11
12 ],
13 "relatedContent":null,
14 "detailLayoutSections":[
15
16 ],
17 "editLayoutSections":[
18
19 ],
20 "multirowEditLayoutSections":[
21
22 ],
23 "offlineLinks":[
24
25 ],
26 "buttonLayoutSection":null,
27 "highlightsPanelLayoutSection":null,
28 "quickActionList":{
29 "quickActionListItems":[
30 {
31 "quickActionName":"Shipify",
32 "colors":[
33
34 ],
35 "miniIconUrl":null,
36 "targetSobjectType":null,
37 "iconUrl":null,
38 "urls":{
39 "quickAction":"/services/data/v31.0/
40 quickActions/Shipify",
41 "describe":"/services/data/v31.0/
42 quickActions/Shipify/describe"
43 },
44 "icons":[
45
46 ],
47 "type":"Canvas",
48 "label":"Shipify"
49 },
50 {
51 "quickActionName":"FeedItem.TextPost",
52 "colors":[
53
54 ],
55 "miniIconUrl":null,
56 "targetSobjectType":null,
57 "iconUrl":null,
58 "urls":{
59
60 },
61 "icons":[
62
63 ],
64 "type":"Post",
65 "label":"Post"
66 },
67 {
68 "quickActionName":"FeedItem.ContentPost",
69 "colors":[
70
71 ],
72 "miniIconUrl":null,
73 "targetSobjectType":null,
74 "iconUrl":null,
75 "urls":{
76
77 },
78 "icons":[
79
80 ],
81 "type":"Post",
82 "label":"File"
83 },
84 {
85 "quickActionName":"NewTask",
86 "colors":[
87 {
88 "color":"44A12C",
89 "theme":"theme4",
90 "context":"primary"
91 },
92 {
93 "color":"1797C0",
94 "theme":"theme3",
95 "context":"primary"
96 }
97 ],
98 "miniIconUrl":"https://instance.
99 salesforce.com/img/icon/tasks16.png",
100 "targetSobjectType":"Task",
101 "iconUrl":"https://instance.
102 salesforce.com/img/icon/home32.png",
103 "urls":{
104 "quickAction":"/services/data/v31.0/
105 quickActions/NewTask",
106 "defaultValues":"/services/data/v31.0/
107 quickActions/NewTask/defaultValues",
108 "describe":"/services/data/v31.0/
109 quickActions/NewTask/describe"
110 },
111 "icons":[
112 {
113 "url":"https://instance.
114 salesforce.com/img/icon/home32.png",
115 "height":32,
116 "theme":"theme3",
117 "width":32,
118 "contentType":"image/png"
119 },
120 {
121 "url":"https://instance.
122 salesforce.com/img/icon/tasks16.png",
123 "height":16,
124 "theme":"theme3",
125 "width":16,
126 "contentType":"image/png"
127 },
128 ...
129 ],
130 "type":"Create",
131 "label":"New Task"
132 },
133 {
134 "quickActionName":"NewContact",
135 "colors":[
136 {
137 "color":"b76db7",
138 "theme":"theme4",
139 "context":"primary"
140 },
141 {
142 "color":"56458C",
143 "theme":"theme3",
144 "context":"primary"
145 }
146 ],
147 "miniIconUrl":"https://instance.
148 salesforce.com/img/icon/contacts16.png",
149 "targetSobjectType":"Contact",
150 "iconUrl":"https://instance.
151 salesforce.com/img/icon/contacts32.png",
152 "urls":{
153 "quickAction":"/services/data/v31.0/
154 quickActions/NewContact",
155 "defaultValues":"/services/data/v31.0/
156 quickActions/NewContact/defaultValues",
157 "describe":"/services/data/v31.0/
158 quickActions/NewContact/describe"
159 },
160 "icons":[
161 {
162 "url":"https://instance.
163 salesforce.com/img/icon/contacts32.png",
164 "height":32,
165 "theme":"theme3",
166 "width":32,
167 "contentType":"image/png"
168 },
169 {
170 "url":"https://instance.
171 salesforce.com/img/icon/contacts16.png",
172 "height":16,
173 "theme":"theme3",
174 "width":16,
175 "contentType":"image/png"
176 },
177 ...
178 ],
179 "type":"Create",
180 "label":"New Contact"
181 },
182 ...
183 "type":"Create",
184 "label":"New Lead"
185 },
186 {
187 "quickActionName":"FeedItem.LinkPost",
188 "colors":[
189
190 ],
191 "miniIconUrl":null,
192 "targetSobjectType":null,
193 "iconUrl":null,
194 "urls":{
195
196 },
197 "icons":[
198
199 ],
200 "type":"Post",
201 "label":"Link"
202 },
203 {
204 "quickActionName":"FeedItem.PollPost",
205 "colors":[
206
207 ],
208 "miniIconUrl":null,
209 "targetSobjectType":null,
210 "iconUrl":null,
211 "urls":{
212
213 },
214 "icons":[
215
216 ],
217 "type":"Post",
218 "label":"Poll"
219 }
220 ]
221 },
222 "id":"00hR0000000MpLAIA0"
223 }
224 ]
225}Use the describe layouts resource to obtain a description of a layout for a specific object, including action objects. The resource uses a URI of the format: services/data/ v31.0/sobjects/object/describe/layouts/