@itentialopensource/adapter-salesforce_rest 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +5 -0
- package/.eslintrc.js +18 -0
- package/.jshintrc +3 -0
- package/AUTH.md +38 -0
- package/BROKER.md +211 -0
- package/CALLS.md +645 -0
- package/CHANGELOG.md +9 -0
- package/CODE_OF_CONDUCT.md +43 -0
- package/CONTRIBUTING.md +13 -0
- package/ENHANCE.md +69 -0
- package/LICENSE +201 -0
- package/PROPERTIES.md +646 -0
- package/README.md +343 -0
- package/SUMMARY.md +9 -0
- package/SYSTEMINFO.md +20 -0
- package/TROUBLESHOOT.md +47 -0
- package/adapter.js +9326 -0
- package/adapterBase.js +1452 -0
- package/changelogs/CHANGELOG.md +0 -0
- package/entities/.generic/action.json +214 -0
- package/entities/.generic/schema.json +28 -0
- package/entities/.system/action.json +51 -0
- package/entities/.system/mockdatafiles/getToken-default.json +3 -0
- package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
- package/entities/.system/schema.json +19 -0
- package/entities/.system/schemaTokenReq.json +86 -0
- package/entities/.system/schemaTokenResp.json +53 -0
- package/entities/Actions/action.json +87 -0
- package/entities/Actions/schema.json +22 -0
- package/entities/BusinessRulesEngineInvocableActions/action.json +44 -0
- package/entities/BusinessRulesEngineInvocableActions/schema.json +31 -0
- package/entities/LightningMetrics/action.json +109 -0
- package/entities/LightningMetrics/schema.json +23 -0
- package/entities/ListViews/action.json +88 -0
- package/entities/ListViews/schema.json +22 -0
- package/entities/Logs/action.json +46 -0
- package/entities/Logs/schema.json +20 -0
- package/entities/Processes/action.json +66 -0
- package/entities/Processes/schema.json +21 -0
- package/entities/REST/action.json +235 -0
- package/entities/REST/schema.json +29 -0
- package/entities/SObject/action.json +547 -0
- package/entities/SObject/schema.json +55 -0
- package/entities/Scheduling/action.json +65 -0
- package/entities/Scheduling/schema.json +21 -0
- package/entities/Search/action.json +151 -0
- package/entities/Search/schema.json +25 -0
- package/entities/SupportAndKnowledge/action.json +130 -0
- package/entities/SupportAndKnowledge/schema.json +35 -0
- package/error.json +190 -0
- package/metadata.json +71 -0
- package/package.json +81 -0
- package/pronghorn.json +4362 -0
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +1574 -0
- package/refs?service=git-upload-pack +0 -0
- package/report/Salesforce REST-OpenApi3.json +10715 -0
- package/report/adapter-openapi.json +10715 -0
- package/report/adapter-openapi.yaml +8120 -0
- package/report/adapterInfo.json +10 -0
- package/report/creationReport.json +725 -0
- package/sampleProperties.json +268 -0
- package/test/integration/adapterTestBasicGet.js +83 -0
- package/test/integration/adapterTestConnectivity.js +118 -0
- package/test/integration/adapterTestIntegration.js +2354 -0
- package/test/unit/adapterBaseTestUnit.js +1024 -0
- package/test/unit/adapterTestUnit.js +3791 -0
- package/utils/adapterInfo.js +206 -0
- package/utils/addAuth.js +94 -0
- package/utils/artifactize.js +146 -0
- package/utils/basicGet.js +50 -0
- package/utils/checkMigrate.js +63 -0
- package/utils/entitiesToDB.js +179 -0
- package/utils/findPath.js +74 -0
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +152 -0
- package/utils/packModificationScript.js +35 -0
- package/utils/patches2bundledDeps.js +90 -0
- package/utils/pre-commit.sh +32 -0
- package/utils/removeHooks.js +20 -0
- package/utils/setup.js +33 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +239 -0
- package/utils/tbUtils.js +489 -0
- package/utils/testRunner.js +298 -0
- package/utils/troubleshootingAdapter.js +193 -0
package/pronghorn.json
ADDED
|
@@ -0,0 +1,4362 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "@itentialopensource/adapter-salesforce_rest",
|
|
3
|
+
"type": "Adapter",
|
|
4
|
+
"export": "SalesforceRest",
|
|
5
|
+
"title": "Salesforce_rest",
|
|
6
|
+
"src": "adapter.js",
|
|
7
|
+
"roles": [
|
|
8
|
+
"admin"
|
|
9
|
+
],
|
|
10
|
+
"methods": [
|
|
11
|
+
{
|
|
12
|
+
"name": "iapUpdateAdapterConfiguration",
|
|
13
|
+
"summary": "Updates the adapter configuration",
|
|
14
|
+
"description": "Updates the adapter configuration file with the provided changes",
|
|
15
|
+
"input": [
|
|
16
|
+
{
|
|
17
|
+
"name": "configFile",
|
|
18
|
+
"type": "string",
|
|
19
|
+
"info": "The name of the file to change",
|
|
20
|
+
"required": true,
|
|
21
|
+
"schema": {
|
|
22
|
+
"title": "configFile",
|
|
23
|
+
"type": "string"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "changes",
|
|
28
|
+
"type": "object",
|
|
29
|
+
"info": "JSON object containing the configuration changes",
|
|
30
|
+
"required": true,
|
|
31
|
+
"schema": {
|
|
32
|
+
"title": "changes",
|
|
33
|
+
"type": "object"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"name": "entity",
|
|
38
|
+
"type": "string",
|
|
39
|
+
"info": "The entity in which the changes are being made",
|
|
40
|
+
"required": false,
|
|
41
|
+
"schema": {
|
|
42
|
+
"title": "entity",
|
|
43
|
+
"type": "string"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "type",
|
|
48
|
+
"type": "string",
|
|
49
|
+
"info": "The type of file to change - action, schema, or mock",
|
|
50
|
+
"required": false,
|
|
51
|
+
"schema": {
|
|
52
|
+
"title": "type",
|
|
53
|
+
"type": "string"
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "action",
|
|
58
|
+
"type": "string",
|
|
59
|
+
"info": "The action to be changed",
|
|
60
|
+
"required": false,
|
|
61
|
+
"schema": {
|
|
62
|
+
"title": "action",
|
|
63
|
+
"type": "string"
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "replace",
|
|
68
|
+
"type": "boolean",
|
|
69
|
+
"info": "True to replace entire mock data, false to merge/append",
|
|
70
|
+
"required": false,
|
|
71
|
+
"schema": {
|
|
72
|
+
"title": "replace",
|
|
73
|
+
"type": "boolean"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
],
|
|
77
|
+
"output": {
|
|
78
|
+
"name": "result",
|
|
79
|
+
"type": "object",
|
|
80
|
+
"description": "A JSON Object containing status, code and the result",
|
|
81
|
+
"schema": {
|
|
82
|
+
"title": "result",
|
|
83
|
+
"type": "object"
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"roles": [
|
|
87
|
+
"admin"
|
|
88
|
+
],
|
|
89
|
+
"route": {
|
|
90
|
+
"verb": "POST",
|
|
91
|
+
"path": "/iapUpdateAdapterConfiguration"
|
|
92
|
+
},
|
|
93
|
+
"task": true
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"name": "iapSuspendAdapter",
|
|
97
|
+
"summary": "Suspends the adapter",
|
|
98
|
+
"description": "Suspends the adapter",
|
|
99
|
+
"input": [
|
|
100
|
+
{
|
|
101
|
+
"name": "mode",
|
|
102
|
+
"type": "enum",
|
|
103
|
+
"enumerals": [
|
|
104
|
+
"pause",
|
|
105
|
+
"error"
|
|
106
|
+
],
|
|
107
|
+
"info": "How incoming requests are handled. Defaults to 'pause'",
|
|
108
|
+
"description": "How incoming requests are handled. Defaults to 'pause'",
|
|
109
|
+
"schema": {
|
|
110
|
+
"title": "mode",
|
|
111
|
+
"type": "string"
|
|
112
|
+
},
|
|
113
|
+
"required": false
|
|
114
|
+
}
|
|
115
|
+
],
|
|
116
|
+
"output": {
|
|
117
|
+
"name": "result",
|
|
118
|
+
"type": "object",
|
|
119
|
+
"description": "A JSON Object containing the adapter suspended status",
|
|
120
|
+
"schema": {
|
|
121
|
+
"title": "result",
|
|
122
|
+
"type": "object"
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"roles": [
|
|
126
|
+
"admin"
|
|
127
|
+
],
|
|
128
|
+
"route": {
|
|
129
|
+
"verb": "POST",
|
|
130
|
+
"path": "/iapSuspendAdapter"
|
|
131
|
+
},
|
|
132
|
+
"task": true
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "iapUnsuspendAdapter",
|
|
136
|
+
"summary": "Unsuspends the adapter",
|
|
137
|
+
"description": "Unsuspends the adapter",
|
|
138
|
+
"input": [],
|
|
139
|
+
"output": {
|
|
140
|
+
"name": "result",
|
|
141
|
+
"type": "object",
|
|
142
|
+
"description": "A JSON Object containing the adapter suspended status",
|
|
143
|
+
"schema": {
|
|
144
|
+
"title": "result",
|
|
145
|
+
"type": "object"
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"roles": [
|
|
149
|
+
"admin"
|
|
150
|
+
],
|
|
151
|
+
"route": {
|
|
152
|
+
"verb": "POST",
|
|
153
|
+
"path": "/iapUnsuspendAdapter"
|
|
154
|
+
},
|
|
155
|
+
"task": true
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"name": "iapGetAdapterQueue",
|
|
159
|
+
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
|
|
160
|
+
"description": "Return the requests that are waiting in the queue if throttling is enabled",
|
|
161
|
+
"input": [],
|
|
162
|
+
"output": {
|
|
163
|
+
"name": "result",
|
|
164
|
+
"type": "object",
|
|
165
|
+
"description": "A JSON Object containing the adapter queue",
|
|
166
|
+
"schema": {
|
|
167
|
+
"title": "result",
|
|
168
|
+
"type": "object"
|
|
169
|
+
}
|
|
170
|
+
},
|
|
171
|
+
"roles": [
|
|
172
|
+
"admin"
|
|
173
|
+
],
|
|
174
|
+
"route": {
|
|
175
|
+
"verb": "POST",
|
|
176
|
+
"path": "/iapGetAdapterQueue"
|
|
177
|
+
},
|
|
178
|
+
"task": true
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"name": "iapFindAdapterPath",
|
|
182
|
+
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
|
|
183
|
+
"description": "Provides the ability to see if a particular API path is supported by the adapter",
|
|
184
|
+
"input": [
|
|
185
|
+
{
|
|
186
|
+
"name": "apiPath",
|
|
187
|
+
"type": "string",
|
|
188
|
+
"info": "The API Path you want to check - make sure to not include base path and version",
|
|
189
|
+
"description": "The API Path you want to check - make sure to not include base path and version",
|
|
190
|
+
"schema": {
|
|
191
|
+
"title": "apiPath",
|
|
192
|
+
"type": "string"
|
|
193
|
+
},
|
|
194
|
+
"required": true
|
|
195
|
+
}
|
|
196
|
+
],
|
|
197
|
+
"output": {
|
|
198
|
+
"name": "result",
|
|
199
|
+
"type": "object",
|
|
200
|
+
"description": "A JSON Object containing the result",
|
|
201
|
+
"schema": {
|
|
202
|
+
"title": "result",
|
|
203
|
+
"type": "object"
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
"roles": [
|
|
207
|
+
"admin"
|
|
208
|
+
],
|
|
209
|
+
"route": {
|
|
210
|
+
"verb": "POST",
|
|
211
|
+
"path": "/iapFindAdapterPath"
|
|
212
|
+
},
|
|
213
|
+
"task": true
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "iapTroubleshootAdapter",
|
|
217
|
+
"summary": "Runs troubleshoot script for adapter",
|
|
218
|
+
"description": "Runs troubleshoot script for adapter",
|
|
219
|
+
"input": [
|
|
220
|
+
{
|
|
221
|
+
"name": "props",
|
|
222
|
+
"type": "object",
|
|
223
|
+
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
|
|
224
|
+
"required": true,
|
|
225
|
+
"schema": {
|
|
226
|
+
"title": "props",
|
|
227
|
+
"type": "object"
|
|
228
|
+
}
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "persistFlag",
|
|
232
|
+
"type": "boolean",
|
|
233
|
+
"info": "Whether the input properties should be saved",
|
|
234
|
+
"required": true,
|
|
235
|
+
"schema": {
|
|
236
|
+
"title": "persistFlag",
|
|
237
|
+
"type": "boolean"
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
],
|
|
241
|
+
"output": {
|
|
242
|
+
"name": "result",
|
|
243
|
+
"type": "object",
|
|
244
|
+
"description": "A JSON Object containing the test results",
|
|
245
|
+
"schema": {
|
|
246
|
+
"title": "result",
|
|
247
|
+
"type": "object"
|
|
248
|
+
}
|
|
249
|
+
},
|
|
250
|
+
"roles": [
|
|
251
|
+
"admin"
|
|
252
|
+
],
|
|
253
|
+
"route": {
|
|
254
|
+
"verb": "POST",
|
|
255
|
+
"path": "/iapTroubleshootAdapter"
|
|
256
|
+
},
|
|
257
|
+
"task": true
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"name": "iapRunAdapterHealthcheck",
|
|
261
|
+
"summary": "Runs healthcheck script for adapter",
|
|
262
|
+
"description": "Runs healthcheck script for adapter",
|
|
263
|
+
"input": [],
|
|
264
|
+
"output": {
|
|
265
|
+
"name": "result",
|
|
266
|
+
"type": "boolean",
|
|
267
|
+
"description": "Whether healthcheck passed or failed",
|
|
268
|
+
"schema": {
|
|
269
|
+
"title": "result",
|
|
270
|
+
"type": "boolean"
|
|
271
|
+
}
|
|
272
|
+
},
|
|
273
|
+
"roles": [
|
|
274
|
+
"admin"
|
|
275
|
+
],
|
|
276
|
+
"route": {
|
|
277
|
+
"verb": "POST",
|
|
278
|
+
"path": "/iapRunAdapterHealthcheck"
|
|
279
|
+
},
|
|
280
|
+
"task": true
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"name": "iapRunAdapterConnectivity",
|
|
284
|
+
"summary": "Runs connectivity check script for adapter",
|
|
285
|
+
"description": "Runs connectivity check script for adapter",
|
|
286
|
+
"input": [],
|
|
287
|
+
"output": {
|
|
288
|
+
"name": "result",
|
|
289
|
+
"type": "object",
|
|
290
|
+
"description": "A JSON Object containing the test results",
|
|
291
|
+
"schema": {
|
|
292
|
+
"title": "result",
|
|
293
|
+
"type": "object"
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
"roles": [
|
|
297
|
+
"admin"
|
|
298
|
+
],
|
|
299
|
+
"route": {
|
|
300
|
+
"verb": "POST",
|
|
301
|
+
"path": "/iapRunAdapterConnectivity"
|
|
302
|
+
},
|
|
303
|
+
"task": true
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
"name": "iapRunAdapterBasicGet",
|
|
307
|
+
"summary": "Runs basicGet script for adapter",
|
|
308
|
+
"description": "Runs basicGet script for adapter",
|
|
309
|
+
"input": [],
|
|
310
|
+
"output": {
|
|
311
|
+
"name": "result",
|
|
312
|
+
"type": "object",
|
|
313
|
+
"description": "A JSON Object containing the test results",
|
|
314
|
+
"schema": {
|
|
315
|
+
"title": "result",
|
|
316
|
+
"type": "object"
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
"roles": [
|
|
320
|
+
"admin"
|
|
321
|
+
],
|
|
322
|
+
"route": {
|
|
323
|
+
"verb": "POST",
|
|
324
|
+
"path": "/iapRunAdapterBasicGet"
|
|
325
|
+
},
|
|
326
|
+
"task": true
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "iapMoveAdapterEntitiesToDB",
|
|
330
|
+
"summary": "Moves entities from an adapter into the IAP database",
|
|
331
|
+
"description": "Moves entities from an adapter into the IAP database",
|
|
332
|
+
"input": [],
|
|
333
|
+
"output": {
|
|
334
|
+
"name": "res",
|
|
335
|
+
"type": "object",
|
|
336
|
+
"description": "A JSON Object containing status, code and the response from the mongo transaction",
|
|
337
|
+
"schema": {
|
|
338
|
+
"title": "res",
|
|
339
|
+
"type": "object"
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
"roles": [
|
|
343
|
+
"admin"
|
|
344
|
+
],
|
|
345
|
+
"route": {
|
|
346
|
+
"verb": "POST",
|
|
347
|
+
"path": "/iapMoveAdapterEntitiesToDB"
|
|
348
|
+
},
|
|
349
|
+
"task": true
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "iapDeactivateTasks",
|
|
353
|
+
"summary": "Deactivate the inputted tasks",
|
|
354
|
+
"description": "Deactivate the inputted tasks",
|
|
355
|
+
"input": [
|
|
356
|
+
{
|
|
357
|
+
"name": "tasks",
|
|
358
|
+
"type": "array",
|
|
359
|
+
"description": "Tasks to deactivate",
|
|
360
|
+
"schema": {
|
|
361
|
+
"title": "tasks",
|
|
362
|
+
"type": "array"
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
|
+
],
|
|
366
|
+
"output": {
|
|
367
|
+
"name": "result",
|
|
368
|
+
"type": "object",
|
|
369
|
+
"description": "A JSON Object containing success status",
|
|
370
|
+
"schema": {
|
|
371
|
+
"title": "result",
|
|
372
|
+
"type": "object"
|
|
373
|
+
}
|
|
374
|
+
},
|
|
375
|
+
"roles": [
|
|
376
|
+
"admin"
|
|
377
|
+
],
|
|
378
|
+
"route": {
|
|
379
|
+
"verb": "POST",
|
|
380
|
+
"path": "/iapDeactivateTasks"
|
|
381
|
+
},
|
|
382
|
+
"task": true
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"name": "iapActivateTasks",
|
|
386
|
+
"summary": "Activate the inputted tasks",
|
|
387
|
+
"description": "activate the inputted tasks",
|
|
388
|
+
"input": [
|
|
389
|
+
{
|
|
390
|
+
"name": "tasks",
|
|
391
|
+
"type": "array",
|
|
392
|
+
"description": "Tasks to activate",
|
|
393
|
+
"schema": {
|
|
394
|
+
"title": "tasks",
|
|
395
|
+
"type": "array"
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
],
|
|
399
|
+
"output": {
|
|
400
|
+
"name": "result",
|
|
401
|
+
"type": "object",
|
|
402
|
+
"description": "A JSON Object containing success status",
|
|
403
|
+
"schema": {
|
|
404
|
+
"title": "result",
|
|
405
|
+
"type": "object"
|
|
406
|
+
}
|
|
407
|
+
},
|
|
408
|
+
"roles": [
|
|
409
|
+
"admin"
|
|
410
|
+
],
|
|
411
|
+
"route": {
|
|
412
|
+
"verb": "POST",
|
|
413
|
+
"path": "/iapActivateTasks"
|
|
414
|
+
},
|
|
415
|
+
"task": true
|
|
416
|
+
},
|
|
417
|
+
{
|
|
418
|
+
"name": "iapPopulateEntityCache",
|
|
419
|
+
"summary": "Populate the cache for the given entities",
|
|
420
|
+
"description": "Populate the cache for the given entities",
|
|
421
|
+
"input": [
|
|
422
|
+
{
|
|
423
|
+
"name": "entityTypes",
|
|
424
|
+
"type": "array",
|
|
425
|
+
"info": "the entity type(s) to populate",
|
|
426
|
+
"required": true,
|
|
427
|
+
"schema": {
|
|
428
|
+
"title": "entityTypes",
|
|
429
|
+
"type": "array"
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
],
|
|
433
|
+
"output": {
|
|
434
|
+
"name": "result",
|
|
435
|
+
"type": "object",
|
|
436
|
+
"description": "A JSON Object containing status, code and the result",
|
|
437
|
+
"schema": {
|
|
438
|
+
"title": "result",
|
|
439
|
+
"type": "object"
|
|
440
|
+
}
|
|
441
|
+
},
|
|
442
|
+
"roles": [
|
|
443
|
+
"admin"
|
|
444
|
+
],
|
|
445
|
+
"route": {
|
|
446
|
+
"verb": "POST",
|
|
447
|
+
"path": "/iapPopulateEntityCache"
|
|
448
|
+
},
|
|
449
|
+
"task": true
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"name": "iapRetrieveEntitiesCache",
|
|
453
|
+
"summary": "Retrieves data from cache for specified entity type",
|
|
454
|
+
"description": "Retrieves data from cache for specified entity type",
|
|
455
|
+
"input": [
|
|
456
|
+
{
|
|
457
|
+
"name": "entityType",
|
|
458
|
+
"type": "string",
|
|
459
|
+
"info": "entity of which to retrieve",
|
|
460
|
+
"required": true,
|
|
461
|
+
"schema": {
|
|
462
|
+
"title": "entityType",
|
|
463
|
+
"type": "string"
|
|
464
|
+
}
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"name": "options",
|
|
468
|
+
"type": "object",
|
|
469
|
+
"info": "settings of which data to return and how to return it",
|
|
470
|
+
"required": false,
|
|
471
|
+
"schema": {
|
|
472
|
+
"title": "options",
|
|
473
|
+
"type": "object"
|
|
474
|
+
}
|
|
475
|
+
}
|
|
476
|
+
],
|
|
477
|
+
"output": {
|
|
478
|
+
"name": "result",
|
|
479
|
+
"type": "object",
|
|
480
|
+
"description": "A JSON Object containing status, code and the result",
|
|
481
|
+
"schema": {
|
|
482
|
+
"title": "result",
|
|
483
|
+
"type": "object"
|
|
484
|
+
}
|
|
485
|
+
},
|
|
486
|
+
"roles": [
|
|
487
|
+
"admin"
|
|
488
|
+
],
|
|
489
|
+
"route": {
|
|
490
|
+
"verb": "POST",
|
|
491
|
+
"path": "/iapRetrieveEntitiesCache"
|
|
492
|
+
},
|
|
493
|
+
"task": true
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "getDevice",
|
|
497
|
+
"summary": "Get the Appliance",
|
|
498
|
+
"description": "Get the Appliance",
|
|
499
|
+
"input": [
|
|
500
|
+
{
|
|
501
|
+
"name": "deviceName",
|
|
502
|
+
"type": "string",
|
|
503
|
+
"info": "An Appliance Device Name",
|
|
504
|
+
"required": true,
|
|
505
|
+
"schema": {
|
|
506
|
+
"title": "deviceName",
|
|
507
|
+
"type": "string"
|
|
508
|
+
}
|
|
509
|
+
}
|
|
510
|
+
],
|
|
511
|
+
"output": {
|
|
512
|
+
"name": "result",
|
|
513
|
+
"type": "object",
|
|
514
|
+
"description": "A JSON Object containing status, code and the result",
|
|
515
|
+
"schema": {
|
|
516
|
+
"title": "result",
|
|
517
|
+
"type": "object"
|
|
518
|
+
}
|
|
519
|
+
},
|
|
520
|
+
"roles": [
|
|
521
|
+
"admin"
|
|
522
|
+
],
|
|
523
|
+
"route": {
|
|
524
|
+
"verb": "POST",
|
|
525
|
+
"path": "/getDevice"
|
|
526
|
+
},
|
|
527
|
+
"task": false
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"name": "getDevicesFiltered",
|
|
531
|
+
"summary": "Get Appliances that match the filter",
|
|
532
|
+
"description": "Get Appliances that match the filter",
|
|
533
|
+
"input": [
|
|
534
|
+
{
|
|
535
|
+
"name": "options",
|
|
536
|
+
"type": "object",
|
|
537
|
+
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
|
|
538
|
+
"required": true,
|
|
539
|
+
"schema": {
|
|
540
|
+
"title": "options",
|
|
541
|
+
"type": "object"
|
|
542
|
+
}
|
|
543
|
+
}
|
|
544
|
+
],
|
|
545
|
+
"output": {
|
|
546
|
+
"name": "result",
|
|
547
|
+
"type": "array",
|
|
548
|
+
"description": "A JSON Object containing status, code and the result",
|
|
549
|
+
"schema": {
|
|
550
|
+
"title": "result",
|
|
551
|
+
"type": "array"
|
|
552
|
+
}
|
|
553
|
+
},
|
|
554
|
+
"roles": [
|
|
555
|
+
"admin"
|
|
556
|
+
],
|
|
557
|
+
"route": {
|
|
558
|
+
"verb": "POST",
|
|
559
|
+
"path": "/getDevicesFiltered"
|
|
560
|
+
},
|
|
561
|
+
"task": false
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"name": "isAlive",
|
|
565
|
+
"summary": "Checks the status for the provided Appliance",
|
|
566
|
+
"description": "Checks the status for the provided Appliance",
|
|
567
|
+
"input": [
|
|
568
|
+
{
|
|
569
|
+
"name": "deviceName",
|
|
570
|
+
"type": "string",
|
|
571
|
+
"info": "An Appliance Device Name",
|
|
572
|
+
"required": true,
|
|
573
|
+
"schema": {
|
|
574
|
+
"title": "deviceName",
|
|
575
|
+
"type": "string"
|
|
576
|
+
}
|
|
577
|
+
}
|
|
578
|
+
],
|
|
579
|
+
"output": {
|
|
580
|
+
"name": "result",
|
|
581
|
+
"type": "boolean",
|
|
582
|
+
"description": "A JSON Object containing status, code and the result",
|
|
583
|
+
"schema": {
|
|
584
|
+
"title": "result",
|
|
585
|
+
"type": "boolean"
|
|
586
|
+
}
|
|
587
|
+
},
|
|
588
|
+
"roles": [
|
|
589
|
+
"admin"
|
|
590
|
+
],
|
|
591
|
+
"route": {
|
|
592
|
+
"verb": "POST",
|
|
593
|
+
"path": "/isAlive"
|
|
594
|
+
},
|
|
595
|
+
"task": false
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"name": "getConfig",
|
|
599
|
+
"summary": "Gets a config for the provided Appliance",
|
|
600
|
+
"description": "Gets a config for the provided Appliance",
|
|
601
|
+
"input": [
|
|
602
|
+
{
|
|
603
|
+
"name": "deviceName",
|
|
604
|
+
"type": "string",
|
|
605
|
+
"info": "An Appliance Device Name",
|
|
606
|
+
"required": true,
|
|
607
|
+
"schema": {
|
|
608
|
+
"title": "deviceName",
|
|
609
|
+
"type": "string"
|
|
610
|
+
}
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"name": "format",
|
|
614
|
+
"type": "string",
|
|
615
|
+
"info": "The format to be returned - this is ignored as we always return json",
|
|
616
|
+
"required": false,
|
|
617
|
+
"schema": {
|
|
618
|
+
"title": "format",
|
|
619
|
+
"type": "string"
|
|
620
|
+
}
|
|
621
|
+
}
|
|
622
|
+
],
|
|
623
|
+
"output": {
|
|
624
|
+
"name": "result",
|
|
625
|
+
"type": "object",
|
|
626
|
+
"description": "A JSON Object containing status, code and the result",
|
|
627
|
+
"schema": {
|
|
628
|
+
"title": "result",
|
|
629
|
+
"type": "object"
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"roles": [
|
|
633
|
+
"admin"
|
|
634
|
+
],
|
|
635
|
+
"route": {
|
|
636
|
+
"verb": "POST",
|
|
637
|
+
"path": "/getConfig"
|
|
638
|
+
},
|
|
639
|
+
"task": false
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "iapGetDeviceCount",
|
|
643
|
+
"summary": "Gets a device count from the system",
|
|
644
|
+
"description": "Gets a device count from the system",
|
|
645
|
+
"input": [],
|
|
646
|
+
"output": {
|
|
647
|
+
"name": "result",
|
|
648
|
+
"type": "object",
|
|
649
|
+
"description": "A JSON Object containing status, code and the result",
|
|
650
|
+
"schema": {
|
|
651
|
+
"title": "result",
|
|
652
|
+
"type": "object"
|
|
653
|
+
}
|
|
654
|
+
},
|
|
655
|
+
"roles": [
|
|
656
|
+
"admin"
|
|
657
|
+
],
|
|
658
|
+
"route": {
|
|
659
|
+
"verb": "POST",
|
|
660
|
+
"path": "/iapGetDeviceCount"
|
|
661
|
+
},
|
|
662
|
+
"task": false
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
"name": "iapExpandedGenericAdapterRequest",
|
|
666
|
+
"summary": "Makes the requested generic call with additional options",
|
|
667
|
+
"description": "Makes the requested generic call with additional options via metadata",
|
|
668
|
+
"input": [
|
|
669
|
+
{
|
|
670
|
+
"name": "metadata",
|
|
671
|
+
"type": "object",
|
|
672
|
+
"info": "metadata for the call (optional)",
|
|
673
|
+
"description": "metadata for the call - allows for many enhancements (optional)",
|
|
674
|
+
"schema": {
|
|
675
|
+
"title": "metadata",
|
|
676
|
+
"type": "object"
|
|
677
|
+
},
|
|
678
|
+
"required": false
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "uriPath",
|
|
682
|
+
"type": "string",
|
|
683
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
684
|
+
"description": "the path of the api call",
|
|
685
|
+
"schema": {
|
|
686
|
+
"title": "uriPath",
|
|
687
|
+
"type": "string"
|
|
688
|
+
},
|
|
689
|
+
"required": false
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
"name": "restMethod",
|
|
693
|
+
"type": "string",
|
|
694
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
695
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
696
|
+
"schema": {
|
|
697
|
+
"title": "restMethod",
|
|
698
|
+
"type": "string"
|
|
699
|
+
},
|
|
700
|
+
"required": false
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"name": "pathVars",
|
|
704
|
+
"type": "object",
|
|
705
|
+
"info": "the parameters to be put within the url path (optional)",
|
|
706
|
+
"description": "the parameters to be put within the url path (optional)",
|
|
707
|
+
"schema": {
|
|
708
|
+
"title": "pathVars",
|
|
709
|
+
"type": "object"
|
|
710
|
+
},
|
|
711
|
+
"required": false
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"name": "queryData",
|
|
715
|
+
"type": "object",
|
|
716
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
717
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
718
|
+
"schema": {
|
|
719
|
+
"title": "queryData",
|
|
720
|
+
"type": "object"
|
|
721
|
+
},
|
|
722
|
+
"required": false
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"name": "requestBody",
|
|
726
|
+
"type": "object",
|
|
727
|
+
"info": "the payload to be sent with the request (optional)",
|
|
728
|
+
"description": "the payload to be sent with the request (optional)",
|
|
729
|
+
"schema": {
|
|
730
|
+
"title": "requestBody",
|
|
731
|
+
"type": "object"
|
|
732
|
+
},
|
|
733
|
+
"required": false
|
|
734
|
+
},
|
|
735
|
+
{
|
|
736
|
+
"name": "addlHeaders",
|
|
737
|
+
"type": "object",
|
|
738
|
+
"info": "additional headers to be put on the call (optional)",
|
|
739
|
+
"description": "additional headers to be put on the call (optional)",
|
|
740
|
+
"schema": {
|
|
741
|
+
"title": "addlHeaders",
|
|
742
|
+
"type": "object"
|
|
743
|
+
},
|
|
744
|
+
"required": false
|
|
745
|
+
}
|
|
746
|
+
],
|
|
747
|
+
"output": {
|
|
748
|
+
"name": "result",
|
|
749
|
+
"type": "object",
|
|
750
|
+
"description": "A JSON Object containing status, code and the result",
|
|
751
|
+
"schema": {
|
|
752
|
+
"title": "result",
|
|
753
|
+
"type": "object"
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
"roles": [
|
|
757
|
+
"admin"
|
|
758
|
+
],
|
|
759
|
+
"route": {
|
|
760
|
+
"verb": "POST",
|
|
761
|
+
"path": "/iapExpandedGenericAdapterRequest"
|
|
762
|
+
},
|
|
763
|
+
"task": true
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"name": "genericAdapterRequest",
|
|
767
|
+
"summary": "Makes the requested generic call",
|
|
768
|
+
"description": "Makes the requested generic call",
|
|
769
|
+
"input": [
|
|
770
|
+
{
|
|
771
|
+
"name": "uriPath",
|
|
772
|
+
"type": "string",
|
|
773
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
774
|
+
"description": "the path of the api call",
|
|
775
|
+
"schema": {
|
|
776
|
+
"title": "uriPath",
|
|
777
|
+
"type": "string"
|
|
778
|
+
},
|
|
779
|
+
"required": true
|
|
780
|
+
},
|
|
781
|
+
{
|
|
782
|
+
"name": "restMethod",
|
|
783
|
+
"type": "string",
|
|
784
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
785
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
786
|
+
"schema": {
|
|
787
|
+
"title": "restMethod",
|
|
788
|
+
"type": "string"
|
|
789
|
+
},
|
|
790
|
+
"required": true
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
"name": "queryData",
|
|
794
|
+
"type": "object",
|
|
795
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
796
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
797
|
+
"schema": {
|
|
798
|
+
"title": "queryData",
|
|
799
|
+
"type": "object"
|
|
800
|
+
},
|
|
801
|
+
"required": false
|
|
802
|
+
},
|
|
803
|
+
{
|
|
804
|
+
"name": "requestBody",
|
|
805
|
+
"type": "object",
|
|
806
|
+
"info": "the payload to be sent with the request (optional)",
|
|
807
|
+
"description": "the payload to be sent with the request (optional)",
|
|
808
|
+
"schema": {
|
|
809
|
+
"title": "requestBody",
|
|
810
|
+
"type": "object"
|
|
811
|
+
},
|
|
812
|
+
"required": false
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "addlHeaders",
|
|
816
|
+
"type": "object",
|
|
817
|
+
"info": "additional headers to be put on the call (optional)",
|
|
818
|
+
"description": "additional headers to be put on the call (optional)",
|
|
819
|
+
"schema": {
|
|
820
|
+
"title": "addlHeaders",
|
|
821
|
+
"type": "object"
|
|
822
|
+
},
|
|
823
|
+
"required": false
|
|
824
|
+
}
|
|
825
|
+
],
|
|
826
|
+
"output": {
|
|
827
|
+
"name": "result",
|
|
828
|
+
"type": "object",
|
|
829
|
+
"description": "A JSON Object containing status, code and the result",
|
|
830
|
+
"schema": {
|
|
831
|
+
"title": "result",
|
|
832
|
+
"type": "object"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"roles": [
|
|
836
|
+
"admin"
|
|
837
|
+
],
|
|
838
|
+
"route": {
|
|
839
|
+
"verb": "POST",
|
|
840
|
+
"path": "/genericAdapterRequest"
|
|
841
|
+
},
|
|
842
|
+
"task": true
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
"name": "genericAdapterRequestNoBasePath",
|
|
846
|
+
"summary": "Makes the requested generic call",
|
|
847
|
+
"description": "Makes the requested generic call",
|
|
848
|
+
"input": [
|
|
849
|
+
{
|
|
850
|
+
"name": "uriPath",
|
|
851
|
+
"type": "string",
|
|
852
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
853
|
+
"description": "the path of the api call",
|
|
854
|
+
"schema": {
|
|
855
|
+
"title": "uriPath",
|
|
856
|
+
"type": "string"
|
|
857
|
+
},
|
|
858
|
+
"required": true
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "restMethod",
|
|
862
|
+
"type": "string",
|
|
863
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
864
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
865
|
+
"schema": {
|
|
866
|
+
"title": "restMethod",
|
|
867
|
+
"type": "string"
|
|
868
|
+
},
|
|
869
|
+
"required": true
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"name": "queryData",
|
|
873
|
+
"type": "object",
|
|
874
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
875
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
876
|
+
"schema": {
|
|
877
|
+
"title": "queryData",
|
|
878
|
+
"type": "object"
|
|
879
|
+
},
|
|
880
|
+
"required": false
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "requestBody",
|
|
884
|
+
"type": "object",
|
|
885
|
+
"info": "the payload to be sent with the request (optional)",
|
|
886
|
+
"description": "the payload to be sent with the request (optional)",
|
|
887
|
+
"schema": {
|
|
888
|
+
"title": "requestBody",
|
|
889
|
+
"type": "object"
|
|
890
|
+
},
|
|
891
|
+
"required": false
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
"name": "addlHeaders",
|
|
895
|
+
"type": "object",
|
|
896
|
+
"info": "additional headers to be put on the call (optional)",
|
|
897
|
+
"description": "additional headers to be put on the call (optional)",
|
|
898
|
+
"schema": {
|
|
899
|
+
"title": "addlHeaders",
|
|
900
|
+
"type": "object"
|
|
901
|
+
},
|
|
902
|
+
"required": false
|
|
903
|
+
}
|
|
904
|
+
],
|
|
905
|
+
"output": {
|
|
906
|
+
"name": "result",
|
|
907
|
+
"type": "object",
|
|
908
|
+
"description": "A JSON Object containing status, code and the result",
|
|
909
|
+
"schema": {
|
|
910
|
+
"title": "result",
|
|
911
|
+
"type": "object"
|
|
912
|
+
}
|
|
913
|
+
},
|
|
914
|
+
"roles": [
|
|
915
|
+
"admin"
|
|
916
|
+
],
|
|
917
|
+
"route": {
|
|
918
|
+
"verb": "POST",
|
|
919
|
+
"path": "/genericAdapterRequestNoBasePath"
|
|
920
|
+
},
|
|
921
|
+
"task": true
|
|
922
|
+
},
|
|
923
|
+
{
|
|
924
|
+
"name": "iapRunAdapterLint",
|
|
925
|
+
"summary": "Run the adapter lint script to return the results",
|
|
926
|
+
"description": "Run the adapter lint script to return the results",
|
|
927
|
+
"input": [],
|
|
928
|
+
"output": {
|
|
929
|
+
"name": "result",
|
|
930
|
+
"type": "string",
|
|
931
|
+
"description": "A string containing the run results",
|
|
932
|
+
"schema": {
|
|
933
|
+
"title": "result",
|
|
934
|
+
"type": "string"
|
|
935
|
+
}
|
|
936
|
+
},
|
|
937
|
+
"roles": [
|
|
938
|
+
"admin"
|
|
939
|
+
],
|
|
940
|
+
"route": {
|
|
941
|
+
"verb": "GET",
|
|
942
|
+
"path": "/iapRunAdapterLint"
|
|
943
|
+
},
|
|
944
|
+
"task": true
|
|
945
|
+
},
|
|
946
|
+
{
|
|
947
|
+
"name": "iapRunAdapterTests",
|
|
948
|
+
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
|
|
949
|
+
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
|
|
950
|
+
"input": [],
|
|
951
|
+
"output": {
|
|
952
|
+
"name": "result",
|
|
953
|
+
"type": "object",
|
|
954
|
+
"description": "A JSON Object containing status, code and the result",
|
|
955
|
+
"schema": {
|
|
956
|
+
"title": "result",
|
|
957
|
+
"type": "object"
|
|
958
|
+
}
|
|
959
|
+
},
|
|
960
|
+
"roles": [
|
|
961
|
+
"admin"
|
|
962
|
+
],
|
|
963
|
+
"route": {
|
|
964
|
+
"verb": "GET",
|
|
965
|
+
"path": "/iapRunAdapterTests"
|
|
966
|
+
},
|
|
967
|
+
"task": true
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"name": "iapGetAdapterInventory",
|
|
971
|
+
"summary": "Provide inventory information abbout the adapter",
|
|
972
|
+
"description": "Provide inventory information abbout the adapter",
|
|
973
|
+
"input": [],
|
|
974
|
+
"output": {
|
|
975
|
+
"name": "result",
|
|
976
|
+
"type": "object",
|
|
977
|
+
"description": "A JSON Object containing status, code and the result",
|
|
978
|
+
"schema": {
|
|
979
|
+
"title": "result",
|
|
980
|
+
"type": "object"
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
"roles": [
|
|
984
|
+
"admin"
|
|
985
|
+
],
|
|
986
|
+
"route": {
|
|
987
|
+
"verb": "GET",
|
|
988
|
+
"path": "/iapGetAdapterInventory"
|
|
989
|
+
},
|
|
990
|
+
"task": true
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "runExpressionSet",
|
|
994
|
+
"summary": "runExpressionSet",
|
|
995
|
+
"description": "# Expression Set Actions\n\nInvoke an active expression set. An expression set is a user-defined rule that accepts an input and returns the output based on the configured function.\n\nThe configured function of an expression set can be a simple decision matrix lookup, a calculation based on a mathematical formula, a condition, or another expression set.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runExpressionSet...(description truncated)",
|
|
996
|
+
"input": [
|
|
997
|
+
{
|
|
998
|
+
"name": "expressionSetAPIName",
|
|
999
|
+
"type": "string",
|
|
1000
|
+
"info": "The API name of an expression set is unique within your Salesforce instance.: string",
|
|
1001
|
+
"required": true,
|
|
1002
|
+
"schema": {
|
|
1003
|
+
"title": "expressionSetAPIName",
|
|
1004
|
+
"type": "string"
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
"name": "body",
|
|
1009
|
+
"type": "object",
|
|
1010
|
+
"info": ": object",
|
|
1011
|
+
"required": true,
|
|
1012
|
+
"schema": {
|
|
1013
|
+
"allOf": [
|
|
1014
|
+
{
|
|
1015
|
+
"type": "object"
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
"type": "object"
|
|
1019
|
+
}
|
|
1020
|
+
],
|
|
1021
|
+
"definitions": {}
|
|
1022
|
+
}
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"name": "iapMetadata",
|
|
1026
|
+
"type": "object",
|
|
1027
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1028
|
+
"required": false,
|
|
1029
|
+
"schema": {
|
|
1030
|
+
"title": "iapMetadata",
|
|
1031
|
+
"type": "object"
|
|
1032
|
+
}
|
|
1033
|
+
}
|
|
1034
|
+
],
|
|
1035
|
+
"output": {
|
|
1036
|
+
"name": "result",
|
|
1037
|
+
"type": "object",
|
|
1038
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1039
|
+
"schema": {
|
|
1040
|
+
"title": "result",
|
|
1041
|
+
"type": "object"
|
|
1042
|
+
}
|
|
1043
|
+
},
|
|
1044
|
+
"roles": [
|
|
1045
|
+
"admin"
|
|
1046
|
+
],
|
|
1047
|
+
"route": {
|
|
1048
|
+
"verb": "POST",
|
|
1049
|
+
"path": "/runExpressionSet"
|
|
1050
|
+
},
|
|
1051
|
+
"task": true
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "runDecisionMatrix",
|
|
1055
|
+
"summary": "runDecisionMatrix",
|
|
1056
|
+
"description": "# Decision Matrix Actions\n\nInvoke a decision matrix in a flow with the Decision Matrix Actions. A decision matrix is a user-defined table where you can look up an output based on the inputs you provide.\n\nFor example, you can look up a candidate’s eligibility to avail medical insurance in a decision matrix based on the candidate’s age and gender.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runDecisionMatrix/{U...(description truncated)",
|
|
1057
|
+
"input": [
|
|
1058
|
+
{
|
|
1059
|
+
"name": "uniqueName",
|
|
1060
|
+
"type": "string",
|
|
1061
|
+
"info": "The value of UniqueName is the unique identifier of the record, which is sourced from the name of a decision matrix.: string",
|
|
1062
|
+
"required": true,
|
|
1063
|
+
"schema": {
|
|
1064
|
+
"title": "uniqueName",
|
|
1065
|
+
"type": "string"
|
|
1066
|
+
}
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "body",
|
|
1070
|
+
"type": "object",
|
|
1071
|
+
"info": ": object",
|
|
1072
|
+
"required": true,
|
|
1073
|
+
"schema": {
|
|
1074
|
+
"allOf": [
|
|
1075
|
+
{
|
|
1076
|
+
"type": "object"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"type": "object"
|
|
1080
|
+
}
|
|
1081
|
+
],
|
|
1082
|
+
"definitions": {}
|
|
1083
|
+
}
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "iapMetadata",
|
|
1087
|
+
"type": "object",
|
|
1088
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1089
|
+
"required": false,
|
|
1090
|
+
"schema": {
|
|
1091
|
+
"title": "iapMetadata",
|
|
1092
|
+
"type": "object"
|
|
1093
|
+
}
|
|
1094
|
+
}
|
|
1095
|
+
],
|
|
1096
|
+
"output": {
|
|
1097
|
+
"name": "result",
|
|
1098
|
+
"type": "object",
|
|
1099
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1100
|
+
"schema": {
|
|
1101
|
+
"title": "result",
|
|
1102
|
+
"type": "object"
|
|
1103
|
+
}
|
|
1104
|
+
},
|
|
1105
|
+
"roles": [
|
|
1106
|
+
"admin"
|
|
1107
|
+
],
|
|
1108
|
+
"route": {
|
|
1109
|
+
"verb": "POST",
|
|
1110
|
+
"path": "/runDecisionMatrix"
|
|
1111
|
+
},
|
|
1112
|
+
"task": true
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
"name": "standardInvocableActions",
|
|
1116
|
+
"summary": "Standard Invocable Actions",
|
|
1117
|
+
"description": "Returns the list of actions that can be statically invoked. You can also get basic information for each type of action.\nThis resource is available in REST API version 32.0 and later.",
|
|
1118
|
+
"input": [
|
|
1119
|
+
{
|
|
1120
|
+
"name": "iapMetadata",
|
|
1121
|
+
"type": "object",
|
|
1122
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1123
|
+
"required": false,
|
|
1124
|
+
"schema": {
|
|
1125
|
+
"title": "iapMetadata",
|
|
1126
|
+
"type": "object"
|
|
1127
|
+
}
|
|
1128
|
+
}
|
|
1129
|
+
],
|
|
1130
|
+
"output": {
|
|
1131
|
+
"name": "result",
|
|
1132
|
+
"type": "object",
|
|
1133
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1134
|
+
"schema": {
|
|
1135
|
+
"title": "result",
|
|
1136
|
+
"type": "object"
|
|
1137
|
+
}
|
|
1138
|
+
},
|
|
1139
|
+
"roles": [
|
|
1140
|
+
"admin"
|
|
1141
|
+
],
|
|
1142
|
+
"route": {
|
|
1143
|
+
"verb": "GET",
|
|
1144
|
+
"path": "/standardInvocableActions"
|
|
1145
|
+
},
|
|
1146
|
+
"task": true
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "customInvocableActions",
|
|
1150
|
+
"summary": "Custom Invocable Actions",
|
|
1151
|
+
"description": "Returns the list of all custom actions. You can also get basic information for each type of action.\nThis resource is available in REST API version 32.0 and later.",
|
|
1152
|
+
"input": [
|
|
1153
|
+
{
|
|
1154
|
+
"name": "iapMetadata",
|
|
1155
|
+
"type": "object",
|
|
1156
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1157
|
+
"required": false,
|
|
1158
|
+
"schema": {
|
|
1159
|
+
"title": "iapMetadata",
|
|
1160
|
+
"type": "object"
|
|
1161
|
+
}
|
|
1162
|
+
}
|
|
1163
|
+
],
|
|
1164
|
+
"output": {
|
|
1165
|
+
"name": "result",
|
|
1166
|
+
"type": "object",
|
|
1167
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1168
|
+
"schema": {
|
|
1169
|
+
"title": "result",
|
|
1170
|
+
"type": "object"
|
|
1171
|
+
}
|
|
1172
|
+
},
|
|
1173
|
+
"roles": [
|
|
1174
|
+
"admin"
|
|
1175
|
+
],
|
|
1176
|
+
"route": {
|
|
1177
|
+
"verb": "GET",
|
|
1178
|
+
"path": "/customInvocableActions"
|
|
1179
|
+
},
|
|
1180
|
+
"task": true
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
"name": "launchFlow",
|
|
1184
|
+
"summary": "Launch Flow",
|
|
1185
|
+
"description": "Launches an Autolaunched Flow with the supplied input parameters.",
|
|
1186
|
+
"input": [
|
|
1187
|
+
{
|
|
1188
|
+
"name": "flowApiName",
|
|
1189
|
+
"type": "string",
|
|
1190
|
+
"info": "Flow API Name: string",
|
|
1191
|
+
"required": true,
|
|
1192
|
+
"schema": {
|
|
1193
|
+
"title": "flowApiName",
|
|
1194
|
+
"type": "string"
|
|
1195
|
+
}
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"name": "body",
|
|
1199
|
+
"type": "object",
|
|
1200
|
+
"info": ": object",
|
|
1201
|
+
"required": true,
|
|
1202
|
+
"schema": {
|
|
1203
|
+
"allOf": [
|
|
1204
|
+
{
|
|
1205
|
+
"type": "object"
|
|
1206
|
+
},
|
|
1207
|
+
{
|
|
1208
|
+
"type": "object"
|
|
1209
|
+
}
|
|
1210
|
+
],
|
|
1211
|
+
"definitions": {}
|
|
1212
|
+
}
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"name": "iapMetadata",
|
|
1216
|
+
"type": "object",
|
|
1217
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1218
|
+
"required": false,
|
|
1219
|
+
"schema": {
|
|
1220
|
+
"title": "iapMetadata",
|
|
1221
|
+
"type": "object"
|
|
1222
|
+
}
|
|
1223
|
+
}
|
|
1224
|
+
],
|
|
1225
|
+
"output": {
|
|
1226
|
+
"name": "result",
|
|
1227
|
+
"type": "object",
|
|
1228
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1229
|
+
"schema": {
|
|
1230
|
+
"title": "result",
|
|
1231
|
+
"type": "object"
|
|
1232
|
+
}
|
|
1233
|
+
},
|
|
1234
|
+
"roles": [
|
|
1235
|
+
"admin"
|
|
1236
|
+
],
|
|
1237
|
+
"route": {
|
|
1238
|
+
"verb": "POST",
|
|
1239
|
+
"path": "/launchFlow"
|
|
1240
|
+
},
|
|
1241
|
+
"task": true
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"name": "quickActions",
|
|
1245
|
+
"summary": "Quick Actions",
|
|
1246
|
+
"description": "Returns a list of global actions and object-specific actions. This resource is available in REST API version 28.0 and later. When working with actions, also refer to SObject Quick Actions.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_quickactions.htm",
|
|
1247
|
+
"input": [
|
|
1248
|
+
{
|
|
1249
|
+
"name": "iapMetadata",
|
|
1250
|
+
"type": "object",
|
|
1251
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1252
|
+
"required": false,
|
|
1253
|
+
"schema": {
|
|
1254
|
+
"title": "iapMetadata",
|
|
1255
|
+
"type": "object"
|
|
1256
|
+
}
|
|
1257
|
+
}
|
|
1258
|
+
],
|
|
1259
|
+
"output": {
|
|
1260
|
+
"name": "result",
|
|
1261
|
+
"type": "object",
|
|
1262
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1263
|
+
"schema": {
|
|
1264
|
+
"title": "result",
|
|
1265
|
+
"type": "object"
|
|
1266
|
+
}
|
|
1267
|
+
},
|
|
1268
|
+
"roles": [
|
|
1269
|
+
"admin"
|
|
1270
|
+
],
|
|
1271
|
+
"route": {
|
|
1272
|
+
"verb": "GET",
|
|
1273
|
+
"path": "/quickActions"
|
|
1274
|
+
},
|
|
1275
|
+
"task": true
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
"name": "describeGlobal",
|
|
1279
|
+
"summary": "Describe Global",
|
|
1280
|
+
"description": "Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.\n\nYou can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.",
|
|
1281
|
+
"input": [
|
|
1282
|
+
{
|
|
1283
|
+
"name": "iapMetadata",
|
|
1284
|
+
"type": "object",
|
|
1285
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1286
|
+
"required": false,
|
|
1287
|
+
"schema": {
|
|
1288
|
+
"title": "iapMetadata",
|
|
1289
|
+
"type": "object"
|
|
1290
|
+
}
|
|
1291
|
+
}
|
|
1292
|
+
],
|
|
1293
|
+
"output": {
|
|
1294
|
+
"name": "result",
|
|
1295
|
+
"type": "object",
|
|
1296
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1297
|
+
"schema": {
|
|
1298
|
+
"title": "result",
|
|
1299
|
+
"type": "object"
|
|
1300
|
+
}
|
|
1301
|
+
},
|
|
1302
|
+
"roles": [
|
|
1303
|
+
"admin"
|
|
1304
|
+
],
|
|
1305
|
+
"route": {
|
|
1306
|
+
"verb": "GET",
|
|
1307
|
+
"path": "/describeGlobal"
|
|
1308
|
+
},
|
|
1309
|
+
"task": true
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"name": "downloadfile",
|
|
1313
|
+
"summary": "Download file",
|
|
1314
|
+
"description": "Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.\n\nYou can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.",
|
|
1315
|
+
"input": [
|
|
1316
|
+
{
|
|
1317
|
+
"name": "contentVersionId",
|
|
1318
|
+
"type": "string",
|
|
1319
|
+
"info": "Content Version Id: string",
|
|
1320
|
+
"required": true,
|
|
1321
|
+
"schema": {
|
|
1322
|
+
"title": "contentVersionId",
|
|
1323
|
+
"type": "string"
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
{
|
|
1327
|
+
"name": "iapMetadata",
|
|
1328
|
+
"type": "object",
|
|
1329
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1330
|
+
"required": false,
|
|
1331
|
+
"schema": {
|
|
1332
|
+
"title": "iapMetadata",
|
|
1333
|
+
"type": "object"
|
|
1334
|
+
}
|
|
1335
|
+
}
|
|
1336
|
+
],
|
|
1337
|
+
"output": {
|
|
1338
|
+
"name": "result",
|
|
1339
|
+
"type": "object",
|
|
1340
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1341
|
+
"schema": {
|
|
1342
|
+
"title": "result",
|
|
1343
|
+
"type": "object"
|
|
1344
|
+
}
|
|
1345
|
+
},
|
|
1346
|
+
"roles": [
|
|
1347
|
+
"admin"
|
|
1348
|
+
],
|
|
1349
|
+
"route": {
|
|
1350
|
+
"verb": "POST",
|
|
1351
|
+
"path": "/downloadfile"
|
|
1352
|
+
},
|
|
1353
|
+
"task": true
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
"name": "sObjectBasicInformation",
|
|
1357
|
+
"summary": "SObject Basic Information",
|
|
1358
|
+
"description": "Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.",
|
|
1359
|
+
"input": [
|
|
1360
|
+
{
|
|
1361
|
+
"name": "sobjectName",
|
|
1362
|
+
"type": "string",
|
|
1363
|
+
"info": ": string",
|
|
1364
|
+
"required": true,
|
|
1365
|
+
"schema": {
|
|
1366
|
+
"title": "sobjectName",
|
|
1367
|
+
"type": "string"
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
"name": "iapMetadata",
|
|
1372
|
+
"type": "object",
|
|
1373
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1374
|
+
"required": false,
|
|
1375
|
+
"schema": {
|
|
1376
|
+
"title": "iapMetadata",
|
|
1377
|
+
"type": "object"
|
|
1378
|
+
}
|
|
1379
|
+
}
|
|
1380
|
+
],
|
|
1381
|
+
"output": {
|
|
1382
|
+
"name": "result",
|
|
1383
|
+
"type": "object",
|
|
1384
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1385
|
+
"schema": {
|
|
1386
|
+
"title": "result",
|
|
1387
|
+
"type": "object"
|
|
1388
|
+
}
|
|
1389
|
+
},
|
|
1390
|
+
"roles": [
|
|
1391
|
+
"admin"
|
|
1392
|
+
],
|
|
1393
|
+
"route": {
|
|
1394
|
+
"verb": "POST",
|
|
1395
|
+
"path": "/sObjectBasicInformation"
|
|
1396
|
+
},
|
|
1397
|
+
"task": true
|
|
1398
|
+
},
|
|
1399
|
+
{
|
|
1400
|
+
"name": "sObjectCreate",
|
|
1401
|
+
"summary": "SObject Create",
|
|
1402
|
+
"description": "SObject Create",
|
|
1403
|
+
"input": [
|
|
1404
|
+
{
|
|
1405
|
+
"name": "sobjectName",
|
|
1406
|
+
"type": "string",
|
|
1407
|
+
"info": ": string",
|
|
1408
|
+
"required": true,
|
|
1409
|
+
"schema": {
|
|
1410
|
+
"title": "sobjectName",
|
|
1411
|
+
"type": "string"
|
|
1412
|
+
}
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
"name": "body",
|
|
1416
|
+
"type": "object",
|
|
1417
|
+
"info": ": object",
|
|
1418
|
+
"required": true,
|
|
1419
|
+
"schema": {
|
|
1420
|
+
"allOf": [
|
|
1421
|
+
{
|
|
1422
|
+
"type": "object"
|
|
1423
|
+
},
|
|
1424
|
+
{
|
|
1425
|
+
"type": "object"
|
|
1426
|
+
}
|
|
1427
|
+
],
|
|
1428
|
+
"definitions": {}
|
|
1429
|
+
}
|
|
1430
|
+
},
|
|
1431
|
+
{
|
|
1432
|
+
"name": "iapMetadata",
|
|
1433
|
+
"type": "object",
|
|
1434
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1435
|
+
"required": false,
|
|
1436
|
+
"schema": {
|
|
1437
|
+
"title": "iapMetadata",
|
|
1438
|
+
"type": "object"
|
|
1439
|
+
}
|
|
1440
|
+
}
|
|
1441
|
+
],
|
|
1442
|
+
"output": {
|
|
1443
|
+
"name": "result",
|
|
1444
|
+
"type": "object",
|
|
1445
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1446
|
+
"schema": {
|
|
1447
|
+
"title": "result",
|
|
1448
|
+
"type": "object"
|
|
1449
|
+
}
|
|
1450
|
+
},
|
|
1451
|
+
"roles": [
|
|
1452
|
+
"admin"
|
|
1453
|
+
],
|
|
1454
|
+
"route": {
|
|
1455
|
+
"verb": "POST",
|
|
1456
|
+
"path": "/sObjectCreate"
|
|
1457
|
+
},
|
|
1458
|
+
"task": true
|
|
1459
|
+
},
|
|
1460
|
+
{
|
|
1461
|
+
"name": "sObjectDescribe",
|
|
1462
|
+
"summary": "SObject Describe",
|
|
1463
|
+
"description": "Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.",
|
|
1464
|
+
"input": [
|
|
1465
|
+
{
|
|
1466
|
+
"name": "sobjectName",
|
|
1467
|
+
"type": "string",
|
|
1468
|
+
"info": "Object API name: string",
|
|
1469
|
+
"required": true,
|
|
1470
|
+
"schema": {
|
|
1471
|
+
"title": "sobjectName",
|
|
1472
|
+
"type": "string"
|
|
1473
|
+
}
|
|
1474
|
+
},
|
|
1475
|
+
{
|
|
1476
|
+
"name": "iapMetadata",
|
|
1477
|
+
"type": "object",
|
|
1478
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1479
|
+
"required": false,
|
|
1480
|
+
"schema": {
|
|
1481
|
+
"title": "iapMetadata",
|
|
1482
|
+
"type": "object"
|
|
1483
|
+
}
|
|
1484
|
+
}
|
|
1485
|
+
],
|
|
1486
|
+
"output": {
|
|
1487
|
+
"name": "result",
|
|
1488
|
+
"type": "object",
|
|
1489
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1490
|
+
"schema": {
|
|
1491
|
+
"title": "result",
|
|
1492
|
+
"type": "object"
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
"roles": [
|
|
1496
|
+
"admin"
|
|
1497
|
+
],
|
|
1498
|
+
"route": {
|
|
1499
|
+
"verb": "POST",
|
|
1500
|
+
"path": "/sObjectDescribe"
|
|
1501
|
+
},
|
|
1502
|
+
"task": true
|
|
1503
|
+
},
|
|
1504
|
+
{
|
|
1505
|
+
"name": "sObjectGetDeleted",
|
|
1506
|
+
"summary": "SObject Get Deleted",
|
|
1507
|
+
"description": "Retrieves the list of individual records that have been deleted within the given timespan for the specified object. SObject Get Deleted is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nDeleted records are written to a delete log which this resource accesses. A background process that runs every two hours purges records that have been in an organization's delete log for more than two hours if the numbe...(description truncated)",
|
|
1508
|
+
"input": [
|
|
1509
|
+
{
|
|
1510
|
+
"name": "start",
|
|
1511
|
+
"type": "string",
|
|
1512
|
+
"info": ": string",
|
|
1513
|
+
"required": true,
|
|
1514
|
+
"schema": {
|
|
1515
|
+
"title": "start",
|
|
1516
|
+
"type": "string"
|
|
1517
|
+
}
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
"name": "end",
|
|
1521
|
+
"type": "string",
|
|
1522
|
+
"info": ": string",
|
|
1523
|
+
"required": true,
|
|
1524
|
+
"schema": {
|
|
1525
|
+
"title": "end",
|
|
1526
|
+
"type": "string"
|
|
1527
|
+
}
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"name": "sobjectName",
|
|
1531
|
+
"type": "string",
|
|
1532
|
+
"info": ": string",
|
|
1533
|
+
"required": true,
|
|
1534
|
+
"schema": {
|
|
1535
|
+
"title": "sobjectName",
|
|
1536
|
+
"type": "string"
|
|
1537
|
+
}
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"name": "iapMetadata",
|
|
1541
|
+
"type": "object",
|
|
1542
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1543
|
+
"required": false,
|
|
1544
|
+
"schema": {
|
|
1545
|
+
"title": "iapMetadata",
|
|
1546
|
+
"type": "object"
|
|
1547
|
+
}
|
|
1548
|
+
}
|
|
1549
|
+
],
|
|
1550
|
+
"output": {
|
|
1551
|
+
"name": "result",
|
|
1552
|
+
"type": "object",
|
|
1553
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1554
|
+
"schema": {
|
|
1555
|
+
"title": "result",
|
|
1556
|
+
"type": "object"
|
|
1557
|
+
}
|
|
1558
|
+
},
|
|
1559
|
+
"roles": [
|
|
1560
|
+
"admin"
|
|
1561
|
+
],
|
|
1562
|
+
"route": {
|
|
1563
|
+
"verb": "POST",
|
|
1564
|
+
"path": "/sObjectGetDeleted"
|
|
1565
|
+
},
|
|
1566
|
+
"task": true
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
"name": "sObjectGetUpdated",
|
|
1570
|
+
"summary": "SObject Get Updated",
|
|
1571
|
+
"description": "Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object. SObject Get Updated is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nResults are returned for no more than 30 days previous to the day the call is executed.\nYour client application can replicate any objects to which it has sufficient permissions. For example, to replic...(description truncated)",
|
|
1572
|
+
"input": [
|
|
1573
|
+
{
|
|
1574
|
+
"name": "start",
|
|
1575
|
+
"type": "string",
|
|
1576
|
+
"info": ": string",
|
|
1577
|
+
"required": true,
|
|
1578
|
+
"schema": {
|
|
1579
|
+
"title": "start",
|
|
1580
|
+
"type": "string"
|
|
1581
|
+
}
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"name": "end",
|
|
1585
|
+
"type": "string",
|
|
1586
|
+
"info": ": string",
|
|
1587
|
+
"required": true,
|
|
1588
|
+
"schema": {
|
|
1589
|
+
"title": "end",
|
|
1590
|
+
"type": "string"
|
|
1591
|
+
}
|
|
1592
|
+
},
|
|
1593
|
+
{
|
|
1594
|
+
"name": "sobjectName",
|
|
1595
|
+
"type": "string",
|
|
1596
|
+
"info": ": string",
|
|
1597
|
+
"required": true,
|
|
1598
|
+
"schema": {
|
|
1599
|
+
"title": "sobjectName",
|
|
1600
|
+
"type": "string"
|
|
1601
|
+
}
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "iapMetadata",
|
|
1605
|
+
"type": "object",
|
|
1606
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1607
|
+
"required": false,
|
|
1608
|
+
"schema": {
|
|
1609
|
+
"title": "iapMetadata",
|
|
1610
|
+
"type": "object"
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
],
|
|
1614
|
+
"output": {
|
|
1615
|
+
"name": "result",
|
|
1616
|
+
"type": "object",
|
|
1617
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1618
|
+
"schema": {
|
|
1619
|
+
"title": "result",
|
|
1620
|
+
"type": "object"
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"roles": [
|
|
1624
|
+
"admin"
|
|
1625
|
+
],
|
|
1626
|
+
"route": {
|
|
1627
|
+
"verb": "POST",
|
|
1628
|
+
"path": "/sObjectGetUpdated"
|
|
1629
|
+
},
|
|
1630
|
+
"task": true
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"name": "sObjectNamedLayouts",
|
|
1634
|
+
"summary": "SObject Named Layouts",
|
|
1635
|
+
"description": "Retrieves information about alternate named layouts for a given object.",
|
|
1636
|
+
"input": [
|
|
1637
|
+
{
|
|
1638
|
+
"name": "sobjectName",
|
|
1639
|
+
"type": "string",
|
|
1640
|
+
"info": ": string",
|
|
1641
|
+
"required": true,
|
|
1642
|
+
"schema": {
|
|
1643
|
+
"title": "sobjectName",
|
|
1644
|
+
"type": "string"
|
|
1645
|
+
}
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"name": "layoutName",
|
|
1649
|
+
"type": "string",
|
|
1650
|
+
"info": ": string",
|
|
1651
|
+
"required": true,
|
|
1652
|
+
"schema": {
|
|
1653
|
+
"title": "layoutName",
|
|
1654
|
+
"type": "string"
|
|
1655
|
+
}
|
|
1656
|
+
},
|
|
1657
|
+
{
|
|
1658
|
+
"name": "iapMetadata",
|
|
1659
|
+
"type": "object",
|
|
1660
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1661
|
+
"required": false,
|
|
1662
|
+
"schema": {
|
|
1663
|
+
"title": "iapMetadata",
|
|
1664
|
+
"type": "object"
|
|
1665
|
+
}
|
|
1666
|
+
}
|
|
1667
|
+
],
|
|
1668
|
+
"output": {
|
|
1669
|
+
"name": "result",
|
|
1670
|
+
"type": "object",
|
|
1671
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1672
|
+
"schema": {
|
|
1673
|
+
"title": "result",
|
|
1674
|
+
"type": "object"
|
|
1675
|
+
}
|
|
1676
|
+
},
|
|
1677
|
+
"roles": [
|
|
1678
|
+
"admin"
|
|
1679
|
+
],
|
|
1680
|
+
"route": {
|
|
1681
|
+
"verb": "POST",
|
|
1682
|
+
"path": "/sObjectNamedLayouts"
|
|
1683
|
+
},
|
|
1684
|
+
"task": true
|
|
1685
|
+
},
|
|
1686
|
+
{
|
|
1687
|
+
"name": "sObjectRows",
|
|
1688
|
+
"summary": "SObject Rows",
|
|
1689
|
+
"description": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.",
|
|
1690
|
+
"input": [
|
|
1691
|
+
{
|
|
1692
|
+
"name": "sobjectName",
|
|
1693
|
+
"type": "string",
|
|
1694
|
+
"info": ": string",
|
|
1695
|
+
"required": true,
|
|
1696
|
+
"schema": {
|
|
1697
|
+
"title": "sobjectName",
|
|
1698
|
+
"type": "string"
|
|
1699
|
+
}
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
"name": "recordId",
|
|
1703
|
+
"type": "string",
|
|
1704
|
+
"info": ": string",
|
|
1705
|
+
"required": true,
|
|
1706
|
+
"schema": {
|
|
1707
|
+
"title": "recordId",
|
|
1708
|
+
"type": "string"
|
|
1709
|
+
}
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"name": "iapMetadata",
|
|
1713
|
+
"type": "object",
|
|
1714
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1715
|
+
"required": false,
|
|
1716
|
+
"schema": {
|
|
1717
|
+
"title": "iapMetadata",
|
|
1718
|
+
"type": "object"
|
|
1719
|
+
}
|
|
1720
|
+
}
|
|
1721
|
+
],
|
|
1722
|
+
"output": {
|
|
1723
|
+
"name": "result",
|
|
1724
|
+
"type": "object",
|
|
1725
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1726
|
+
"schema": {
|
|
1727
|
+
"title": "result",
|
|
1728
|
+
"type": "object"
|
|
1729
|
+
}
|
|
1730
|
+
},
|
|
1731
|
+
"roles": [
|
|
1732
|
+
"admin"
|
|
1733
|
+
],
|
|
1734
|
+
"route": {
|
|
1735
|
+
"verb": "POST",
|
|
1736
|
+
"path": "/sObjectRows"
|
|
1737
|
+
},
|
|
1738
|
+
"task": true
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"name": "sObjectRowsUpdate",
|
|
1742
|
+
"summary": "SObject Rows Update",
|
|
1743
|
+
"description": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.",
|
|
1744
|
+
"input": [
|
|
1745
|
+
{
|
|
1746
|
+
"name": "sobjectName",
|
|
1747
|
+
"type": "string",
|
|
1748
|
+
"info": ": string",
|
|
1749
|
+
"required": true,
|
|
1750
|
+
"schema": {
|
|
1751
|
+
"title": "sobjectName",
|
|
1752
|
+
"type": "string"
|
|
1753
|
+
}
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"name": "recordId",
|
|
1757
|
+
"type": "string",
|
|
1758
|
+
"info": ": string",
|
|
1759
|
+
"required": true,
|
|
1760
|
+
"schema": {
|
|
1761
|
+
"title": "recordId",
|
|
1762
|
+
"type": "string"
|
|
1763
|
+
}
|
|
1764
|
+
},
|
|
1765
|
+
{
|
|
1766
|
+
"name": "body",
|
|
1767
|
+
"type": "object",
|
|
1768
|
+
"info": ": object",
|
|
1769
|
+
"required": true,
|
|
1770
|
+
"schema": {
|
|
1771
|
+
"allOf": [
|
|
1772
|
+
{
|
|
1773
|
+
"type": "object"
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
"type": "object"
|
|
1777
|
+
}
|
|
1778
|
+
],
|
|
1779
|
+
"definitions": {}
|
|
1780
|
+
}
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"name": "iapMetadata",
|
|
1784
|
+
"type": "object",
|
|
1785
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1786
|
+
"required": false,
|
|
1787
|
+
"schema": {
|
|
1788
|
+
"title": "iapMetadata",
|
|
1789
|
+
"type": "object"
|
|
1790
|
+
}
|
|
1791
|
+
}
|
|
1792
|
+
],
|
|
1793
|
+
"output": {
|
|
1794
|
+
"name": "result",
|
|
1795
|
+
"type": "object",
|
|
1796
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1797
|
+
"schema": {
|
|
1798
|
+
"title": "result",
|
|
1799
|
+
"type": "object"
|
|
1800
|
+
}
|
|
1801
|
+
},
|
|
1802
|
+
"roles": [
|
|
1803
|
+
"admin"
|
|
1804
|
+
],
|
|
1805
|
+
"route": {
|
|
1806
|
+
"verb": "POST",
|
|
1807
|
+
"path": "/sObjectRowsUpdate"
|
|
1808
|
+
},
|
|
1809
|
+
"task": true
|
|
1810
|
+
},
|
|
1811
|
+
{
|
|
1812
|
+
"name": "sObjectRowsDelete",
|
|
1813
|
+
"summary": "SObject Rows Delete",
|
|
1814
|
+
"description": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.",
|
|
1815
|
+
"input": [
|
|
1816
|
+
{
|
|
1817
|
+
"name": "sobjectName",
|
|
1818
|
+
"type": "string",
|
|
1819
|
+
"info": ": string",
|
|
1820
|
+
"required": true,
|
|
1821
|
+
"schema": {
|
|
1822
|
+
"title": "sobjectName",
|
|
1823
|
+
"type": "string"
|
|
1824
|
+
}
|
|
1825
|
+
},
|
|
1826
|
+
{
|
|
1827
|
+
"name": "recordId",
|
|
1828
|
+
"type": "string",
|
|
1829
|
+
"info": ": string",
|
|
1830
|
+
"required": true,
|
|
1831
|
+
"schema": {
|
|
1832
|
+
"title": "recordId",
|
|
1833
|
+
"type": "string"
|
|
1834
|
+
}
|
|
1835
|
+
},
|
|
1836
|
+
{
|
|
1837
|
+
"name": "iapMetadata",
|
|
1838
|
+
"type": "object",
|
|
1839
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1840
|
+
"required": false,
|
|
1841
|
+
"schema": {
|
|
1842
|
+
"title": "iapMetadata",
|
|
1843
|
+
"type": "object"
|
|
1844
|
+
}
|
|
1845
|
+
}
|
|
1846
|
+
],
|
|
1847
|
+
"output": {
|
|
1848
|
+
"name": "result",
|
|
1849
|
+
"type": "object",
|
|
1850
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1851
|
+
"schema": {
|
|
1852
|
+
"title": "result",
|
|
1853
|
+
"type": "object"
|
|
1854
|
+
}
|
|
1855
|
+
},
|
|
1856
|
+
"roles": [
|
|
1857
|
+
"admin"
|
|
1858
|
+
],
|
|
1859
|
+
"route": {
|
|
1860
|
+
"verb": "POST",
|
|
1861
|
+
"path": "/sObjectRowsDelete"
|
|
1862
|
+
},
|
|
1863
|
+
"task": true
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "sObjectRowsbyExternalID",
|
|
1867
|
+
"summary": "SObject Rows by External ID",
|
|
1868
|
+
"description": "Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.\n\nIf the specified value doesn't exist, a new record is created.\nIf a record does exist with that value, the field values specified in the request body are updated.\nIf the value is not unique, the REST API returns a 300 response with the list of matching records.\n\nHEAD, GET, PATCH, DELETE, POST",
|
|
1869
|
+
"input": [
|
|
1870
|
+
{
|
|
1871
|
+
"name": "sobjectName",
|
|
1872
|
+
"type": "string",
|
|
1873
|
+
"info": ": string",
|
|
1874
|
+
"required": true,
|
|
1875
|
+
"schema": {
|
|
1876
|
+
"title": "sobjectName",
|
|
1877
|
+
"type": "string"
|
|
1878
|
+
}
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
"name": "fieldName",
|
|
1882
|
+
"type": "string",
|
|
1883
|
+
"info": ": string",
|
|
1884
|
+
"required": true,
|
|
1885
|
+
"schema": {
|
|
1886
|
+
"title": "fieldName",
|
|
1887
|
+
"type": "string"
|
|
1888
|
+
}
|
|
1889
|
+
},
|
|
1890
|
+
{
|
|
1891
|
+
"name": "fieldValue",
|
|
1892
|
+
"type": "string",
|
|
1893
|
+
"info": ": string",
|
|
1894
|
+
"required": true,
|
|
1895
|
+
"schema": {
|
|
1896
|
+
"title": "fieldValue",
|
|
1897
|
+
"type": "string"
|
|
1898
|
+
}
|
|
1899
|
+
},
|
|
1900
|
+
{
|
|
1901
|
+
"name": "iapMetadata",
|
|
1902
|
+
"type": "object",
|
|
1903
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1904
|
+
"required": false,
|
|
1905
|
+
"schema": {
|
|
1906
|
+
"title": "iapMetadata",
|
|
1907
|
+
"type": "object"
|
|
1908
|
+
}
|
|
1909
|
+
}
|
|
1910
|
+
],
|
|
1911
|
+
"output": {
|
|
1912
|
+
"name": "result",
|
|
1913
|
+
"type": "object",
|
|
1914
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1915
|
+
"schema": {
|
|
1916
|
+
"title": "result",
|
|
1917
|
+
"type": "object"
|
|
1918
|
+
}
|
|
1919
|
+
},
|
|
1920
|
+
"roles": [
|
|
1921
|
+
"admin"
|
|
1922
|
+
],
|
|
1923
|
+
"route": {
|
|
1924
|
+
"verb": "POST",
|
|
1925
|
+
"path": "/sObjectRowsbyExternalID"
|
|
1926
|
+
},
|
|
1927
|
+
"task": true
|
|
1928
|
+
},
|
|
1929
|
+
{
|
|
1930
|
+
"name": "sObjectBlobRetrieve",
|
|
1931
|
+
"summary": "SObject Blob Retrieve",
|
|
1932
|
+
"description": "Retrieves the specified blob field from an individual record.",
|
|
1933
|
+
"input": [
|
|
1934
|
+
{
|
|
1935
|
+
"name": "sobjectName",
|
|
1936
|
+
"type": "string",
|
|
1937
|
+
"info": ": string",
|
|
1938
|
+
"required": true,
|
|
1939
|
+
"schema": {
|
|
1940
|
+
"title": "sobjectName",
|
|
1941
|
+
"type": "string"
|
|
1942
|
+
}
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"name": "recordId",
|
|
1946
|
+
"type": "string",
|
|
1947
|
+
"info": ": string",
|
|
1948
|
+
"required": true,
|
|
1949
|
+
"schema": {
|
|
1950
|
+
"title": "recordId",
|
|
1951
|
+
"type": "string"
|
|
1952
|
+
}
|
|
1953
|
+
},
|
|
1954
|
+
{
|
|
1955
|
+
"name": "blobField",
|
|
1956
|
+
"type": "string",
|
|
1957
|
+
"info": ": string",
|
|
1958
|
+
"required": true,
|
|
1959
|
+
"schema": {
|
|
1960
|
+
"title": "blobField",
|
|
1961
|
+
"type": "string"
|
|
1962
|
+
}
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"name": "iapMetadata",
|
|
1966
|
+
"type": "object",
|
|
1967
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1968
|
+
"required": false,
|
|
1969
|
+
"schema": {
|
|
1970
|
+
"title": "iapMetadata",
|
|
1971
|
+
"type": "object"
|
|
1972
|
+
}
|
|
1973
|
+
}
|
|
1974
|
+
],
|
|
1975
|
+
"output": {
|
|
1976
|
+
"name": "result",
|
|
1977
|
+
"type": "object",
|
|
1978
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1979
|
+
"schema": {
|
|
1980
|
+
"title": "result",
|
|
1981
|
+
"type": "object"
|
|
1982
|
+
}
|
|
1983
|
+
},
|
|
1984
|
+
"roles": [
|
|
1985
|
+
"admin"
|
|
1986
|
+
],
|
|
1987
|
+
"route": {
|
|
1988
|
+
"verb": "POST",
|
|
1989
|
+
"path": "/sObjectBlobRetrieve"
|
|
1990
|
+
},
|
|
1991
|
+
"task": true
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"name": "sObjectApprovalLayouts",
|
|
1995
|
+
"summary": "SObject ApprovalLayouts",
|
|
1996
|
+
"description": "Returns a list of approval layouts for a specified object. Specify a particular approval process name to limit the return value to one specific approval layout. This resource is available in REST API version 30.0 and later.\n\napprovalProcessName parameter is optional",
|
|
1997
|
+
"input": [
|
|
1998
|
+
{
|
|
1999
|
+
"name": "sobjectName",
|
|
2000
|
+
"type": "string",
|
|
2001
|
+
"info": ": string",
|
|
2002
|
+
"required": true,
|
|
2003
|
+
"schema": {
|
|
2004
|
+
"title": "sobjectName",
|
|
2005
|
+
"type": "string"
|
|
2006
|
+
}
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"name": "approvalProcessName",
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"info": ": string",
|
|
2012
|
+
"required": true,
|
|
2013
|
+
"schema": {
|
|
2014
|
+
"title": "approvalProcessName",
|
|
2015
|
+
"type": "string"
|
|
2016
|
+
}
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
"name": "iapMetadata",
|
|
2020
|
+
"type": "object",
|
|
2021
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2022
|
+
"required": false,
|
|
2023
|
+
"schema": {
|
|
2024
|
+
"title": "iapMetadata",
|
|
2025
|
+
"type": "object"
|
|
2026
|
+
}
|
|
2027
|
+
}
|
|
2028
|
+
],
|
|
2029
|
+
"output": {
|
|
2030
|
+
"name": "result",
|
|
2031
|
+
"type": "object",
|
|
2032
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2033
|
+
"schema": {
|
|
2034
|
+
"title": "result",
|
|
2035
|
+
"type": "object"
|
|
2036
|
+
}
|
|
2037
|
+
},
|
|
2038
|
+
"roles": [
|
|
2039
|
+
"admin"
|
|
2040
|
+
],
|
|
2041
|
+
"route": {
|
|
2042
|
+
"verb": "POST",
|
|
2043
|
+
"path": "/sObjectApprovalLayouts"
|
|
2044
|
+
},
|
|
2045
|
+
"task": true
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "sObjectCompactLayouts",
|
|
2049
|
+
"summary": "SObject CompactLayouts",
|
|
2050
|
+
"description": "Returns a list of compact layouts for a specific object. This resource is available in REST API version 29.0 and later.",
|
|
2051
|
+
"input": [
|
|
2052
|
+
{
|
|
2053
|
+
"name": "sobjectName",
|
|
2054
|
+
"type": "string",
|
|
2055
|
+
"info": ": string",
|
|
2056
|
+
"required": true,
|
|
2057
|
+
"schema": {
|
|
2058
|
+
"title": "sobjectName",
|
|
2059
|
+
"type": "string"
|
|
2060
|
+
}
|
|
2061
|
+
},
|
|
2062
|
+
{
|
|
2063
|
+
"name": "iapMetadata",
|
|
2064
|
+
"type": "object",
|
|
2065
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2066
|
+
"required": false,
|
|
2067
|
+
"schema": {
|
|
2068
|
+
"title": "iapMetadata",
|
|
2069
|
+
"type": "object"
|
|
2070
|
+
}
|
|
2071
|
+
}
|
|
2072
|
+
],
|
|
2073
|
+
"output": {
|
|
2074
|
+
"name": "result",
|
|
2075
|
+
"type": "object",
|
|
2076
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2077
|
+
"schema": {
|
|
2078
|
+
"title": "result",
|
|
2079
|
+
"type": "object"
|
|
2080
|
+
}
|
|
2081
|
+
},
|
|
2082
|
+
"roles": [
|
|
2083
|
+
"admin"
|
|
2084
|
+
],
|
|
2085
|
+
"route": {
|
|
2086
|
+
"verb": "POST",
|
|
2087
|
+
"path": "/sObjectCompactLayouts"
|
|
2088
|
+
},
|
|
2089
|
+
"task": true
|
|
2090
|
+
},
|
|
2091
|
+
{
|
|
2092
|
+
"name": "describeGlobalLayouts",
|
|
2093
|
+
"summary": "Describe Global Layouts",
|
|
2094
|
+
"description": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned.",
|
|
2095
|
+
"input": [
|
|
2096
|
+
{
|
|
2097
|
+
"name": "iapMetadata",
|
|
2098
|
+
"type": "object",
|
|
2099
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2100
|
+
"required": false,
|
|
2101
|
+
"schema": {
|
|
2102
|
+
"title": "iapMetadata",
|
|
2103
|
+
"type": "object"
|
|
2104
|
+
}
|
|
2105
|
+
}
|
|
2106
|
+
],
|
|
2107
|
+
"output": {
|
|
2108
|
+
"name": "result",
|
|
2109
|
+
"type": "object",
|
|
2110
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2111
|
+
"schema": {
|
|
2112
|
+
"title": "result",
|
|
2113
|
+
"type": "object"
|
|
2114
|
+
}
|
|
2115
|
+
},
|
|
2116
|
+
"roles": [
|
|
2117
|
+
"admin"
|
|
2118
|
+
],
|
|
2119
|
+
"route": {
|
|
2120
|
+
"verb": "GET",
|
|
2121
|
+
"path": "/describeGlobalLayouts"
|
|
2122
|
+
},
|
|
2123
|
+
"task": true
|
|
2124
|
+
},
|
|
2125
|
+
{
|
|
2126
|
+
"name": "describeSObjectLayouts",
|
|
2127
|
+
"summary": "Describe SObject Layouts",
|
|
2128
|
+
"description": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned.",
|
|
2129
|
+
"input": [
|
|
2130
|
+
{
|
|
2131
|
+
"name": "sobjectName",
|
|
2132
|
+
"type": "string",
|
|
2133
|
+
"info": ": string",
|
|
2134
|
+
"required": true,
|
|
2135
|
+
"schema": {
|
|
2136
|
+
"title": "sobjectName",
|
|
2137
|
+
"type": "string"
|
|
2138
|
+
}
|
|
2139
|
+
},
|
|
2140
|
+
{
|
|
2141
|
+
"name": "iapMetadata",
|
|
2142
|
+
"type": "object",
|
|
2143
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2144
|
+
"required": false,
|
|
2145
|
+
"schema": {
|
|
2146
|
+
"title": "iapMetadata",
|
|
2147
|
+
"type": "object"
|
|
2148
|
+
}
|
|
2149
|
+
}
|
|
2150
|
+
],
|
|
2151
|
+
"output": {
|
|
2152
|
+
"name": "result",
|
|
2153
|
+
"type": "object",
|
|
2154
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2155
|
+
"schema": {
|
|
2156
|
+
"title": "result",
|
|
2157
|
+
"type": "object"
|
|
2158
|
+
}
|
|
2159
|
+
},
|
|
2160
|
+
"roles": [
|
|
2161
|
+
"admin"
|
|
2162
|
+
],
|
|
2163
|
+
"route": {
|
|
2164
|
+
"verb": "POST",
|
|
2165
|
+
"path": "/describeSObjectLayouts"
|
|
2166
|
+
},
|
|
2167
|
+
"task": true
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
"name": "describeSObjectLayoutsPerRecordType",
|
|
2171
|
+
"summary": "Describe SObject Layouts Per Record Type",
|
|
2172
|
+
"description": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned.",
|
|
2173
|
+
"input": [
|
|
2174
|
+
{
|
|
2175
|
+
"name": "sobjectName",
|
|
2176
|
+
"type": "string",
|
|
2177
|
+
"info": ": string",
|
|
2178
|
+
"required": true,
|
|
2179
|
+
"schema": {
|
|
2180
|
+
"title": "sobjectName",
|
|
2181
|
+
"type": "string"
|
|
2182
|
+
}
|
|
2183
|
+
},
|
|
2184
|
+
{
|
|
2185
|
+
"name": "recordTypeId",
|
|
2186
|
+
"type": "string",
|
|
2187
|
+
"info": ": string",
|
|
2188
|
+
"required": true,
|
|
2189
|
+
"schema": {
|
|
2190
|
+
"title": "recordTypeId",
|
|
2191
|
+
"type": "string"
|
|
2192
|
+
}
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"name": "iapMetadata",
|
|
2196
|
+
"type": "object",
|
|
2197
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2198
|
+
"required": false,
|
|
2199
|
+
"schema": {
|
|
2200
|
+
"title": "iapMetadata",
|
|
2201
|
+
"type": "object"
|
|
2202
|
+
}
|
|
2203
|
+
}
|
|
2204
|
+
],
|
|
2205
|
+
"output": {
|
|
2206
|
+
"name": "result",
|
|
2207
|
+
"type": "object",
|
|
2208
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2209
|
+
"schema": {
|
|
2210
|
+
"title": "result",
|
|
2211
|
+
"type": "object"
|
|
2212
|
+
}
|
|
2213
|
+
},
|
|
2214
|
+
"roles": [
|
|
2215
|
+
"admin"
|
|
2216
|
+
],
|
|
2217
|
+
"route": {
|
|
2218
|
+
"verb": "POST",
|
|
2219
|
+
"path": "/describeSObjectLayoutsPerRecordType"
|
|
2220
|
+
},
|
|
2221
|
+
"task": true
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
"name": "sObjectPlatformAction",
|
|
2225
|
+
"summary": "SObject PlatformAction",
|
|
2226
|
+
"description": "PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.\nReturns the description of the PlatformAction.",
|
|
2227
|
+
"input": [
|
|
2228
|
+
{
|
|
2229
|
+
"name": "iapMetadata",
|
|
2230
|
+
"type": "object",
|
|
2231
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2232
|
+
"required": false,
|
|
2233
|
+
"schema": {
|
|
2234
|
+
"title": "iapMetadata",
|
|
2235
|
+
"type": "object"
|
|
2236
|
+
}
|
|
2237
|
+
}
|
|
2238
|
+
],
|
|
2239
|
+
"output": {
|
|
2240
|
+
"name": "result",
|
|
2241
|
+
"type": "object",
|
|
2242
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2243
|
+
"schema": {
|
|
2244
|
+
"title": "result",
|
|
2245
|
+
"type": "object"
|
|
2246
|
+
}
|
|
2247
|
+
},
|
|
2248
|
+
"roles": [
|
|
2249
|
+
"admin"
|
|
2250
|
+
],
|
|
2251
|
+
"route": {
|
|
2252
|
+
"verb": "GET",
|
|
2253
|
+
"path": "/sObjectPlatformAction"
|
|
2254
|
+
},
|
|
2255
|
+
"task": true
|
|
2256
|
+
},
|
|
2257
|
+
{
|
|
2258
|
+
"name": "sObjectQuickActions",
|
|
2259
|
+
"summary": "SObject Quick Actions",
|
|
2260
|
+
"description": "Returns a list of actions and their details. This resource is available in REST API version 28.0 and later. When working with actions, also refer to Quick Actions.\n\nTo return a specific object’s actions as well as global actions, use: /vXX.X/sobjects/object/quickActions/\nTo return a specific action, use /vXX.X/sobjects/object/quickActions/{action name}\nTo return a specific action’s descriptive detail, use /vXX.X/sobjects/object/quickActions/{action name}/describe/\nTo return a specific action’s d...(description truncated)",
|
|
2261
|
+
"input": [
|
|
2262
|
+
{
|
|
2263
|
+
"name": "sobjectName",
|
|
2264
|
+
"type": "string",
|
|
2265
|
+
"info": ": string",
|
|
2266
|
+
"required": true,
|
|
2267
|
+
"schema": {
|
|
2268
|
+
"title": "sobjectName",
|
|
2269
|
+
"type": "string"
|
|
2270
|
+
}
|
|
2271
|
+
},
|
|
2272
|
+
{
|
|
2273
|
+
"name": "iapMetadata",
|
|
2274
|
+
"type": "object",
|
|
2275
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2276
|
+
"required": false,
|
|
2277
|
+
"schema": {
|
|
2278
|
+
"title": "iapMetadata",
|
|
2279
|
+
"type": "object"
|
|
2280
|
+
}
|
|
2281
|
+
}
|
|
2282
|
+
],
|
|
2283
|
+
"output": {
|
|
2284
|
+
"name": "result",
|
|
2285
|
+
"type": "object",
|
|
2286
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2287
|
+
"schema": {
|
|
2288
|
+
"title": "result",
|
|
2289
|
+
"type": "object"
|
|
2290
|
+
}
|
|
2291
|
+
},
|
|
2292
|
+
"roles": [
|
|
2293
|
+
"admin"
|
|
2294
|
+
],
|
|
2295
|
+
"route": {
|
|
2296
|
+
"verb": "POST",
|
|
2297
|
+
"path": "/sObjectQuickActions"
|
|
2298
|
+
},
|
|
2299
|
+
"task": true
|
|
2300
|
+
},
|
|
2301
|
+
{
|
|
2302
|
+
"name": "sObjectRichTextImageRetrieve",
|
|
2303
|
+
"summary": "SObject Rich Text Image Retrieve",
|
|
2304
|
+
"description": "Retrieves the specified image data from a specific rich text area field in a given record.\ncontentReferenceId\tThe reference ID that uniquely identifies an image within a rich text area field.\nYou can obtain the reference by retrieving information for the object. The description will show the contents of the rich text area field",
|
|
2305
|
+
"input": [
|
|
2306
|
+
{
|
|
2307
|
+
"name": "sobjectName",
|
|
2308
|
+
"type": "string",
|
|
2309
|
+
"info": ": string",
|
|
2310
|
+
"required": true,
|
|
2311
|
+
"schema": {
|
|
2312
|
+
"title": "sobjectName",
|
|
2313
|
+
"type": "string"
|
|
2314
|
+
}
|
|
2315
|
+
},
|
|
2316
|
+
{
|
|
2317
|
+
"name": "recordId",
|
|
2318
|
+
"type": "string",
|
|
2319
|
+
"info": ": string",
|
|
2320
|
+
"required": true,
|
|
2321
|
+
"schema": {
|
|
2322
|
+
"title": "recordId",
|
|
2323
|
+
"type": "string"
|
|
2324
|
+
}
|
|
2325
|
+
},
|
|
2326
|
+
{
|
|
2327
|
+
"name": "fieldName",
|
|
2328
|
+
"type": "string",
|
|
2329
|
+
"info": ": string",
|
|
2330
|
+
"required": true,
|
|
2331
|
+
"schema": {
|
|
2332
|
+
"title": "fieldName",
|
|
2333
|
+
"type": "string"
|
|
2334
|
+
}
|
|
2335
|
+
},
|
|
2336
|
+
{
|
|
2337
|
+
"name": "contentReferenceId",
|
|
2338
|
+
"type": "string",
|
|
2339
|
+
"info": ": string",
|
|
2340
|
+
"required": true,
|
|
2341
|
+
"schema": {
|
|
2342
|
+
"title": "contentReferenceId",
|
|
2343
|
+
"type": "string"
|
|
2344
|
+
}
|
|
2345
|
+
},
|
|
2346
|
+
{
|
|
2347
|
+
"name": "iapMetadata",
|
|
2348
|
+
"type": "object",
|
|
2349
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2350
|
+
"required": false,
|
|
2351
|
+
"schema": {
|
|
2352
|
+
"title": "iapMetadata",
|
|
2353
|
+
"type": "object"
|
|
2354
|
+
}
|
|
2355
|
+
}
|
|
2356
|
+
],
|
|
2357
|
+
"output": {
|
|
2358
|
+
"name": "result",
|
|
2359
|
+
"type": "object",
|
|
2360
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2361
|
+
"schema": {
|
|
2362
|
+
"title": "result",
|
|
2363
|
+
"type": "object"
|
|
2364
|
+
}
|
|
2365
|
+
},
|
|
2366
|
+
"roles": [
|
|
2367
|
+
"admin"
|
|
2368
|
+
],
|
|
2369
|
+
"route": {
|
|
2370
|
+
"verb": "POST",
|
|
2371
|
+
"path": "/sObjectRichTextImageRetrieve"
|
|
2372
|
+
},
|
|
2373
|
+
"task": true
|
|
2374
|
+
},
|
|
2375
|
+
{
|
|
2376
|
+
"name": "sObjectRelationships",
|
|
2377
|
+
"summary": "SObject Relationships",
|
|
2378
|
+
"description": "Accesses records by traversing object relationships via friendly URLs. You can retrieve, update, or delete the record associated with the traversed relationship field. If there are multiple related records, you can retrieve the complete set of associated records. This resource is available in REST API version 36.0 and later.\n\nGET, PATCH, DELETE",
|
|
2379
|
+
"input": [
|
|
2380
|
+
{
|
|
2381
|
+
"name": "sobjectName",
|
|
2382
|
+
"type": "string",
|
|
2383
|
+
"info": ": string",
|
|
2384
|
+
"required": true,
|
|
2385
|
+
"schema": {
|
|
2386
|
+
"title": "sobjectName",
|
|
2387
|
+
"type": "string"
|
|
2388
|
+
}
|
|
2389
|
+
},
|
|
2390
|
+
{
|
|
2391
|
+
"name": "recordId",
|
|
2392
|
+
"type": "string",
|
|
2393
|
+
"info": ": string",
|
|
2394
|
+
"required": true,
|
|
2395
|
+
"schema": {
|
|
2396
|
+
"title": "recordId",
|
|
2397
|
+
"type": "string"
|
|
2398
|
+
}
|
|
2399
|
+
},
|
|
2400
|
+
{
|
|
2401
|
+
"name": "relationshipFieldName",
|
|
2402
|
+
"type": "string",
|
|
2403
|
+
"info": ": string",
|
|
2404
|
+
"required": true,
|
|
2405
|
+
"schema": {
|
|
2406
|
+
"title": "relationshipFieldName",
|
|
2407
|
+
"type": "string"
|
|
2408
|
+
}
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
"name": "iapMetadata",
|
|
2412
|
+
"type": "object",
|
|
2413
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2414
|
+
"required": false,
|
|
2415
|
+
"schema": {
|
|
2416
|
+
"title": "iapMetadata",
|
|
2417
|
+
"type": "object"
|
|
2418
|
+
}
|
|
2419
|
+
}
|
|
2420
|
+
],
|
|
2421
|
+
"output": {
|
|
2422
|
+
"name": "result",
|
|
2423
|
+
"type": "object",
|
|
2424
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2425
|
+
"schema": {
|
|
2426
|
+
"title": "result",
|
|
2427
|
+
"type": "object"
|
|
2428
|
+
}
|
|
2429
|
+
},
|
|
2430
|
+
"roles": [
|
|
2431
|
+
"admin"
|
|
2432
|
+
],
|
|
2433
|
+
"route": {
|
|
2434
|
+
"verb": "POST",
|
|
2435
|
+
"path": "/sObjectRelationships"
|
|
2436
|
+
},
|
|
2437
|
+
"task": true
|
|
2438
|
+
},
|
|
2439
|
+
{
|
|
2440
|
+
"name": "sObjectSuggestedArticles",
|
|
2441
|
+
"summary": "SObject Suggested Articles",
|
|
2442
|
+
"description": "Returns a list of suggested Salesforce Knowledge articles for a case, work order, or work order line item.",
|
|
2443
|
+
"input": [
|
|
2444
|
+
{
|
|
2445
|
+
"name": "description",
|
|
2446
|
+
"type": "string",
|
|
2447
|
+
"info": ": string",
|
|
2448
|
+
"required": true,
|
|
2449
|
+
"schema": {
|
|
2450
|
+
"title": "description",
|
|
2451
|
+
"type": "string"
|
|
2452
|
+
}
|
|
2453
|
+
},
|
|
2454
|
+
{
|
|
2455
|
+
"name": "language",
|
|
2456
|
+
"type": "string",
|
|
2457
|
+
"info": ": string",
|
|
2458
|
+
"required": true,
|
|
2459
|
+
"schema": {
|
|
2460
|
+
"title": "language",
|
|
2461
|
+
"type": "string"
|
|
2462
|
+
}
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
"name": "subject",
|
|
2466
|
+
"type": "string",
|
|
2467
|
+
"info": ": string",
|
|
2468
|
+
"required": true,
|
|
2469
|
+
"schema": {
|
|
2470
|
+
"title": "subject",
|
|
2471
|
+
"type": "string"
|
|
2472
|
+
}
|
|
2473
|
+
},
|
|
2474
|
+
{
|
|
2475
|
+
"name": "sobjectName",
|
|
2476
|
+
"type": "string",
|
|
2477
|
+
"info": ": string",
|
|
2478
|
+
"required": true,
|
|
2479
|
+
"schema": {
|
|
2480
|
+
"title": "sobjectName",
|
|
2481
|
+
"type": "string"
|
|
2482
|
+
}
|
|
2483
|
+
},
|
|
2484
|
+
{
|
|
2485
|
+
"name": "iapMetadata",
|
|
2486
|
+
"type": "object",
|
|
2487
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2488
|
+
"required": false,
|
|
2489
|
+
"schema": {
|
|
2490
|
+
"title": "iapMetadata",
|
|
2491
|
+
"type": "object"
|
|
2492
|
+
}
|
|
2493
|
+
}
|
|
2494
|
+
],
|
|
2495
|
+
"output": {
|
|
2496
|
+
"name": "result",
|
|
2497
|
+
"type": "object",
|
|
2498
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2499
|
+
"schema": {
|
|
2500
|
+
"title": "result",
|
|
2501
|
+
"type": "object"
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
"roles": [
|
|
2505
|
+
"admin"
|
|
2506
|
+
],
|
|
2507
|
+
"route": {
|
|
2508
|
+
"verb": "POST",
|
|
2509
|
+
"path": "/sObjectSuggestedArticles"
|
|
2510
|
+
},
|
|
2511
|
+
"task": true
|
|
2512
|
+
},
|
|
2513
|
+
{
|
|
2514
|
+
"name": "sObjectUserPassword",
|
|
2515
|
+
"summary": "SObject User Password",
|
|
2516
|
+
"description": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.",
|
|
2517
|
+
"input": [
|
|
2518
|
+
{
|
|
2519
|
+
"name": "userId",
|
|
2520
|
+
"type": "string",
|
|
2521
|
+
"info": ": string",
|
|
2522
|
+
"required": true,
|
|
2523
|
+
"schema": {
|
|
2524
|
+
"title": "userId",
|
|
2525
|
+
"type": "string"
|
|
2526
|
+
}
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
"name": "iapMetadata",
|
|
2530
|
+
"type": "object",
|
|
2531
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2532
|
+
"required": false,
|
|
2533
|
+
"schema": {
|
|
2534
|
+
"title": "iapMetadata",
|
|
2535
|
+
"type": "object"
|
|
2536
|
+
}
|
|
2537
|
+
}
|
|
2538
|
+
],
|
|
2539
|
+
"output": {
|
|
2540
|
+
"name": "result",
|
|
2541
|
+
"type": "object",
|
|
2542
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2543
|
+
"schema": {
|
|
2544
|
+
"title": "result",
|
|
2545
|
+
"type": "object"
|
|
2546
|
+
}
|
|
2547
|
+
},
|
|
2548
|
+
"roles": [
|
|
2549
|
+
"admin"
|
|
2550
|
+
],
|
|
2551
|
+
"route": {
|
|
2552
|
+
"verb": "POST",
|
|
2553
|
+
"path": "/sObjectUserPassword"
|
|
2554
|
+
},
|
|
2555
|
+
"task": true
|
|
2556
|
+
},
|
|
2557
|
+
{
|
|
2558
|
+
"name": "sObjectSelfServiceUserPassword",
|
|
2559
|
+
"summary": "SObject Self Service User Password",
|
|
2560
|
+
"description": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.",
|
|
2561
|
+
"input": [
|
|
2562
|
+
{
|
|
2563
|
+
"name": "userId",
|
|
2564
|
+
"type": "string",
|
|
2565
|
+
"info": ": string",
|
|
2566
|
+
"required": true,
|
|
2567
|
+
"schema": {
|
|
2568
|
+
"title": "userId",
|
|
2569
|
+
"type": "string"
|
|
2570
|
+
}
|
|
2571
|
+
},
|
|
2572
|
+
{
|
|
2573
|
+
"name": "iapMetadata",
|
|
2574
|
+
"type": "object",
|
|
2575
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2576
|
+
"required": false,
|
|
2577
|
+
"schema": {
|
|
2578
|
+
"title": "iapMetadata",
|
|
2579
|
+
"type": "object"
|
|
2580
|
+
}
|
|
2581
|
+
}
|
|
2582
|
+
],
|
|
2583
|
+
"output": {
|
|
2584
|
+
"name": "result",
|
|
2585
|
+
"type": "object",
|
|
2586
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2587
|
+
"schema": {
|
|
2588
|
+
"title": "result",
|
|
2589
|
+
"type": "object"
|
|
2590
|
+
}
|
|
2591
|
+
},
|
|
2592
|
+
"roles": [
|
|
2593
|
+
"admin"
|
|
2594
|
+
],
|
|
2595
|
+
"route": {
|
|
2596
|
+
"verb": "POST",
|
|
2597
|
+
"path": "/sObjectSelfServiceUserPassword"
|
|
2598
|
+
},
|
|
2599
|
+
"task": true
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
"name": "compactLayouts",
|
|
2603
|
+
"summary": "Compact Layouts",
|
|
2604
|
+
"description": "Returns a list of compact layouts for multiple objects. This resource is available in REST API version 31.0 and later.",
|
|
2605
|
+
"input": [
|
|
2606
|
+
{
|
|
2607
|
+
"name": "q",
|
|
2608
|
+
"type": "string",
|
|
2609
|
+
"info": "object list: string",
|
|
2610
|
+
"required": true,
|
|
2611
|
+
"schema": {
|
|
2612
|
+
"title": "q",
|
|
2613
|
+
"type": "string"
|
|
2614
|
+
}
|
|
2615
|
+
},
|
|
2616
|
+
{
|
|
2617
|
+
"name": "iapMetadata",
|
|
2618
|
+
"type": "object",
|
|
2619
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2620
|
+
"required": false,
|
|
2621
|
+
"schema": {
|
|
2622
|
+
"title": "iapMetadata",
|
|
2623
|
+
"type": "object"
|
|
2624
|
+
}
|
|
2625
|
+
}
|
|
2626
|
+
],
|
|
2627
|
+
"output": {
|
|
2628
|
+
"name": "result",
|
|
2629
|
+
"type": "object",
|
|
2630
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2631
|
+
"schema": {
|
|
2632
|
+
"title": "result",
|
|
2633
|
+
"type": "object"
|
|
2634
|
+
}
|
|
2635
|
+
},
|
|
2636
|
+
"roles": [
|
|
2637
|
+
"admin"
|
|
2638
|
+
],
|
|
2639
|
+
"route": {
|
|
2640
|
+
"verb": "POST",
|
|
2641
|
+
"path": "/compactLayouts"
|
|
2642
|
+
},
|
|
2643
|
+
"task": true
|
|
2644
|
+
},
|
|
2645
|
+
{
|
|
2646
|
+
"name": "lightningToggleMetrics",
|
|
2647
|
+
"summary": "Lightning Toggle Metrics",
|
|
2648
|
+
"description": "Return details about users who switched between Salesforce Classic and Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_togglemetrics.htm",
|
|
2649
|
+
"input": [
|
|
2650
|
+
{
|
|
2651
|
+
"name": "iapMetadata",
|
|
2652
|
+
"type": "object",
|
|
2653
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2654
|
+
"required": false,
|
|
2655
|
+
"schema": {
|
|
2656
|
+
"title": "iapMetadata",
|
|
2657
|
+
"type": "object"
|
|
2658
|
+
}
|
|
2659
|
+
}
|
|
2660
|
+
],
|
|
2661
|
+
"output": {
|
|
2662
|
+
"name": "result",
|
|
2663
|
+
"type": "object",
|
|
2664
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2665
|
+
"schema": {
|
|
2666
|
+
"title": "result",
|
|
2667
|
+
"type": "object"
|
|
2668
|
+
}
|
|
2669
|
+
},
|
|
2670
|
+
"roles": [
|
|
2671
|
+
"admin"
|
|
2672
|
+
],
|
|
2673
|
+
"route": {
|
|
2674
|
+
"verb": "GET",
|
|
2675
|
+
"path": "/lightningToggleMetrics"
|
|
2676
|
+
},
|
|
2677
|
+
"task": true
|
|
2678
|
+
},
|
|
2679
|
+
{
|
|
2680
|
+
"name": "lightningUsagebyPage",
|
|
2681
|
+
"summary": "Lightning Usage by Page",
|
|
2682
|
+
"description": "Represents standard pages users viewed most frequently in Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm",
|
|
2683
|
+
"input": [
|
|
2684
|
+
{
|
|
2685
|
+
"name": "iapMetadata",
|
|
2686
|
+
"type": "object",
|
|
2687
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2688
|
+
"required": false,
|
|
2689
|
+
"schema": {
|
|
2690
|
+
"title": "iapMetadata",
|
|
2691
|
+
"type": "object"
|
|
2692
|
+
}
|
|
2693
|
+
}
|
|
2694
|
+
],
|
|
2695
|
+
"output": {
|
|
2696
|
+
"name": "result",
|
|
2697
|
+
"type": "object",
|
|
2698
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2699
|
+
"schema": {
|
|
2700
|
+
"title": "result",
|
|
2701
|
+
"type": "object"
|
|
2702
|
+
}
|
|
2703
|
+
},
|
|
2704
|
+
"roles": [
|
|
2705
|
+
"admin"
|
|
2706
|
+
],
|
|
2707
|
+
"route": {
|
|
2708
|
+
"verb": "GET",
|
|
2709
|
+
"path": "/lightningUsagebyPage"
|
|
2710
|
+
},
|
|
2711
|
+
"task": true
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
"name": "lightningUsagebyAppType",
|
|
2715
|
+
"summary": "Lightning Usage by App Type",
|
|
2716
|
+
"description": "Return the total number of Lightning Experience and Salesforce Mobile users.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyapptypemetrics.htm",
|
|
2717
|
+
"input": [
|
|
2718
|
+
{
|
|
2719
|
+
"name": "iapMetadata",
|
|
2720
|
+
"type": "object",
|
|
2721
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2722
|
+
"required": false,
|
|
2723
|
+
"schema": {
|
|
2724
|
+
"title": "iapMetadata",
|
|
2725
|
+
"type": "object"
|
|
2726
|
+
}
|
|
2727
|
+
}
|
|
2728
|
+
],
|
|
2729
|
+
"output": {
|
|
2730
|
+
"name": "result",
|
|
2731
|
+
"type": "object",
|
|
2732
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2733
|
+
"schema": {
|
|
2734
|
+
"title": "result",
|
|
2735
|
+
"type": "object"
|
|
2736
|
+
}
|
|
2737
|
+
},
|
|
2738
|
+
"roles": [
|
|
2739
|
+
"admin"
|
|
2740
|
+
],
|
|
2741
|
+
"route": {
|
|
2742
|
+
"verb": "GET",
|
|
2743
|
+
"path": "/lightningUsagebyAppType"
|
|
2744
|
+
},
|
|
2745
|
+
"task": true
|
|
2746
|
+
},
|
|
2747
|
+
{
|
|
2748
|
+
"name": "lightningUsagebyFlexiPage",
|
|
2749
|
+
"summary": "Lightning Usage by FlexiPage",
|
|
2750
|
+
"description": "Return details about the custom pages viewed most frequently in Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyflexipagemetrics.htm",
|
|
2751
|
+
"input": [
|
|
2752
|
+
{
|
|
2753
|
+
"name": "iapMetadata",
|
|
2754
|
+
"type": "object",
|
|
2755
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2756
|
+
"required": false,
|
|
2757
|
+
"schema": {
|
|
2758
|
+
"title": "iapMetadata",
|
|
2759
|
+
"type": "object"
|
|
2760
|
+
}
|
|
2761
|
+
}
|
|
2762
|
+
],
|
|
2763
|
+
"output": {
|
|
2764
|
+
"name": "result",
|
|
2765
|
+
"type": "object",
|
|
2766
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2767
|
+
"schema": {
|
|
2768
|
+
"title": "result",
|
|
2769
|
+
"type": "object"
|
|
2770
|
+
}
|
|
2771
|
+
},
|
|
2772
|
+
"roles": [
|
|
2773
|
+
"admin"
|
|
2774
|
+
],
|
|
2775
|
+
"route": {
|
|
2776
|
+
"verb": "GET",
|
|
2777
|
+
"path": "/lightningUsagebyFlexiPage"
|
|
2778
|
+
},
|
|
2779
|
+
"task": true
|
|
2780
|
+
},
|
|
2781
|
+
{
|
|
2782
|
+
"name": "lightningExitbyPageMetrics",
|
|
2783
|
+
"summary": "Lightning Exit by Page Metrics",
|
|
2784
|
+
"description": "Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm",
|
|
2785
|
+
"input": [
|
|
2786
|
+
{
|
|
2787
|
+
"name": "iapMetadata",
|
|
2788
|
+
"type": "object",
|
|
2789
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2790
|
+
"required": false,
|
|
2791
|
+
"schema": {
|
|
2792
|
+
"title": "iapMetadata",
|
|
2793
|
+
"type": "object"
|
|
2794
|
+
}
|
|
2795
|
+
}
|
|
2796
|
+
],
|
|
2797
|
+
"output": {
|
|
2798
|
+
"name": "result",
|
|
2799
|
+
"type": "object",
|
|
2800
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2801
|
+
"schema": {
|
|
2802
|
+
"title": "result",
|
|
2803
|
+
"type": "object"
|
|
2804
|
+
}
|
|
2805
|
+
},
|
|
2806
|
+
"roles": [
|
|
2807
|
+
"admin"
|
|
2808
|
+
],
|
|
2809
|
+
"route": {
|
|
2810
|
+
"verb": "GET",
|
|
2811
|
+
"path": "/lightningExitbyPageMetrics"
|
|
2812
|
+
},
|
|
2813
|
+
"task": true
|
|
2814
|
+
},
|
|
2815
|
+
{
|
|
2816
|
+
"name": "listViews",
|
|
2817
|
+
"summary": "List Views",
|
|
2818
|
+
"description": "Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.",
|
|
2819
|
+
"input": [
|
|
2820
|
+
{
|
|
2821
|
+
"name": "sobjectName",
|
|
2822
|
+
"type": "string",
|
|
2823
|
+
"info": ": string",
|
|
2824
|
+
"required": true,
|
|
2825
|
+
"schema": {
|
|
2826
|
+
"title": "sobjectName",
|
|
2827
|
+
"type": "string"
|
|
2828
|
+
}
|
|
2829
|
+
},
|
|
2830
|
+
{
|
|
2831
|
+
"name": "iapMetadata",
|
|
2832
|
+
"type": "object",
|
|
2833
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2834
|
+
"required": false,
|
|
2835
|
+
"schema": {
|
|
2836
|
+
"title": "iapMetadata",
|
|
2837
|
+
"type": "object"
|
|
2838
|
+
}
|
|
2839
|
+
}
|
|
2840
|
+
],
|
|
2841
|
+
"output": {
|
|
2842
|
+
"name": "result",
|
|
2843
|
+
"type": "object",
|
|
2844
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2845
|
+
"schema": {
|
|
2846
|
+
"title": "result",
|
|
2847
|
+
"type": "object"
|
|
2848
|
+
}
|
|
2849
|
+
},
|
|
2850
|
+
"roles": [
|
|
2851
|
+
"admin"
|
|
2852
|
+
],
|
|
2853
|
+
"route": {
|
|
2854
|
+
"verb": "POST",
|
|
2855
|
+
"path": "/listViews"
|
|
2856
|
+
},
|
|
2857
|
+
"task": true
|
|
2858
|
+
},
|
|
2859
|
+
{
|
|
2860
|
+
"name": "listViewDescribe",
|
|
2861
|
+
"summary": "List View Describe",
|
|
2862
|
+
"description": "Returns detailed information about a list view, including the ID, the columns, and the SOQL query.",
|
|
2863
|
+
"input": [
|
|
2864
|
+
{
|
|
2865
|
+
"name": "sobjectName",
|
|
2866
|
+
"type": "string",
|
|
2867
|
+
"info": ": string",
|
|
2868
|
+
"required": true,
|
|
2869
|
+
"schema": {
|
|
2870
|
+
"title": "sobjectName",
|
|
2871
|
+
"type": "string"
|
|
2872
|
+
}
|
|
2873
|
+
},
|
|
2874
|
+
{
|
|
2875
|
+
"name": "queryLocator",
|
|
2876
|
+
"type": "string",
|
|
2877
|
+
"info": ": string",
|
|
2878
|
+
"required": true,
|
|
2879
|
+
"schema": {
|
|
2880
|
+
"title": "queryLocator",
|
|
2881
|
+
"type": "string"
|
|
2882
|
+
}
|
|
2883
|
+
},
|
|
2884
|
+
{
|
|
2885
|
+
"name": "iapMetadata",
|
|
2886
|
+
"type": "object",
|
|
2887
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2888
|
+
"required": false,
|
|
2889
|
+
"schema": {
|
|
2890
|
+
"title": "iapMetadata",
|
|
2891
|
+
"type": "object"
|
|
2892
|
+
}
|
|
2893
|
+
}
|
|
2894
|
+
],
|
|
2895
|
+
"output": {
|
|
2896
|
+
"name": "result",
|
|
2897
|
+
"type": "object",
|
|
2898
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2899
|
+
"schema": {
|
|
2900
|
+
"title": "result",
|
|
2901
|
+
"type": "object"
|
|
2902
|
+
}
|
|
2903
|
+
},
|
|
2904
|
+
"roles": [
|
|
2905
|
+
"admin"
|
|
2906
|
+
],
|
|
2907
|
+
"route": {
|
|
2908
|
+
"verb": "POST",
|
|
2909
|
+
"path": "/listViewDescribe"
|
|
2910
|
+
},
|
|
2911
|
+
"task": true
|
|
2912
|
+
},
|
|
2913
|
+
{
|
|
2914
|
+
"name": "listViewResults",
|
|
2915
|
+
"summary": "List View Results",
|
|
2916
|
+
"description": "Returns detailed information about a list view, including the ID, the columns, and the SOQL query.",
|
|
2917
|
+
"input": [
|
|
2918
|
+
{
|
|
2919
|
+
"name": "sobjectName",
|
|
2920
|
+
"type": "string",
|
|
2921
|
+
"info": ": string",
|
|
2922
|
+
"required": true,
|
|
2923
|
+
"schema": {
|
|
2924
|
+
"title": "sobjectName",
|
|
2925
|
+
"type": "string"
|
|
2926
|
+
}
|
|
2927
|
+
},
|
|
2928
|
+
{
|
|
2929
|
+
"name": "listViewId",
|
|
2930
|
+
"type": "string",
|
|
2931
|
+
"info": ": string",
|
|
2932
|
+
"required": true,
|
|
2933
|
+
"schema": {
|
|
2934
|
+
"title": "listViewId",
|
|
2935
|
+
"type": "string"
|
|
2936
|
+
}
|
|
2937
|
+
},
|
|
2938
|
+
{
|
|
2939
|
+
"name": "iapMetadata",
|
|
2940
|
+
"type": "object",
|
|
2941
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2942
|
+
"required": false,
|
|
2943
|
+
"schema": {
|
|
2944
|
+
"title": "iapMetadata",
|
|
2945
|
+
"type": "object"
|
|
2946
|
+
}
|
|
2947
|
+
}
|
|
2948
|
+
],
|
|
2949
|
+
"output": {
|
|
2950
|
+
"name": "result",
|
|
2951
|
+
"type": "object",
|
|
2952
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2953
|
+
"schema": {
|
|
2954
|
+
"title": "result",
|
|
2955
|
+
"type": "object"
|
|
2956
|
+
}
|
|
2957
|
+
},
|
|
2958
|
+
"roles": [
|
|
2959
|
+
"admin"
|
|
2960
|
+
],
|
|
2961
|
+
"route": {
|
|
2962
|
+
"verb": "POST",
|
|
2963
|
+
"path": "/listViewResults"
|
|
2964
|
+
},
|
|
2965
|
+
"task": true
|
|
2966
|
+
},
|
|
2967
|
+
{
|
|
2968
|
+
"name": "recentlyViewedItems",
|
|
2969
|
+
"summary": "Recently Viewed Items",
|
|
2970
|
+
"description": "Gets the most recently accessed items that were viewed or referenced by the current user. Salesforce stores information about record views in the interface and uses it to generate a list of recently viewed and referenced records, such as in the sidebar and for the auto-complete options in search.\n\nThis resource only accesses most recently used item information. If you want to modify the list of recently viewed items, you’ll need to update recently viewed information directly by using a SOQL Quer...(description truncated)",
|
|
2971
|
+
"input": [
|
|
2972
|
+
{
|
|
2973
|
+
"name": "limit",
|
|
2974
|
+
"type": "string",
|
|
2975
|
+
"info": ": string",
|
|
2976
|
+
"required": true,
|
|
2977
|
+
"schema": {
|
|
2978
|
+
"title": "limit",
|
|
2979
|
+
"type": "string"
|
|
2980
|
+
}
|
|
2981
|
+
},
|
|
2982
|
+
{
|
|
2983
|
+
"name": "sobjectName",
|
|
2984
|
+
"type": "string",
|
|
2985
|
+
"info": ": string",
|
|
2986
|
+
"required": true,
|
|
2987
|
+
"schema": {
|
|
2988
|
+
"title": "sobjectName",
|
|
2989
|
+
"type": "string"
|
|
2990
|
+
}
|
|
2991
|
+
},
|
|
2992
|
+
{
|
|
2993
|
+
"name": "iapMetadata",
|
|
2994
|
+
"type": "object",
|
|
2995
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2996
|
+
"required": false,
|
|
2997
|
+
"schema": {
|
|
2998
|
+
"title": "iapMetadata",
|
|
2999
|
+
"type": "object"
|
|
3000
|
+
}
|
|
3001
|
+
}
|
|
3002
|
+
],
|
|
3003
|
+
"output": {
|
|
3004
|
+
"name": "result",
|
|
3005
|
+
"type": "object",
|
|
3006
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3007
|
+
"schema": {
|
|
3008
|
+
"title": "result",
|
|
3009
|
+
"type": "object"
|
|
3010
|
+
}
|
|
3011
|
+
},
|
|
3012
|
+
"roles": [
|
|
3013
|
+
"admin"
|
|
3014
|
+
],
|
|
3015
|
+
"route": {
|
|
3016
|
+
"verb": "POST",
|
|
3017
|
+
"path": "/recentlyViewedItems"
|
|
3018
|
+
},
|
|
3019
|
+
"task": true
|
|
3020
|
+
},
|
|
3021
|
+
{
|
|
3022
|
+
"name": "geteventlogs",
|
|
3023
|
+
"summary": "Get event logs",
|
|
3024
|
+
"description": "Executes the specified SOQL query.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm",
|
|
3025
|
+
"input": [
|
|
3026
|
+
{
|
|
3027
|
+
"name": "q",
|
|
3028
|
+
"type": "string",
|
|
3029
|
+
"info": "Gets the first 200 EventLogFile records ordered by most recently updated first.: string",
|
|
3030
|
+
"required": true,
|
|
3031
|
+
"schema": {
|
|
3032
|
+
"title": "q",
|
|
3033
|
+
"type": "string"
|
|
3034
|
+
}
|
|
3035
|
+
},
|
|
3036
|
+
{
|
|
3037
|
+
"name": "iapMetadata",
|
|
3038
|
+
"type": "object",
|
|
3039
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3040
|
+
"required": false,
|
|
3041
|
+
"schema": {
|
|
3042
|
+
"title": "iapMetadata",
|
|
3043
|
+
"type": "object"
|
|
3044
|
+
}
|
|
3045
|
+
}
|
|
3046
|
+
],
|
|
3047
|
+
"output": {
|
|
3048
|
+
"name": "result",
|
|
3049
|
+
"type": "object",
|
|
3050
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3051
|
+
"schema": {
|
|
3052
|
+
"title": "result",
|
|
3053
|
+
"type": "object"
|
|
3054
|
+
}
|
|
3055
|
+
},
|
|
3056
|
+
"roles": [
|
|
3057
|
+
"admin"
|
|
3058
|
+
],
|
|
3059
|
+
"route": {
|
|
3060
|
+
"verb": "POST",
|
|
3061
|
+
"path": "/geteventlogs"
|
|
3062
|
+
},
|
|
3063
|
+
"task": true
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
"name": "geteventlogfile",
|
|
3067
|
+
"summary": "Get event log file",
|
|
3068
|
+
"description": "Get event log file",
|
|
3069
|
+
"input": [
|
|
3070
|
+
{
|
|
3071
|
+
"name": "id",
|
|
3072
|
+
"type": "string",
|
|
3073
|
+
"info": "Log event Id: string",
|
|
3074
|
+
"required": true,
|
|
3075
|
+
"schema": {
|
|
3076
|
+
"title": "id",
|
|
3077
|
+
"type": "string"
|
|
3078
|
+
}
|
|
3079
|
+
},
|
|
3080
|
+
{
|
|
3081
|
+
"name": "iapMetadata",
|
|
3082
|
+
"type": "object",
|
|
3083
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3084
|
+
"required": false,
|
|
3085
|
+
"schema": {
|
|
3086
|
+
"title": "iapMetadata",
|
|
3087
|
+
"type": "object"
|
|
3088
|
+
}
|
|
3089
|
+
}
|
|
3090
|
+
],
|
|
3091
|
+
"output": {
|
|
3092
|
+
"name": "result",
|
|
3093
|
+
"type": "object",
|
|
3094
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3095
|
+
"schema": {
|
|
3096
|
+
"title": "result",
|
|
3097
|
+
"type": "object"
|
|
3098
|
+
}
|
|
3099
|
+
},
|
|
3100
|
+
"roles": [
|
|
3101
|
+
"admin"
|
|
3102
|
+
],
|
|
3103
|
+
"route": {
|
|
3104
|
+
"verb": "POST",
|
|
3105
|
+
"path": "/geteventlogfile"
|
|
3106
|
+
},
|
|
3107
|
+
"task": true
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
"name": "scheduling",
|
|
3111
|
+
"summary": "Scheduling",
|
|
3112
|
+
"description": "Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm",
|
|
3113
|
+
"input": [
|
|
3114
|
+
{
|
|
3115
|
+
"name": "iapMetadata",
|
|
3116
|
+
"type": "object",
|
|
3117
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3118
|
+
"required": false,
|
|
3119
|
+
"schema": {
|
|
3120
|
+
"title": "iapMetadata",
|
|
3121
|
+
"type": "object"
|
|
3122
|
+
}
|
|
3123
|
+
}
|
|
3124
|
+
],
|
|
3125
|
+
"output": {
|
|
3126
|
+
"name": "result",
|
|
3127
|
+
"type": "object",
|
|
3128
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3129
|
+
"schema": {
|
|
3130
|
+
"title": "result",
|
|
3131
|
+
"type": "object"
|
|
3132
|
+
}
|
|
3133
|
+
},
|
|
3134
|
+
"roles": [
|
|
3135
|
+
"admin"
|
|
3136
|
+
],
|
|
3137
|
+
"route": {
|
|
3138
|
+
"verb": "GET",
|
|
3139
|
+
"path": "/scheduling"
|
|
3140
|
+
},
|
|
3141
|
+
"task": true
|
|
3142
|
+
},
|
|
3143
|
+
{
|
|
3144
|
+
"name": "getAppointmentSlots",
|
|
3145
|
+
"summary": "Get Appointment Slots",
|
|
3146
|
+
"description": "Returns a list of available appointment time slots for a resource based on given work type group and territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentslots.htm",
|
|
3147
|
+
"input": [
|
|
3148
|
+
{
|
|
3149
|
+
"name": "body",
|
|
3150
|
+
"type": "object",
|
|
3151
|
+
"info": ": object",
|
|
3152
|
+
"required": true,
|
|
3153
|
+
"schema": {
|
|
3154
|
+
"allOf": [
|
|
3155
|
+
{
|
|
3156
|
+
"type": "object"
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
"type": "object"
|
|
3160
|
+
}
|
|
3161
|
+
],
|
|
3162
|
+
"definitions": {}
|
|
3163
|
+
}
|
|
3164
|
+
},
|
|
3165
|
+
{
|
|
3166
|
+
"name": "iapMetadata",
|
|
3167
|
+
"type": "object",
|
|
3168
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3169
|
+
"required": false,
|
|
3170
|
+
"schema": {
|
|
3171
|
+
"title": "iapMetadata",
|
|
3172
|
+
"type": "object"
|
|
3173
|
+
}
|
|
3174
|
+
}
|
|
3175
|
+
],
|
|
3176
|
+
"output": {
|
|
3177
|
+
"name": "result",
|
|
3178
|
+
"type": "object",
|
|
3179
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3180
|
+
"schema": {
|
|
3181
|
+
"title": "result",
|
|
3182
|
+
"type": "object"
|
|
3183
|
+
}
|
|
3184
|
+
},
|
|
3185
|
+
"roles": [
|
|
3186
|
+
"admin"
|
|
3187
|
+
],
|
|
3188
|
+
"route": {
|
|
3189
|
+
"verb": "POST",
|
|
3190
|
+
"path": "/getAppointmentSlots"
|
|
3191
|
+
},
|
|
3192
|
+
"task": true
|
|
3193
|
+
},
|
|
3194
|
+
{
|
|
3195
|
+
"name": "getAppointmentCandidates",
|
|
3196
|
+
"summary": "Get Appointment Candidates",
|
|
3197
|
+
"description": "Returns a list of available service resources (appointment candidates) based on work type group and service territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentcandidates.htm",
|
|
3198
|
+
"input": [
|
|
3199
|
+
{
|
|
3200
|
+
"name": "body",
|
|
3201
|
+
"type": "object",
|
|
3202
|
+
"info": ": object",
|
|
3203
|
+
"required": true,
|
|
3204
|
+
"schema": {
|
|
3205
|
+
"allOf": [
|
|
3206
|
+
{
|
|
3207
|
+
"type": "object"
|
|
3208
|
+
},
|
|
3209
|
+
{
|
|
3210
|
+
"type": "object"
|
|
3211
|
+
}
|
|
3212
|
+
],
|
|
3213
|
+
"definitions": {}
|
|
3214
|
+
}
|
|
3215
|
+
},
|
|
3216
|
+
{
|
|
3217
|
+
"name": "iapMetadata",
|
|
3218
|
+
"type": "object",
|
|
3219
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3220
|
+
"required": false,
|
|
3221
|
+
"schema": {
|
|
3222
|
+
"title": "iapMetadata",
|
|
3223
|
+
"type": "object"
|
|
3224
|
+
}
|
|
3225
|
+
}
|
|
3226
|
+
],
|
|
3227
|
+
"output": {
|
|
3228
|
+
"name": "result",
|
|
3229
|
+
"type": "object",
|
|
3230
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3231
|
+
"schema": {
|
|
3232
|
+
"title": "result",
|
|
3233
|
+
"type": "object"
|
|
3234
|
+
}
|
|
3235
|
+
},
|
|
3236
|
+
"roles": [
|
|
3237
|
+
"admin"
|
|
3238
|
+
],
|
|
3239
|
+
"route": {
|
|
3240
|
+
"verb": "POST",
|
|
3241
|
+
"path": "/getAppointmentCandidates"
|
|
3242
|
+
},
|
|
3243
|
+
"task": true
|
|
3244
|
+
},
|
|
3245
|
+
{
|
|
3246
|
+
"name": "search",
|
|
3247
|
+
"summary": "Search",
|
|
3248
|
+
"description": "Executes the specified SOSL search. The search string must be URL-encoded.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm",
|
|
3249
|
+
"input": [
|
|
3250
|
+
{
|
|
3251
|
+
"name": "q",
|
|
3252
|
+
"type": "string",
|
|
3253
|
+
"info": "A SOSL statement that is properly URL-encoded.: string",
|
|
3254
|
+
"required": true,
|
|
3255
|
+
"schema": {
|
|
3256
|
+
"title": "q",
|
|
3257
|
+
"type": "string"
|
|
3258
|
+
}
|
|
3259
|
+
},
|
|
3260
|
+
{
|
|
3261
|
+
"name": "iapMetadata",
|
|
3262
|
+
"type": "object",
|
|
3263
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3264
|
+
"required": false,
|
|
3265
|
+
"schema": {
|
|
3266
|
+
"title": "iapMetadata",
|
|
3267
|
+
"type": "object"
|
|
3268
|
+
}
|
|
3269
|
+
}
|
|
3270
|
+
],
|
|
3271
|
+
"output": {
|
|
3272
|
+
"name": "result",
|
|
3273
|
+
"type": "object",
|
|
3274
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3275
|
+
"schema": {
|
|
3276
|
+
"title": "result",
|
|
3277
|
+
"type": "object"
|
|
3278
|
+
}
|
|
3279
|
+
},
|
|
3280
|
+
"roles": [
|
|
3281
|
+
"admin"
|
|
3282
|
+
],
|
|
3283
|
+
"route": {
|
|
3284
|
+
"verb": "POST",
|
|
3285
|
+
"path": "/search"
|
|
3286
|
+
},
|
|
3287
|
+
"task": true
|
|
3288
|
+
},
|
|
3289
|
+
{
|
|
3290
|
+
"name": "searchScopeandOrder",
|
|
3291
|
+
"summary": "Search Scope and Order",
|
|
3292
|
+
"description": "Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list.\nThe returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using...(description truncated)",
|
|
3293
|
+
"input": [
|
|
3294
|
+
{
|
|
3295
|
+
"name": "iapMetadata",
|
|
3296
|
+
"type": "object",
|
|
3297
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3298
|
+
"required": false,
|
|
3299
|
+
"schema": {
|
|
3300
|
+
"title": "iapMetadata",
|
|
3301
|
+
"type": "object"
|
|
3302
|
+
}
|
|
3303
|
+
}
|
|
3304
|
+
],
|
|
3305
|
+
"output": {
|
|
3306
|
+
"name": "result",
|
|
3307
|
+
"type": "object",
|
|
3308
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3309
|
+
"schema": {
|
|
3310
|
+
"title": "result",
|
|
3311
|
+
"type": "object"
|
|
3312
|
+
}
|
|
3313
|
+
},
|
|
3314
|
+
"roles": [
|
|
3315
|
+
"admin"
|
|
3316
|
+
],
|
|
3317
|
+
"route": {
|
|
3318
|
+
"verb": "GET",
|
|
3319
|
+
"path": "/searchScopeandOrder"
|
|
3320
|
+
},
|
|
3321
|
+
"task": true
|
|
3322
|
+
},
|
|
3323
|
+
{
|
|
3324
|
+
"name": "searchResultLayouts",
|
|
3325
|
+
"summary": "Search Result Layouts",
|
|
3326
|
+
"description": "Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page.\nThis call supports bulk fetch for up to 100 objects in a query.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_layouts.htm",
|
|
3327
|
+
"input": [
|
|
3328
|
+
{
|
|
3329
|
+
"name": "q",
|
|
3330
|
+
"type": "string",
|
|
3331
|
+
"info": "Comma delimited object list: string",
|
|
3332
|
+
"required": true,
|
|
3333
|
+
"schema": {
|
|
3334
|
+
"title": "q",
|
|
3335
|
+
"type": "string"
|
|
3336
|
+
}
|
|
3337
|
+
},
|
|
3338
|
+
{
|
|
3339
|
+
"name": "iapMetadata",
|
|
3340
|
+
"type": "object",
|
|
3341
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3342
|
+
"required": false,
|
|
3343
|
+
"schema": {
|
|
3344
|
+
"title": "iapMetadata",
|
|
3345
|
+
"type": "object"
|
|
3346
|
+
}
|
|
3347
|
+
}
|
|
3348
|
+
],
|
|
3349
|
+
"output": {
|
|
3350
|
+
"name": "result",
|
|
3351
|
+
"type": "object",
|
|
3352
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3353
|
+
"schema": {
|
|
3354
|
+
"title": "result",
|
|
3355
|
+
"type": "object"
|
|
3356
|
+
}
|
|
3357
|
+
},
|
|
3358
|
+
"roles": [
|
|
3359
|
+
"admin"
|
|
3360
|
+
],
|
|
3361
|
+
"route": {
|
|
3362
|
+
"verb": "POST",
|
|
3363
|
+
"path": "/searchResultLayouts"
|
|
3364
|
+
},
|
|
3365
|
+
"task": true
|
|
3366
|
+
},
|
|
3367
|
+
{
|
|
3368
|
+
"name": "searchforRecordsSuggestedbyAutocompleteandInstantResults",
|
|
3369
|
+
"summary": "Search for Records Suggested by Autocomplete and Instant Results",
|
|
3370
|
+
"description": "Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_records.htm",
|
|
3371
|
+
"input": [
|
|
3372
|
+
{
|
|
3373
|
+
"name": "q",
|
|
3374
|
+
"type": "string",
|
|
3375
|
+
"info": ": string",
|
|
3376
|
+
"required": true,
|
|
3377
|
+
"schema": {
|
|
3378
|
+
"title": "q",
|
|
3379
|
+
"type": "string"
|
|
3380
|
+
}
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"name": "sobject",
|
|
3384
|
+
"type": "string",
|
|
3385
|
+
"info": ": string",
|
|
3386
|
+
"required": true,
|
|
3387
|
+
"schema": {
|
|
3388
|
+
"title": "sobject",
|
|
3389
|
+
"type": "string"
|
|
3390
|
+
}
|
|
3391
|
+
},
|
|
3392
|
+
{
|
|
3393
|
+
"name": "iapMetadata",
|
|
3394
|
+
"type": "object",
|
|
3395
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3396
|
+
"required": false,
|
|
3397
|
+
"schema": {
|
|
3398
|
+
"title": "iapMetadata",
|
|
3399
|
+
"type": "object"
|
|
3400
|
+
}
|
|
3401
|
+
}
|
|
3402
|
+
],
|
|
3403
|
+
"output": {
|
|
3404
|
+
"name": "result",
|
|
3405
|
+
"type": "object",
|
|
3406
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3407
|
+
"schema": {
|
|
3408
|
+
"title": "result",
|
|
3409
|
+
"type": "object"
|
|
3410
|
+
}
|
|
3411
|
+
},
|
|
3412
|
+
"roles": [
|
|
3413
|
+
"admin"
|
|
3414
|
+
],
|
|
3415
|
+
"route": {
|
|
3416
|
+
"verb": "POST",
|
|
3417
|
+
"path": "/searchforRecordsSuggestedbyAutocompleteandInstantResults"
|
|
3418
|
+
},
|
|
3419
|
+
"task": true
|
|
3420
|
+
},
|
|
3421
|
+
{
|
|
3422
|
+
"name": "searchSuggestedQueries",
|
|
3423
|
+
"summary": "Search Suggested Queries",
|
|
3424
|
+
"description": "Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm",
|
|
3425
|
+
"input": [
|
|
3426
|
+
{
|
|
3427
|
+
"name": "q",
|
|
3428
|
+
"type": "string",
|
|
3429
|
+
"info": ": string",
|
|
3430
|
+
"required": true,
|
|
3431
|
+
"schema": {
|
|
3432
|
+
"title": "q",
|
|
3433
|
+
"type": "string"
|
|
3434
|
+
}
|
|
3435
|
+
},
|
|
3436
|
+
{
|
|
3437
|
+
"name": "language",
|
|
3438
|
+
"type": "string",
|
|
3439
|
+
"info": ": string",
|
|
3440
|
+
"required": true,
|
|
3441
|
+
"schema": {
|
|
3442
|
+
"title": "language",
|
|
3443
|
+
"type": "string"
|
|
3444
|
+
}
|
|
3445
|
+
},
|
|
3446
|
+
{
|
|
3447
|
+
"name": "iapMetadata",
|
|
3448
|
+
"type": "object",
|
|
3449
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3450
|
+
"required": false,
|
|
3451
|
+
"schema": {
|
|
3452
|
+
"title": "iapMetadata",
|
|
3453
|
+
"type": "object"
|
|
3454
|
+
}
|
|
3455
|
+
}
|
|
3456
|
+
],
|
|
3457
|
+
"output": {
|
|
3458
|
+
"name": "result",
|
|
3459
|
+
"type": "object",
|
|
3460
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3461
|
+
"schema": {
|
|
3462
|
+
"title": "result",
|
|
3463
|
+
"type": "object"
|
|
3464
|
+
}
|
|
3465
|
+
},
|
|
3466
|
+
"roles": [
|
|
3467
|
+
"admin"
|
|
3468
|
+
],
|
|
3469
|
+
"route": {
|
|
3470
|
+
"verb": "POST",
|
|
3471
|
+
"path": "/searchSuggestedQueries"
|
|
3472
|
+
},
|
|
3473
|
+
"task": true
|
|
3474
|
+
},
|
|
3475
|
+
{
|
|
3476
|
+
"name": "parameterizedSearch",
|
|
3477
|
+
"summary": "Parameterized Search",
|
|
3478
|
+
"description": "Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches.",
|
|
3479
|
+
"input": [
|
|
3480
|
+
{
|
|
3481
|
+
"name": "q",
|
|
3482
|
+
"type": "string",
|
|
3483
|
+
"info": "A search string that is properly URL-encoded: string",
|
|
3484
|
+
"required": true,
|
|
3485
|
+
"schema": {
|
|
3486
|
+
"title": "q",
|
|
3487
|
+
"type": "string"
|
|
3488
|
+
}
|
|
3489
|
+
},
|
|
3490
|
+
{
|
|
3491
|
+
"name": "iapMetadata",
|
|
3492
|
+
"type": "object",
|
|
3493
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3494
|
+
"required": false,
|
|
3495
|
+
"schema": {
|
|
3496
|
+
"title": "iapMetadata",
|
|
3497
|
+
"type": "object"
|
|
3498
|
+
}
|
|
3499
|
+
}
|
|
3500
|
+
],
|
|
3501
|
+
"output": {
|
|
3502
|
+
"name": "result",
|
|
3503
|
+
"type": "object",
|
|
3504
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3505
|
+
"schema": {
|
|
3506
|
+
"title": "result",
|
|
3507
|
+
"type": "object"
|
|
3508
|
+
}
|
|
3509
|
+
},
|
|
3510
|
+
"roles": [
|
|
3511
|
+
"admin"
|
|
3512
|
+
],
|
|
3513
|
+
"route": {
|
|
3514
|
+
"verb": "POST",
|
|
3515
|
+
"path": "/parameterizedSearch"
|
|
3516
|
+
},
|
|
3517
|
+
"task": true
|
|
3518
|
+
},
|
|
3519
|
+
{
|
|
3520
|
+
"name": "relevantItems",
|
|
3521
|
+
"summary": "Relevant Items",
|
|
3522
|
+
"description": "Gets the current user’s most relevant items. Relevant items include records for objects in the user’s global search scope and also most recently used (MRU) objects.\nRelevant items include up to 50 of the most recently viewed or updated records for each object in the user’s global search scope.\nNote\nThe user’s global search scope includes the objects the user interacted with most in the last 30 days, including objects the user pinned from the search results page in the Salesforce Classic.\n\nThen, ...(description truncated)",
|
|
3523
|
+
"input": [
|
|
3524
|
+
{
|
|
3525
|
+
"name": "iapMetadata",
|
|
3526
|
+
"type": "object",
|
|
3527
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3528
|
+
"required": false,
|
|
3529
|
+
"schema": {
|
|
3530
|
+
"title": "iapMetadata",
|
|
3531
|
+
"type": "object"
|
|
3532
|
+
}
|
|
3533
|
+
}
|
|
3534
|
+
],
|
|
3535
|
+
"output": {
|
|
3536
|
+
"name": "result",
|
|
3537
|
+
"type": "object",
|
|
3538
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3539
|
+
"schema": {
|
|
3540
|
+
"title": "result",
|
|
3541
|
+
"type": "object"
|
|
3542
|
+
}
|
|
3543
|
+
},
|
|
3544
|
+
"roles": [
|
|
3545
|
+
"admin"
|
|
3546
|
+
],
|
|
3547
|
+
"route": {
|
|
3548
|
+
"verb": "GET",
|
|
3549
|
+
"path": "/relevantItems"
|
|
3550
|
+
},
|
|
3551
|
+
"task": true
|
|
3552
|
+
},
|
|
3553
|
+
{
|
|
3554
|
+
"name": "processApprovals",
|
|
3555
|
+
"summary": "Process Approvals",
|
|
3556
|
+
"description": "Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm",
|
|
3557
|
+
"input": [
|
|
3558
|
+
{
|
|
3559
|
+
"name": "iapMetadata",
|
|
3560
|
+
"type": "object",
|
|
3561
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3562
|
+
"required": false,
|
|
3563
|
+
"schema": {
|
|
3564
|
+
"title": "iapMetadata",
|
|
3565
|
+
"type": "object"
|
|
3566
|
+
}
|
|
3567
|
+
}
|
|
3568
|
+
],
|
|
3569
|
+
"output": {
|
|
3570
|
+
"name": "result",
|
|
3571
|
+
"type": "object",
|
|
3572
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3573
|
+
"schema": {
|
|
3574
|
+
"title": "result",
|
|
3575
|
+
"type": "object"
|
|
3576
|
+
}
|
|
3577
|
+
},
|
|
3578
|
+
"roles": [
|
|
3579
|
+
"admin"
|
|
3580
|
+
],
|
|
3581
|
+
"route": {
|
|
3582
|
+
"verb": "GET",
|
|
3583
|
+
"path": "/processApprovals"
|
|
3584
|
+
},
|
|
3585
|
+
"task": true
|
|
3586
|
+
},
|
|
3587
|
+
{
|
|
3588
|
+
"name": "processApprovalsSubmit",
|
|
3589
|
+
"summary": "Process Approvals Submit",
|
|
3590
|
+
"description": "Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm",
|
|
3591
|
+
"input": [
|
|
3592
|
+
{
|
|
3593
|
+
"name": "body",
|
|
3594
|
+
"type": "object",
|
|
3595
|
+
"info": ": object",
|
|
3596
|
+
"required": true,
|
|
3597
|
+
"schema": {
|
|
3598
|
+
"allOf": [
|
|
3599
|
+
{
|
|
3600
|
+
"type": "object"
|
|
3601
|
+
},
|
|
3602
|
+
{
|
|
3603
|
+
"type": "object"
|
|
3604
|
+
}
|
|
3605
|
+
],
|
|
3606
|
+
"definitions": {}
|
|
3607
|
+
}
|
|
3608
|
+
},
|
|
3609
|
+
{
|
|
3610
|
+
"name": "iapMetadata",
|
|
3611
|
+
"type": "object",
|
|
3612
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3613
|
+
"required": false,
|
|
3614
|
+
"schema": {
|
|
3615
|
+
"title": "iapMetadata",
|
|
3616
|
+
"type": "object"
|
|
3617
|
+
}
|
|
3618
|
+
}
|
|
3619
|
+
],
|
|
3620
|
+
"output": {
|
|
3621
|
+
"name": "result",
|
|
3622
|
+
"type": "object",
|
|
3623
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3624
|
+
"schema": {
|
|
3625
|
+
"title": "result",
|
|
3626
|
+
"type": "object"
|
|
3627
|
+
}
|
|
3628
|
+
},
|
|
3629
|
+
"roles": [
|
|
3630
|
+
"admin"
|
|
3631
|
+
],
|
|
3632
|
+
"route": {
|
|
3633
|
+
"verb": "POST",
|
|
3634
|
+
"path": "/processApprovalsSubmit"
|
|
3635
|
+
},
|
|
3636
|
+
"task": true
|
|
3637
|
+
},
|
|
3638
|
+
{
|
|
3639
|
+
"name": "processRules",
|
|
3640
|
+
"summary": "Process Rules",
|
|
3641
|
+
"description": "Returns a list of all active workflow rules. If a rule has actions, the actions will be listed under the rule. Can also be used to trigger all workflow rules that are associated with a specified record. The actions for a rule are only fired if the rule’s criteria is met. When using a POST request, if anything fails, the whole transaction is rolled back.\n\nCross-object workflow rules cannot be invoked using the REST API.\n\nTo get a list of the workflow rules or to trigger one or more workflow rules...(description truncated)",
|
|
3642
|
+
"input": [
|
|
3643
|
+
{
|
|
3644
|
+
"name": "iapMetadata",
|
|
3645
|
+
"type": "object",
|
|
3646
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3647
|
+
"required": false,
|
|
3648
|
+
"schema": {
|
|
3649
|
+
"title": "iapMetadata",
|
|
3650
|
+
"type": "object"
|
|
3651
|
+
}
|
|
3652
|
+
}
|
|
3653
|
+
],
|
|
3654
|
+
"output": {
|
|
3655
|
+
"name": "result",
|
|
3656
|
+
"type": "object",
|
|
3657
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3658
|
+
"schema": {
|
|
3659
|
+
"title": "result",
|
|
3660
|
+
"type": "object"
|
|
3661
|
+
}
|
|
3662
|
+
},
|
|
3663
|
+
"roles": [
|
|
3664
|
+
"admin"
|
|
3665
|
+
],
|
|
3666
|
+
"route": {
|
|
3667
|
+
"verb": "GET",
|
|
3668
|
+
"path": "/processRules"
|
|
3669
|
+
},
|
|
3670
|
+
"task": true
|
|
3671
|
+
},
|
|
3672
|
+
{
|
|
3673
|
+
"name": "embeddedServiceConfigurationDescribe",
|
|
3674
|
+
"summary": "Embedded Service Configuration Describe",
|
|
3675
|
+
"description": "Retrieves the values for your Embedded Service deployment configuration, including the branding colors, font, and site URL.\n\nYou must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying.",
|
|
3676
|
+
"input": [
|
|
3677
|
+
{
|
|
3678
|
+
"name": "embeddedServiceConfigDeveloperName",
|
|
3679
|
+
"type": "string",
|
|
3680
|
+
"info": ": string",
|
|
3681
|
+
"required": true,
|
|
3682
|
+
"schema": {
|
|
3683
|
+
"title": "embeddedServiceConfigDeveloperName",
|
|
3684
|
+
"type": "string"
|
|
3685
|
+
}
|
|
3686
|
+
},
|
|
3687
|
+
{
|
|
3688
|
+
"name": "iapMetadata",
|
|
3689
|
+
"type": "object",
|
|
3690
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3691
|
+
"required": false,
|
|
3692
|
+
"schema": {
|
|
3693
|
+
"title": "iapMetadata",
|
|
3694
|
+
"type": "object"
|
|
3695
|
+
}
|
|
3696
|
+
}
|
|
3697
|
+
],
|
|
3698
|
+
"output": {
|
|
3699
|
+
"name": "result",
|
|
3700
|
+
"type": "object",
|
|
3701
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3702
|
+
"schema": {
|
|
3703
|
+
"title": "result",
|
|
3704
|
+
"type": "object"
|
|
3705
|
+
}
|
|
3706
|
+
},
|
|
3707
|
+
"roles": [
|
|
3708
|
+
"admin"
|
|
3709
|
+
],
|
|
3710
|
+
"route": {
|
|
3711
|
+
"verb": "POST",
|
|
3712
|
+
"path": "/embeddedServiceConfigurationDescribe"
|
|
3713
|
+
},
|
|
3714
|
+
"task": true
|
|
3715
|
+
},
|
|
3716
|
+
{
|
|
3717
|
+
"name": "dataCategoryGroups",
|
|
3718
|
+
"summary": "Data Category Groups",
|
|
3719
|
+
"description": "Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.",
|
|
3720
|
+
"input": [
|
|
3721
|
+
{
|
|
3722
|
+
"name": "sObjectName",
|
|
3723
|
+
"type": "string",
|
|
3724
|
+
"info": ": string",
|
|
3725
|
+
"required": true,
|
|
3726
|
+
"schema": {
|
|
3727
|
+
"title": "sObjectName",
|
|
3728
|
+
"type": "string"
|
|
3729
|
+
}
|
|
3730
|
+
},
|
|
3731
|
+
{
|
|
3732
|
+
"name": "iapMetadata",
|
|
3733
|
+
"type": "object",
|
|
3734
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3735
|
+
"required": false,
|
|
3736
|
+
"schema": {
|
|
3737
|
+
"title": "iapMetadata",
|
|
3738
|
+
"type": "object"
|
|
3739
|
+
}
|
|
3740
|
+
}
|
|
3741
|
+
],
|
|
3742
|
+
"output": {
|
|
3743
|
+
"name": "result",
|
|
3744
|
+
"type": "object",
|
|
3745
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3746
|
+
"schema": {
|
|
3747
|
+
"title": "result",
|
|
3748
|
+
"type": "object"
|
|
3749
|
+
}
|
|
3750
|
+
},
|
|
3751
|
+
"roles": [
|
|
3752
|
+
"admin"
|
|
3753
|
+
],
|
|
3754
|
+
"route": {
|
|
3755
|
+
"verb": "POST",
|
|
3756
|
+
"path": "/dataCategoryGroups"
|
|
3757
|
+
},
|
|
3758
|
+
"task": true
|
|
3759
|
+
},
|
|
3760
|
+
{
|
|
3761
|
+
"name": "dataCategoryDetail",
|
|
3762
|
+
"summary": "Data Category Detail",
|
|
3763
|
+
"description": "Get data category details and the child categories by a given category.",
|
|
3764
|
+
"input": [
|
|
3765
|
+
{
|
|
3766
|
+
"name": "group",
|
|
3767
|
+
"type": "string",
|
|
3768
|
+
"info": ": string",
|
|
3769
|
+
"required": true,
|
|
3770
|
+
"schema": {
|
|
3771
|
+
"title": "group",
|
|
3772
|
+
"type": "string"
|
|
3773
|
+
}
|
|
3774
|
+
},
|
|
3775
|
+
{
|
|
3776
|
+
"name": "cATEGORY",
|
|
3777
|
+
"type": "string",
|
|
3778
|
+
"info": ": string",
|
|
3779
|
+
"required": true,
|
|
3780
|
+
"schema": {
|
|
3781
|
+
"title": "cATEGORY",
|
|
3782
|
+
"type": "string"
|
|
3783
|
+
}
|
|
3784
|
+
},
|
|
3785
|
+
{
|
|
3786
|
+
"name": "iapMetadata",
|
|
3787
|
+
"type": "object",
|
|
3788
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3789
|
+
"required": false,
|
|
3790
|
+
"schema": {
|
|
3791
|
+
"title": "iapMetadata",
|
|
3792
|
+
"type": "object"
|
|
3793
|
+
}
|
|
3794
|
+
}
|
|
3795
|
+
],
|
|
3796
|
+
"output": {
|
|
3797
|
+
"name": "result",
|
|
3798
|
+
"type": "object",
|
|
3799
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3800
|
+
"schema": {
|
|
3801
|
+
"title": "result",
|
|
3802
|
+
"type": "object"
|
|
3803
|
+
}
|
|
3804
|
+
},
|
|
3805
|
+
"roles": [
|
|
3806
|
+
"admin"
|
|
3807
|
+
],
|
|
3808
|
+
"route": {
|
|
3809
|
+
"verb": "POST",
|
|
3810
|
+
"path": "/dataCategoryDetail"
|
|
3811
|
+
},
|
|
3812
|
+
"task": true
|
|
3813
|
+
},
|
|
3814
|
+
{
|
|
3815
|
+
"name": "articlesList",
|
|
3816
|
+
"summary": "Articles List",
|
|
3817
|
+
"description": "Get a page of online articles for the given language and category through either search or query.",
|
|
3818
|
+
"input": [
|
|
3819
|
+
{
|
|
3820
|
+
"name": "iapMetadata",
|
|
3821
|
+
"type": "object",
|
|
3822
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3823
|
+
"required": false,
|
|
3824
|
+
"schema": {
|
|
3825
|
+
"title": "iapMetadata",
|
|
3826
|
+
"type": "object"
|
|
3827
|
+
}
|
|
3828
|
+
}
|
|
3829
|
+
],
|
|
3830
|
+
"output": {
|
|
3831
|
+
"name": "result",
|
|
3832
|
+
"type": "object",
|
|
3833
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3834
|
+
"schema": {
|
|
3835
|
+
"title": "result",
|
|
3836
|
+
"type": "object"
|
|
3837
|
+
}
|
|
3838
|
+
},
|
|
3839
|
+
"roles": [
|
|
3840
|
+
"admin"
|
|
3841
|
+
],
|
|
3842
|
+
"route": {
|
|
3843
|
+
"verb": "GET",
|
|
3844
|
+
"path": "/articlesList"
|
|
3845
|
+
},
|
|
3846
|
+
"task": true
|
|
3847
|
+
},
|
|
3848
|
+
{
|
|
3849
|
+
"name": "articlesDetails",
|
|
3850
|
+
"summary": "Articles Details",
|
|
3851
|
+
"description": "Get all online article fields, accessible to the user.",
|
|
3852
|
+
"input": [
|
|
3853
|
+
{
|
|
3854
|
+
"name": "articleId",
|
|
3855
|
+
"type": "string",
|
|
3856
|
+
"info": ": string",
|
|
3857
|
+
"required": true,
|
|
3858
|
+
"schema": {
|
|
3859
|
+
"title": "articleId",
|
|
3860
|
+
"type": "string"
|
|
3861
|
+
}
|
|
3862
|
+
},
|
|
3863
|
+
{
|
|
3864
|
+
"name": "iapMetadata",
|
|
3865
|
+
"type": "object",
|
|
3866
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3867
|
+
"required": false,
|
|
3868
|
+
"schema": {
|
|
3869
|
+
"title": "iapMetadata",
|
|
3870
|
+
"type": "object"
|
|
3871
|
+
}
|
|
3872
|
+
}
|
|
3873
|
+
],
|
|
3874
|
+
"output": {
|
|
3875
|
+
"name": "result",
|
|
3876
|
+
"type": "object",
|
|
3877
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3878
|
+
"schema": {
|
|
3879
|
+
"title": "result",
|
|
3880
|
+
"type": "object"
|
|
3881
|
+
}
|
|
3882
|
+
},
|
|
3883
|
+
"roles": [
|
|
3884
|
+
"admin"
|
|
3885
|
+
],
|
|
3886
|
+
"route": {
|
|
3887
|
+
"verb": "POST",
|
|
3888
|
+
"path": "/articlesDetails"
|
|
3889
|
+
},
|
|
3890
|
+
"task": true
|
|
3891
|
+
},
|
|
3892
|
+
{
|
|
3893
|
+
"name": "retrieveKnowledgeLanguageSettings",
|
|
3894
|
+
"summary": "Retrieve Knowledge Language Settings",
|
|
3895
|
+
"description": "Returns the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_knowledge_retrieve_language.htm",
|
|
3896
|
+
"input": [
|
|
3897
|
+
{
|
|
3898
|
+
"name": "iapMetadata",
|
|
3899
|
+
"type": "object",
|
|
3900
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3901
|
+
"required": false,
|
|
3902
|
+
"schema": {
|
|
3903
|
+
"title": "iapMetadata",
|
|
3904
|
+
"type": "object"
|
|
3905
|
+
}
|
|
3906
|
+
}
|
|
3907
|
+
],
|
|
3908
|
+
"output": {
|
|
3909
|
+
"name": "result",
|
|
3910
|
+
"type": "object",
|
|
3911
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3912
|
+
"schema": {
|
|
3913
|
+
"title": "result",
|
|
3914
|
+
"type": "object"
|
|
3915
|
+
}
|
|
3916
|
+
},
|
|
3917
|
+
"roles": [
|
|
3918
|
+
"admin"
|
|
3919
|
+
],
|
|
3920
|
+
"route": {
|
|
3921
|
+
"verb": "GET",
|
|
3922
|
+
"path": "/retrieveKnowledgeLanguageSettings"
|
|
3923
|
+
},
|
|
3924
|
+
"task": true
|
|
3925
|
+
},
|
|
3926
|
+
{
|
|
3927
|
+
"name": "apexREST",
|
|
3928
|
+
"summary": "Apex REST",
|
|
3929
|
+
"description": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/...(description truncated)",
|
|
3930
|
+
"input": [
|
|
3931
|
+
{
|
|
3932
|
+
"name": "urlMapping",
|
|
3933
|
+
"type": "string",
|
|
3934
|
+
"info": "Value of `urlMapping` as defined in `@RestResource` annotation in the Apex class.: string",
|
|
3935
|
+
"required": true,
|
|
3936
|
+
"schema": {
|
|
3937
|
+
"title": "urlMapping",
|
|
3938
|
+
"type": "string"
|
|
3939
|
+
}
|
|
3940
|
+
},
|
|
3941
|
+
{
|
|
3942
|
+
"name": "iapMetadata",
|
|
3943
|
+
"type": "object",
|
|
3944
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3945
|
+
"required": false,
|
|
3946
|
+
"schema": {
|
|
3947
|
+
"title": "iapMetadata",
|
|
3948
|
+
"type": "object"
|
|
3949
|
+
}
|
|
3950
|
+
}
|
|
3951
|
+
],
|
|
3952
|
+
"output": {
|
|
3953
|
+
"name": "result",
|
|
3954
|
+
"type": "object",
|
|
3955
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3956
|
+
"schema": {
|
|
3957
|
+
"title": "result",
|
|
3958
|
+
"type": "object"
|
|
3959
|
+
}
|
|
3960
|
+
},
|
|
3961
|
+
"roles": [
|
|
3962
|
+
"admin"
|
|
3963
|
+
],
|
|
3964
|
+
"route": {
|
|
3965
|
+
"verb": "POST",
|
|
3966
|
+
"path": "/apexREST"
|
|
3967
|
+
},
|
|
3968
|
+
"task": true
|
|
3969
|
+
},
|
|
3970
|
+
{
|
|
3971
|
+
"name": "versions",
|
|
3972
|
+
"summary": "Versions",
|
|
3973
|
+
"description": "Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root.",
|
|
3974
|
+
"input": [
|
|
3975
|
+
{
|
|
3976
|
+
"name": "iapMetadata",
|
|
3977
|
+
"type": "object",
|
|
3978
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
3979
|
+
"required": false,
|
|
3980
|
+
"schema": {
|
|
3981
|
+
"title": "iapMetadata",
|
|
3982
|
+
"type": "object"
|
|
3983
|
+
}
|
|
3984
|
+
}
|
|
3985
|
+
],
|
|
3986
|
+
"output": {
|
|
3987
|
+
"name": "result",
|
|
3988
|
+
"type": "object",
|
|
3989
|
+
"description": "A JSON Object containing status, code and the result",
|
|
3990
|
+
"schema": {
|
|
3991
|
+
"title": "result",
|
|
3992
|
+
"type": "object"
|
|
3993
|
+
}
|
|
3994
|
+
},
|
|
3995
|
+
"roles": [
|
|
3996
|
+
"admin"
|
|
3997
|
+
],
|
|
3998
|
+
"route": {
|
|
3999
|
+
"verb": "GET",
|
|
4000
|
+
"path": "/versions"
|
|
4001
|
+
},
|
|
4002
|
+
"task": true
|
|
4003
|
+
},
|
|
4004
|
+
{
|
|
4005
|
+
"name": "resourcesbyVersion",
|
|
4006
|
+
"summary": "Resources by Version",
|
|
4007
|
+
"description": "Lists available resources for the specified API version, including resource name and URI.",
|
|
4008
|
+
"input": [
|
|
4009
|
+
{
|
|
4010
|
+
"name": "iapMetadata",
|
|
4011
|
+
"type": "object",
|
|
4012
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4013
|
+
"required": false,
|
|
4014
|
+
"schema": {
|
|
4015
|
+
"title": "iapMetadata",
|
|
4016
|
+
"type": "object"
|
|
4017
|
+
}
|
|
4018
|
+
}
|
|
4019
|
+
],
|
|
4020
|
+
"output": {
|
|
4021
|
+
"name": "result",
|
|
4022
|
+
"type": "object",
|
|
4023
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4024
|
+
"schema": {
|
|
4025
|
+
"title": "result",
|
|
4026
|
+
"type": "object"
|
|
4027
|
+
}
|
|
4028
|
+
},
|
|
4029
|
+
"roles": [
|
|
4030
|
+
"admin"
|
|
4031
|
+
],
|
|
4032
|
+
"route": {
|
|
4033
|
+
"verb": "GET",
|
|
4034
|
+
"path": "/resourcesbyVersion"
|
|
4035
|
+
},
|
|
4036
|
+
"task": true
|
|
4037
|
+
},
|
|
4038
|
+
{
|
|
4039
|
+
"name": "limits",
|
|
4040
|
+
"summary": "Limits",
|
|
4041
|
+
"description": "Lists information about limits in your org. For each limit, this resource returns the maximum allocation and the remaining allocation based on usage. This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission",
|
|
4042
|
+
"input": [
|
|
4043
|
+
{
|
|
4044
|
+
"name": "iapMetadata",
|
|
4045
|
+
"type": "object",
|
|
4046
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4047
|
+
"required": false,
|
|
4048
|
+
"schema": {
|
|
4049
|
+
"title": "iapMetadata",
|
|
4050
|
+
"type": "object"
|
|
4051
|
+
}
|
|
4052
|
+
}
|
|
4053
|
+
],
|
|
4054
|
+
"output": {
|
|
4055
|
+
"name": "result",
|
|
4056
|
+
"type": "object",
|
|
4057
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4058
|
+
"schema": {
|
|
4059
|
+
"title": "result",
|
|
4060
|
+
"type": "object"
|
|
4061
|
+
}
|
|
4062
|
+
},
|
|
4063
|
+
"roles": [
|
|
4064
|
+
"admin"
|
|
4065
|
+
],
|
|
4066
|
+
"route": {
|
|
4067
|
+
"verb": "GET",
|
|
4068
|
+
"path": "/limits"
|
|
4069
|
+
},
|
|
4070
|
+
"task": true
|
|
4071
|
+
},
|
|
4072
|
+
{
|
|
4073
|
+
"name": "appMenu",
|
|
4074
|
+
"summary": "AppMenu",
|
|
4075
|
+
"description": "Returns a list of items in either the Salesforce app drop-down menu or the Salesforce for Android, iOS, and mobile web navigation menu.",
|
|
4076
|
+
"input": [
|
|
4077
|
+
{
|
|
4078
|
+
"name": "iapMetadata",
|
|
4079
|
+
"type": "object",
|
|
4080
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4081
|
+
"required": false,
|
|
4082
|
+
"schema": {
|
|
4083
|
+
"title": "iapMetadata",
|
|
4084
|
+
"type": "object"
|
|
4085
|
+
}
|
|
4086
|
+
}
|
|
4087
|
+
],
|
|
4088
|
+
"output": {
|
|
4089
|
+
"name": "result",
|
|
4090
|
+
"type": "object",
|
|
4091
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4092
|
+
"schema": {
|
|
4093
|
+
"title": "result",
|
|
4094
|
+
"type": "object"
|
|
4095
|
+
}
|
|
4096
|
+
},
|
|
4097
|
+
"roles": [
|
|
4098
|
+
"admin"
|
|
4099
|
+
],
|
|
4100
|
+
"route": {
|
|
4101
|
+
"verb": "GET",
|
|
4102
|
+
"path": "/appMenu"
|
|
4103
|
+
},
|
|
4104
|
+
"task": true
|
|
4105
|
+
},
|
|
4106
|
+
{
|
|
4107
|
+
"name": "consent",
|
|
4108
|
+
"summary": "Consent",
|
|
4109
|
+
"description": "Your users can store consent preferences in different locations and possibly inconsistently. You can locate your customers’ preferences for consent across multiple records when using API version 44.0 and later. Tracking consent preferences helps you and your users respect the most restrictive requests.\nConsent API aggregates consent settings across the Contact, Contact Point Type Consent, Data Use Purpose, Individual, Lead, Person Account, and User objects when the records have a lookup relation...(description truncated)",
|
|
4110
|
+
"input": [
|
|
4111
|
+
{
|
|
4112
|
+
"name": "actions",
|
|
4113
|
+
"type": "string",
|
|
4114
|
+
"info": ": string",
|
|
4115
|
+
"required": true,
|
|
4116
|
+
"schema": {
|
|
4117
|
+
"title": "actions",
|
|
4118
|
+
"type": "string"
|
|
4119
|
+
}
|
|
4120
|
+
},
|
|
4121
|
+
{
|
|
4122
|
+
"name": "ids",
|
|
4123
|
+
"type": "string",
|
|
4124
|
+
"info": ": string",
|
|
4125
|
+
"required": true,
|
|
4126
|
+
"schema": {
|
|
4127
|
+
"title": "ids",
|
|
4128
|
+
"type": "string"
|
|
4129
|
+
}
|
|
4130
|
+
},
|
|
4131
|
+
{
|
|
4132
|
+
"name": "iapMetadata",
|
|
4133
|
+
"type": "object",
|
|
4134
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4135
|
+
"required": false,
|
|
4136
|
+
"schema": {
|
|
4137
|
+
"title": "iapMetadata",
|
|
4138
|
+
"type": "object"
|
|
4139
|
+
}
|
|
4140
|
+
}
|
|
4141
|
+
],
|
|
4142
|
+
"output": {
|
|
4143
|
+
"name": "result",
|
|
4144
|
+
"type": "object",
|
|
4145
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4146
|
+
"schema": {
|
|
4147
|
+
"title": "result",
|
|
4148
|
+
"type": "object"
|
|
4149
|
+
}
|
|
4150
|
+
},
|
|
4151
|
+
"roles": [
|
|
4152
|
+
"admin"
|
|
4153
|
+
],
|
|
4154
|
+
"route": {
|
|
4155
|
+
"verb": "POST",
|
|
4156
|
+
"path": "/consent"
|
|
4157
|
+
},
|
|
4158
|
+
"task": true
|
|
4159
|
+
},
|
|
4160
|
+
{
|
|
4161
|
+
"name": "productSchedules",
|
|
4162
|
+
"summary": "Product Schedules",
|
|
4163
|
+
"description": "Work with revenue and quantity schedules for opportunity products. Establish or reestablish a product schedule with multiple installments for an opportunity product. Delete all installments in a schedule.\nThis resource is available in REST API version 43.0 and later.\n\nIn API version 46.0 and later, established and re-established schedules support custom fields, validation rules, and Apex triggers. Deleting all schedules now also fires delete triggers.\nhttps://developer.salesforce.com/docs/atlas....(description truncated)",
|
|
4164
|
+
"input": [
|
|
4165
|
+
{
|
|
4166
|
+
"name": "opportunityLineItemId",
|
|
4167
|
+
"type": "string",
|
|
4168
|
+
"info": ": string",
|
|
4169
|
+
"required": true,
|
|
4170
|
+
"schema": {
|
|
4171
|
+
"title": "opportunityLineItemId",
|
|
4172
|
+
"type": "string"
|
|
4173
|
+
}
|
|
4174
|
+
},
|
|
4175
|
+
{
|
|
4176
|
+
"name": "iapMetadata",
|
|
4177
|
+
"type": "object",
|
|
4178
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4179
|
+
"required": false,
|
|
4180
|
+
"schema": {
|
|
4181
|
+
"title": "iapMetadata",
|
|
4182
|
+
"type": "object"
|
|
4183
|
+
}
|
|
4184
|
+
}
|
|
4185
|
+
],
|
|
4186
|
+
"output": {
|
|
4187
|
+
"name": "result",
|
|
4188
|
+
"type": "object",
|
|
4189
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4190
|
+
"schema": {
|
|
4191
|
+
"title": "result",
|
|
4192
|
+
"type": "object"
|
|
4193
|
+
}
|
|
4194
|
+
},
|
|
4195
|
+
"roles": [
|
|
4196
|
+
"admin"
|
|
4197
|
+
],
|
|
4198
|
+
"route": {
|
|
4199
|
+
"verb": "POST",
|
|
4200
|
+
"path": "/productSchedules"
|
|
4201
|
+
},
|
|
4202
|
+
"task": true
|
|
4203
|
+
},
|
|
4204
|
+
{
|
|
4205
|
+
"name": "queryAll",
|
|
4206
|
+
"summary": "QueryAll",
|
|
4207
|
+
"description": "Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next...(description truncated)",
|
|
4208
|
+
"input": [
|
|
4209
|
+
{
|
|
4210
|
+
"name": "q",
|
|
4211
|
+
"type": "string",
|
|
4212
|
+
"info": ": string",
|
|
4213
|
+
"required": true,
|
|
4214
|
+
"schema": {
|
|
4215
|
+
"title": "q",
|
|
4216
|
+
"type": "string"
|
|
4217
|
+
}
|
|
4218
|
+
},
|
|
4219
|
+
{
|
|
4220
|
+
"name": "iapMetadata",
|
|
4221
|
+
"type": "object",
|
|
4222
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4223
|
+
"required": false,
|
|
4224
|
+
"schema": {
|
|
4225
|
+
"title": "iapMetadata",
|
|
4226
|
+
"type": "object"
|
|
4227
|
+
}
|
|
4228
|
+
}
|
|
4229
|
+
],
|
|
4230
|
+
"output": {
|
|
4231
|
+
"name": "result",
|
|
4232
|
+
"type": "object",
|
|
4233
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4234
|
+
"schema": {
|
|
4235
|
+
"title": "result",
|
|
4236
|
+
"type": "object"
|
|
4237
|
+
}
|
|
4238
|
+
},
|
|
4239
|
+
"roles": [
|
|
4240
|
+
"admin"
|
|
4241
|
+
],
|
|
4242
|
+
"route": {
|
|
4243
|
+
"verb": "POST",
|
|
4244
|
+
"path": "/queryAll"
|
|
4245
|
+
},
|
|
4246
|
+
"task": true
|
|
4247
|
+
},
|
|
4248
|
+
{
|
|
4249
|
+
"name": "recordCount",
|
|
4250
|
+
"summary": "Record Count",
|
|
4251
|
+
"description": "Lists information about object record counts in your organization.\nThis resource is available in REST API version 40.0 and later for API users with the “View Setup and Configuration” permission. The returned record count is approximate, and does not include the following types of records:\n\nDeleted records in the recycle bin.\nArchived records.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_record_count.htm",
|
|
4252
|
+
"input": [
|
|
4253
|
+
{
|
|
4254
|
+
"name": "sObjects",
|
|
4255
|
+
"type": "string",
|
|
4256
|
+
"info": "A comma-delimited list of object names. If a listed object is not found in the org, it is ignored and not returned in the response.\nThis parameter is optional. If this pa...(description truncated): string",
|
|
4257
|
+
"required": true,
|
|
4258
|
+
"schema": {
|
|
4259
|
+
"title": "sObjects",
|
|
4260
|
+
"type": "string"
|
|
4261
|
+
}
|
|
4262
|
+
},
|
|
4263
|
+
{
|
|
4264
|
+
"name": "iapMetadata",
|
|
4265
|
+
"type": "object",
|
|
4266
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4267
|
+
"required": false,
|
|
4268
|
+
"schema": {
|
|
4269
|
+
"title": "iapMetadata",
|
|
4270
|
+
"type": "object"
|
|
4271
|
+
}
|
|
4272
|
+
}
|
|
4273
|
+
],
|
|
4274
|
+
"output": {
|
|
4275
|
+
"name": "result",
|
|
4276
|
+
"type": "object",
|
|
4277
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4278
|
+
"schema": {
|
|
4279
|
+
"title": "result",
|
|
4280
|
+
"type": "object"
|
|
4281
|
+
}
|
|
4282
|
+
},
|
|
4283
|
+
"roles": [
|
|
4284
|
+
"admin"
|
|
4285
|
+
],
|
|
4286
|
+
"route": {
|
|
4287
|
+
"verb": "POST",
|
|
4288
|
+
"path": "/recordCount"
|
|
4289
|
+
},
|
|
4290
|
+
"task": true
|
|
4291
|
+
},
|
|
4292
|
+
{
|
|
4293
|
+
"name": "tabs",
|
|
4294
|
+
"summary": "Tabs",
|
|
4295
|
+
"description": "f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm",
|
|
4296
|
+
"input": [
|
|
4297
|
+
{
|
|
4298
|
+
"name": "iapMetadata",
|
|
4299
|
+
"type": "object",
|
|
4300
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4301
|
+
"required": false,
|
|
4302
|
+
"schema": {
|
|
4303
|
+
"title": "iapMetadata",
|
|
4304
|
+
"type": "object"
|
|
4305
|
+
}
|
|
4306
|
+
}
|
|
4307
|
+
],
|
|
4308
|
+
"output": {
|
|
4309
|
+
"name": "result",
|
|
4310
|
+
"type": "object",
|
|
4311
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4312
|
+
"schema": {
|
|
4313
|
+
"title": "result",
|
|
4314
|
+
"type": "object"
|
|
4315
|
+
}
|
|
4316
|
+
},
|
|
4317
|
+
"roles": [
|
|
4318
|
+
"admin"
|
|
4319
|
+
],
|
|
4320
|
+
"route": {
|
|
4321
|
+
"verb": "GET",
|
|
4322
|
+
"path": "/tabs"
|
|
4323
|
+
},
|
|
4324
|
+
"task": true
|
|
4325
|
+
},
|
|
4326
|
+
{
|
|
4327
|
+
"name": "themes",
|
|
4328
|
+
"summary": "Themes",
|
|
4329
|
+
"description": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/...(description truncated)",
|
|
4330
|
+
"input": [
|
|
4331
|
+
{
|
|
4332
|
+
"name": "iapMetadata",
|
|
4333
|
+
"type": "object",
|
|
4334
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
4335
|
+
"required": false,
|
|
4336
|
+
"schema": {
|
|
4337
|
+
"title": "iapMetadata",
|
|
4338
|
+
"type": "object"
|
|
4339
|
+
}
|
|
4340
|
+
}
|
|
4341
|
+
],
|
|
4342
|
+
"output": {
|
|
4343
|
+
"name": "result",
|
|
4344
|
+
"type": "object",
|
|
4345
|
+
"description": "A JSON Object containing status, code and the result",
|
|
4346
|
+
"schema": {
|
|
4347
|
+
"title": "result",
|
|
4348
|
+
"type": "object"
|
|
4349
|
+
}
|
|
4350
|
+
},
|
|
4351
|
+
"roles": [
|
|
4352
|
+
"admin"
|
|
4353
|
+
],
|
|
4354
|
+
"route": {
|
|
4355
|
+
"verb": "GET",
|
|
4356
|
+
"path": "/themes"
|
|
4357
|
+
},
|
|
4358
|
+
"task": true
|
|
4359
|
+
}
|
|
4360
|
+
],
|
|
4361
|
+
"views": []
|
|
4362
|
+
}
|