-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmetadata.js
executable file
·1117 lines (1092 loc) · 67.4 KB
/
metadata.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"use strict";
module.exports.do = function(req, res){
res.status(200).send({
"package": 'Salesforce',
"tagline": "interact with salseforce",
"description": "salesforce provides companies with an interface for case management and task management, and a system for automatically routing and escalating important events.",
"image": "https://logo.clearbit.com/salesforce.com",
"repo": "https://github.com/RapidAPI/Marketplace-Salesforce-Package",
"keywords": ["SaaS", "support", "cloud","API"],
"accounts": {
"domain": "salesforce.com",
"credentials": [
"instance",
"client_id",
"client_secret",
"username",
"password"
]
},
'blocks' : [{
"name":"getAccessToken",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"client_id", type:"credentials", info:"client id on salesforce.", required: true},
{name:"client_secret", type:"credentials", info:"secret key on salesforce.", required: true},
{name:"username", type:"credentials", info:"username on salesforce.", required: true},
{name:"password", type:"credentials", info:"password on salesforce.", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root."
},{
"name":"getAllVersions",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root."
},
{
"name":"getResourcesByVersion",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Lists available resources for the specified API version, including resource name and URI."
},
{
"name":"getLimits",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Lists information about limits in your org. This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission."
},
{
"name":"describeGlobal",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"modifiedSince", type:"Datepicker", info:"query only colums moldified within the given range", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"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."
},
{
"name":"getAccountObjectMetadata",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Retrieve the metadata for the Account object using the GET method."
},
{
"name":"createSObject",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"Object name to create", required: true},
{name:"inputs", type:"String", info:"json formated body for new object to be created", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Create a new Account object using the POST method"
},
{
"name":"describeSingleObject",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"modifiedSince", type:"Datepicker", info:"query only colums moldified within the given range", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Completely describes the individual metadata at all levels for the specified object."
},
{
"name":"getObjectsDeletedRecords",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"start", type:"Datepicker", info:"Starting date/time (Coordinated Universal Time (UTC)—not local— timezone) of the timespan for which to retrieve the data.", required: true},
{name:"end", type:"Datepicker", info:" Ending date/time (Coordinated Universal Time (UTC)—not local— timezone) of the timespan for which to retrieve the data. ", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Retrieves the list of individual records that have been deleted within the given timespan for the specified object."
}, {
"name":"getObjectsUpdatedRecords",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"start", type:"Datepicker", info:"Starting date/time (Coordinated Universal Time (UTC)—not local— timezone) of the timespan for which to retrieve the data.", required: true},
{name:"end", type:"Datepicker", info:" Ending date/time (Coordinated Universal Time (UTC)—not local— timezone) of the timespan for which to retrieve the data. ", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object."
},
{
"name":"getObjectsNamedLayouts",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"layoutName", type:"String", info:"the layout for for the returned query", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Retrieves information about alternate named layouts for a given object."
},
{
"name":"getObjectRows",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"recordId", type:"String", info:"the record id to fetch", required: true},
{name:"fields", type:"String", info:"Optional list of fields used to return values for.", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Accesses records based on the specified object ID."
},
{
"name":"deleteObjectRows",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"recordId", type:"String", info:"the record id to fetch", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"DELETE method to delete records."
},
{
"name":"updateObjectRows",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"recordId", type:"String", info:"the record id to fetch", required: true},
{name:"fields", type:"String", info:"Optional list of fields used to return values for.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"PATCH method to update records."
},
{
"name":"getObjectRowsByExternalId",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"fieldName", type:"String", info:"the specified external ID field", required: true},
{name:"fieldValue", type:"String", info:"the value for the object.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Gets records based on the value of a specified external ID field."
},
{
"name":"deleteObjectRowsByExternalId",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"fieldName", type:"String", info:"the specified external ID field", required: true},
{name:"fieldValue", type:"String", info:"the value for the object.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"strong textDelete object records based on the value of a specified external ID field."
},
{
"name":"updateObjectRowsByExternalId",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"fieldName", type:"String", info:"the specified external ID field", required: true},
{name:"fieldValue", type:"String", info:"the value for the object.", required: true},
{name:"fields", type:"String", info:"the values to change.", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Updates records based on the value of a specified external ID field."
},
{
"name":"postObjectRowsByExternalId",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"fieldName", type:"String", info:"the specified external ID field", required: true},
{name:"fieldValue", type:"String", info:"the value for the object.", required: true},
{name:"jsonbody", type:"String", info:"json formated body for new object to be created", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"adds records based on the value of a specified external ID field."
},
{
"name":"getApprovalLayouts",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"approvalProcessName", type:"String", info:"the specified approval Process Name field", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"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."
},
{
"name":"describeLayouts",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: false},
{name:"recordTypeId", type:"String", info:"the id for the record type", required: false},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of layouts and descriptions. The list of fields and the layout name are returned."
},
{
"name":"getPlatformAction",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns the description of the PlatformAction."
},
{
"name":"getObjectsQuickActions",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of specific object’s actions as well as global actions."
},
{
"name":"getObjectsActionsDefaultValues",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Return a specific action’s descriptive detail"
},
{
"name":"getObjectsActionsDefaultValuesById",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true},
{name:"contextId", type:"String", info:"the required action to return", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Return a specific action’s descriptive detail"
},
{
"name":"getRecordsByRelationship",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: false},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true},
{name:"recordId", type:"String", info:"the record id to fetch", required: true},
{name:"relationshipFieldName", type:"String", info:"the name of relationship Field to fetch", required: true},
{name:"fields", type:"String", info:"Optional list of fields used to return values for.", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Return a specific action’s descriptive detail"
},
{
"name":"deleteRecordByRelationship",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: false},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true},
{name:"contextId", type:"String", info:"the required action to return", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Deletes record by traversing object relationships via friendly URLs. "
},
{
"name":"updateRecordByRelationship",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: false},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true},
{name:"contextId", type:"String", info:"the required action to return", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Updates record by traversing object relationships via friendly URLs."
},
{
"name":"getSuggestedArticlesByRecordId",
"args":[
{name:"RecordID", type:"String", info:"record id to query by.", required: true},
{name:"language", type:"String", info:"Language that the article is written in.", required: true},
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"description", type:"String", info:"Text of the description. Valid only for new records without an existing ID and required if subject is null.", required: false},
{name:"subject", type:"String", info:"Text of the subject", required: false}, {name:"subject", type:"String", info:"Text of the subject", required: false},
{name:"articleTypes", type:"String", info:"Three-character ID prefixes indicating the desired article types", required: false},
{name:"categories", type:"String", info:"The name of the data category group and the data category API name (not category title) for desired articles.", required: false},
{name:"limit", type:"String", info:"Specifies the maximum number of suggested articles to return.", required: false},
{name:"publishStatus", type:"String", info:". The article’s publication status.", required: false},
{name:"topics", type:"String", info:"The topic of returned articles. ", required: false},
{name:"validationStatus", type:"String", info:"The validation status of returned articles. ", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of suggested Salesforce Knowledge articles for a case, work order, or work order line item."
},
{
"name":"getSugestedArticles",
"args":[
{name:"sObjectName", type:"String", info:"the SObject required", required: true},
{name:"language", type:"string", info:"Language that the article is written in.", required: true},
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"description", type:"String", info:"Text of the description. Valid only for new records without an existing ID and required if subject is null.", required: false},
{name:"subject", type:"String", info:"Text of the subject", required: false}, {name:"subject", type:"String", info:"Text of the subject", required: false},
{name:"articleTypes", type:"String", info:"Three-character ID prefixes indicating the desired article types", required: false},
{name:"categories", type:"String", info:"The name of the data category group and the data category API name (not category title) for desired articles.", required: false},
{name:"limit", type:"String", info:"Specifies the maximum number of suggested articles to return.", required: false},
{name:"publishStatus", type:"String", info:". The article’s publication status.", required: false},
{name:"topics", type:"String", info:"The topic of returned articles. ", required: false},
{name:"validationStatus", type:"String", info:"The validation status of returned articles. ", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of suggested Salesforce Knowledge articles for a case, work order, or work order line item."
},
{
"name":"getUserPasswordInformation",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"userId", type:"String", info:"the user id to fetch", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" get information about a user password"
}, {
"name":"setUserPassword",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"userId", type:"String", info:"the user id to fetch", required: true},
{name:"newPassword", type:"String", info:"the user id to fetch", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Sets user password."
}, {
"name":"resetUserPassword",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"userId", type:"String", info:"the user id to fetch", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Resets the user password."
},
{
"name":"getPlatformEventByName",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"platformEventName", type:"String", info:"the platform event name to fetch", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Gets the definition of a platform event in JSON format for a given event name."
},
{
"name":"getPlatformEventBySchemaId",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"schemaId", type:"String", info:"the platform event id to fetch", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Gets the definition of a platform event in JSON format for a given schema ID."
},
{
"name":"getSalesforceAppDropDownItems",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of items in the Salesforce app drop-down menu."
},
{
"name":"getSalesforceNavMenuItems",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of items in the Salesforce1 navigation menu."
},
{
"name":"getCompactLayouts",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"A comma-delimited list of objects. The primary compact layout for each object in this list will be returned in the response of this resource. ", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of compact layouts for multiple objects."
},
{
"name":"getListActionsTypes",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Retrieve a list of general action types for the current organization."
},
{
"name":"postToStandardAction",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true},
{name:"inputs", type:"String", info:"A JSON object{ \"inputs\": [ \"field\": \"value\" ] }", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Make a post request to an standard action type. "
},
{
"name":"postToCustomAction",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"actionName", type:"String", info:"the required action to return", required: true},
{name:"inputs", type:"String", info:"A JSON object{ \"inputs\": [ \"field\": \"value\" ] }", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Post request to any custom action."
},
{
"name":"getStandardActions",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Get a list of all available standard actions."
},
{
"name":"getCustomActions",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Get a list of all available custom actions."
},
{
"name":"describeListView",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectType", type:"String", info:"the type of object", required: true},
{name:"queryLocator", type:"String", info:"The children records can be accessed in the execute method of Batch Apex", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns detailed information about a list view, including the ID, the columns, and the SOQL query."
},
{
"name":"getListViewResults",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectType", type:"String", info:"the type of object", required: true},
{name:"listViewId", type:"String", info:"the view id to fetch", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Get a list of all available custom actions."
},
{
"name":"getListViews",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectType", type:"String", info:"the type of object", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns the list of list views for the specified sObject, including the ID and other basic information about each list view."
},
{
"name":"getDataCategoryGroups",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"KnowledgeArticleVersion only.... for now", required: true},
{name:"topCategoriesOnly", type:"Boolean", info:"Boolean", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Get data category groups that are visible to the current user."
},
{
"name":"getDataCategoryDetail",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectName", type:"String", info:"KnowledgeArticleVersion only.... for now", required: true},
{name:"group", type:"String", info:"the group to filter the data", required: true},
{name:"category", type:"String", info:"data Categories", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Get data category details and the child categories by a pgiven category."
},
{
"name":"getArticlesList",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"query", type:"String", info:" Performs an SOSL search. If the query String is null, empty, or not given, an SOQL query runs.", required: false},
{name:"channel", type:"String", info:"Defaults to user’s context. For information on channel values, see Valid channel values.", required: false},
{name:"categories", type:"String", info:"Map JSON format {“group1”:”category1”,”group2”:”category2”,...}", required: false},
{name:"queryMethod", type:"String", info:"values are: AT, BELOW, ABOVE, ABOVE_OR_BELOW. Only valid when categories are specified, defaults to ABOVE_OR_BELOW.", required: false},
{name:"sort", type:"String", info:"a sortable field name LastPublishedDate, CreatedDate, Title, ViewScore. Defaults to LastPublishedDate for query and relevance for search.", required: false},
{name:"order", type:"String", info:"", required: false},
{name:"pageSize", type:"String", info:"", required: false},
{name:"pageNumber", type:"String", info:"", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Get a page of online articles for the given language and category through either search or query."
},
{
"name":"getArticleDetails",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"articleId", type:"String", info:"article Id", required: true},
{name:"channel", type:"String", info:"defaults to user’s context.", required: false},
{name:"updateViewStat", type:"bolean", info:"boolean, defaults to true. If true, API updates the view count in the given channel as well as the total view count.", required: false},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Get all article fields, accessible to the user."
},
{
"name":"parameterizedSearch",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"query", type:"String", info:"A search String that is properly URL-encoded", required: true},
{name:"dataCategory", type:"String", info:"Single value. If an organization uses Salesforce Knowledge articles or answers, dataCategory filters all search results based on one data category.", required: false},
{name:"division", type:"String", info:"ingle value. Filters search results based on the division field.", required: false},
{name:"fields", type:"String", info:"Array of one or more fields to return in the response for each sobjects specified. At least one sobjects must be specified at the global level.", required: false},
{name:"in", type:"String", info:"Scope of fields to search. If you specify one or more scope values, the fields are returned for all found objects.", required: false},
{name:"metadata", type:"String", info:"Scope of fields to search. If you specify one or more scope values, the fields are returned for all found objects.", required: false},
{name:"in", type:"String", info:"Scope of fields to search. If you specify one or more scope values, the fields are returned for all found objects.", required: false},
{name:"metadata", type:"String", info:"Specifies if metadata should be returned in the response. No metadata is returned by default. To include metadata in the response, use the LABELS value, which returns the display label for the fields returned in search results. ", required: false},
{name:"netWorkIds", type:"String", info:"Filters search results by an array.A network ID represents the community ID.", required: false},
{name:"offset", type:"String", info:"Single value. The starting row offset into the result set returned. The maximum offset is 2000. Only one sobject can be specified when using this parameter.", required: false},
{name:"overallLimit", type:"String", info:"Single value. The starting row offset into the result set returned. The maximum offset is 2000. Only one sobject can be specified when using this parameter.", required: false},
{name:"offset", type:"String", info:"Single value. The starting row offset into the result set returned. The maximum offset is 2000. Only one sobject can be specified when using this parameter.", required: false},
{name:"overallLimit", type:"String", info:"Single value. The maximum number of results to return across all sobject parameters specified.The maximum overallLimit is 2000.", required: false},
{name:"pricebookId", type:"String", info:"Single value. Filters product search results by a price book ID for only the Product2 object. The price book ID must be associated with the product that you’re searching for. For example, ?q=laptop&sobject=product2&pricebookId=01sxx0000002MffAAE", required: false},
{name:"snippet", type:"String", info:"he target length (maximum number of snippet characters) to return in Salesforce Knowledge article, case, case comment, feed, feed comment, idea, and idea comment search results. The snippet parameter displays contextual excerpts and highlights the search term for each article in the search results. Snippet results are used to differentiate matches to the search term in article search results. The target length can be from 50 to 1000 characters.Snippet and highlights are generated from email, text, and text area (long and rich) fields. Snippets aren’t displayed for partially matching searches or if the user doesn’t have access to the field that contains the snippet. Snippets are only displayed when 20 or fewer results are returned on a page.", required: false},
{name:"sobjects", type:"String", info:" Objects to return in the response. Must contain valid object types. Use with the required parameters.", required: false},
{name:"spellCorrection", type:"boolean", info:" FSpecifies whether spell correction is enabled for a user’s search. When set to true, spell correction is enabled for searches that support spell correction. The default value is true.", required: false},
{name:"updateTracking", type:"String", info:"Specifies a value of true to track keywords that are used in Salesforce Knowledge article searches only.If unspecified, the default value of false is applied.", required: false},
{name:"updateViewStat", type:"String", info:"Specifies a value of true to update an article’s view statistics. Valid only for Salesforce Knowledge article searches.If unspecified, the default value of false is applied.", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Get a list of all available custom actions."
},
{
"name":"getProcessApprovals",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Submit a particular record if that entity supports an approval process and one has already been defined. "
},
{
"name":"submitRecordForApproval",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"approvalRequest", type:"String", info:"A JSON object", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Submit a particular record if that entity supports an approval process and one has already been defined. "
},
{
"name":"getAllWorkflowRules",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Returns a list of all active workflow rules."
},
{
"name":"getSingleProcessRule",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"workflowRuleId", type:"String", info:"rule id", required: false},
{name:"sObjectName", type:"String", info:"the SObject required", required: false},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":" Returns a list of all active workflow rules."
},
{
"name":"triggerProcessRules",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"contextIds", type:"String", info:"the required action to return", required: true},
{name:"userId", type:"String", info:"An array of contextIds as a JSON object in the request body", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Trigger process rules. All rules associated with the specified ID will be evaluated, regardless of the evaluation criteria. All IDs must be for records on the same object."
},
{
"name":"query",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"query", type:"String", info:"the query to execute.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Executes the specified SOQL query."
},
{
"name":"explainQuery",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"explain", type:"String", info:"A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query String to get feedback on how Salesforce will process your report or list view", required: true} ],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"For retrieving query performance feedback without executing the query or for retrieving query performance feedback on a report or list view."
},
{
"name":"additionalQueryResults",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"queryId", type:"String", info:"the query id to retrive", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"For retrieving additional query results if the initial results are too large."
},
{
"name":"queryAll",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"query", type:"String", info:"the query to execute.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"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."
},
{
"name":"additionalQueryAll",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"queryId", type:"String", info:"the query id to retrive", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"For retrieving additional query results if the initial results are too large."
},
{
"name":"getQuickActions",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns a list of global actions and object-specific actions."
},
{
"name":"postQuickAction",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"inputs", type:"String", info:"input for action creation", required: true},
{name:"actionName", type:"String", info:"action name", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Invoke a specified quick action."
},
{
"name":"getRecentListViews",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjectType", type:"String", info:"the type of object", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns the list of recently used list views for the given sObject type."
},
{
"name":"getRecentlyViewedItems",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"limit", type:"String", info:"An optional limit that specifies the maximum number of records to be returned. If this parameter is not specified, the default maximum number of records returned is the maximum number of entries in RecentlyViewed, which is 200 records per object.", required: false}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"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."
},
{
"name":"getRecordCount",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"sObjects", type:"String", info:" 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.This parameter is optional. If this parameter is not provided, the resource returns record counts for all objects in the org.", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Lists information about object record counts in your organization."
},
{
"name":"getRelevantItems",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"lastUpdatedId", type:"String", info:"Compares the entire current list of relevant items to a previous version, if available. Specify the lastUpdatedId value returned in a previous response.", required: false},
{name:"sobjects", type:"String", info:"To scope the results to a particular object or set of objects, specify the name for one or more sObjects. Case sensitive.", required: false},
{name:"sobject_lastUpdatedId", type:"String", info:" Compares the current list of relevant items for this particular object to a previous version, if available. Specify the lastUpdatedId value returned in a previous response.", required: false},
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"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."
},
{
"name":"getKnowledgeLanguageSettings",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true}
],
"callbacks":[
{name:"success", info:"Success"},
{name:"error", info:"Error"}
],
"description":"Returns the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information."
},
{
"name":"search",
"args":[
{name:"instance", type:"credentials", info:"the user instance on salesforce.", required: true},
{name:"accessToken", type:"String", info:"Oath acces token", required: true},
{name:"query", type:"String", info:"tA SOSL statement that is properly URL-encoded.", required: true}
],
"callbacks":[