@itentialopensource/adapter-bmc_helix_itsm 0.1.2

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.
Files changed (75) hide show
  1. package/.eslintignore +6 -0
  2. package/.eslintrc.js +18 -0
  3. package/.gitlab/.gitkeep +0 -0
  4. package/.gitlab/issue_templates/.gitkeep +0 -0
  5. package/.gitlab/issue_templates/Default.md +17 -0
  6. package/.gitlab/issue_templates/bugReportTemplate.md +76 -0
  7. package/.gitlab/issue_templates/featureRequestTemplate.md +14 -0
  8. package/.jshintrc +0 -0
  9. package/AUTH.md +39 -0
  10. package/BROKER.md +199 -0
  11. package/CALLS.md +278 -0
  12. package/CHANGELOG.md +16 -0
  13. package/CODE_OF_CONDUCT.md +43 -0
  14. package/CONTRIBUTING.md +172 -0
  15. package/ENHANCE.md +69 -0
  16. package/LICENSE +201 -0
  17. package/PROPERTIES.md +641 -0
  18. package/README.md +337 -0
  19. package/SUMMARY.md +9 -0
  20. package/SYSTEMINFO.md +11 -0
  21. package/TROUBLESHOOT.md +47 -0
  22. package/adapter.js +2381 -0
  23. package/adapterBase.js +1787 -0
  24. package/entities/.generic/action.json +214 -0
  25. package/entities/.generic/schema.json +28 -0
  26. package/entities/.system/action.json +50 -0
  27. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  28. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  29. package/entities/.system/schema.json +19 -0
  30. package/entities/.system/schemaTokenReq.json +53 -0
  31. package/entities/.system/schemaTokenResp.json +53 -0
  32. package/entities/Auth/action.json +44 -0
  33. package/entities/Auth/schema.json +31 -0
  34. package/entities/ChangeRequest/action.json +84 -0
  35. package/entities/ChangeRequest/schema.json +22 -0
  36. package/entities/Entry/action.json +146 -0
  37. package/entities/Entry/schema.json +25 -0
  38. package/entities/Event/action.json +24 -0
  39. package/entities/Event/schema.json +19 -0
  40. package/entities/Incident/action.json +84 -0
  41. package/entities/Incident/schema.json +22 -0
  42. package/error.json +190 -0
  43. package/package.json +89 -0
  44. package/pronghorn.json +1403 -0
  45. package/propertiesDecorators.json +14 -0
  46. package/propertiesSchema.json +1248 -0
  47. package/refs?service=git-upload-pack +0 -0
  48. package/report/adapterInfo.json +10 -0
  49. package/report/creationReport.json +272 -0
  50. package/report/helix-itsm-api.json +425 -0
  51. package/sampleProperties.json +195 -0
  52. package/test/integration/adapterTestBasicGet.js +83 -0
  53. package/test/integration/adapterTestConnectivity.js +93 -0
  54. package/test/integration/adapterTestIntegration.js +577 -0
  55. package/test/unit/adapterBaseTestUnit.js +949 -0
  56. package/test/unit/adapterTestUnit.js +1657 -0
  57. package/utils/adapterInfo.js +206 -0
  58. package/utils/addAuth.js +94 -0
  59. package/utils/artifactize.js +146 -0
  60. package/utils/basicGet.js +50 -0
  61. package/utils/checkMigrate.js +63 -0
  62. package/utils/entitiesToDB.js +178 -0
  63. package/utils/findPath.js +74 -0
  64. package/utils/methodDocumentor.js +225 -0
  65. package/utils/modify.js +154 -0
  66. package/utils/packModificationScript.js +35 -0
  67. package/utils/patches2bundledDeps.js +90 -0
  68. package/utils/pre-commit.sh +32 -0
  69. package/utils/removeHooks.js +20 -0
  70. package/utils/setup.js +33 -0
  71. package/utils/tbScript.js +246 -0
  72. package/utils/tbUtils.js +490 -0
  73. package/utils/testRunner.js +298 -0
  74. package/utils/troubleshootingAdapter.js +195 -0
  75. package/workflows/README.md +3 -0
package/pronghorn.json ADDED
@@ -0,0 +1,1403 @@
1
+ {
2
+ "id": "@itentialopensource/adapter-bmc_helix_itsm",
3
+ "type": "Adapter",
4
+ "export": "BmcHelixItsm",
5
+ "title": "Bmc_helix_itsm",
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
+ "output": {
68
+ "name": "result",
69
+ "type": "object",
70
+ "description": "A JSON Object containing status, code and the result",
71
+ "schema": {
72
+ "title": "result",
73
+ "type": "object"
74
+ }
75
+ },
76
+ "roles": [
77
+ "admin"
78
+ ],
79
+ "route": {
80
+ "verb": "POST",
81
+ "path": "/iapUpdateAdapterConfiguration"
82
+ },
83
+ "task": true
84
+ },
85
+ {
86
+ "name": "iapFindAdapterPath",
87
+ "summary": "Provides the ability to see if a particular API path is supported by the adapter",
88
+ "description": "Provides the ability to see if a particular API path is supported by the adapter",
89
+ "input": [
90
+ {
91
+ "name": "apiPath",
92
+ "type": "string",
93
+ "info": "The API Path you want to check - make sure to not include base path and version",
94
+ "description": "The API Path you want to check - make sure to not include base path and version",
95
+ "schema": {
96
+ "title": "apiPath",
97
+ "type": "string"
98
+ },
99
+ "required": true
100
+ }
101
+ ],
102
+ "output": {
103
+ "name": "result",
104
+ "type": "object",
105
+ "description": "A JSON Object containing the result",
106
+ "schema": {
107
+ "title": "result",
108
+ "type": "object"
109
+ }
110
+ },
111
+ "roles": [
112
+ "admin"
113
+ ],
114
+ "route": {
115
+ "verb": "POST",
116
+ "path": "/iapFindAdapterPath"
117
+ },
118
+ "task": true
119
+ },
120
+ {
121
+ "name": "iapSuspendAdapter",
122
+ "summary": "Suspends the adapter",
123
+ "description": "Suspends the adapter",
124
+ "input": [
125
+ {
126
+ "name": "mode",
127
+ "type": "enum",
128
+ "enumerals": [
129
+ "pause",
130
+ "error"
131
+ ],
132
+ "info": "How incoming requests are handled. Defaults to 'pause'",
133
+ "description": "How incoming requests are handled. Defaults to 'pause'",
134
+ "schema": {
135
+ "title": "mode",
136
+ "type": "string"
137
+ },
138
+ "required": false
139
+ }
140
+ ],
141
+ "output": {
142
+ "name": "result",
143
+ "type": "object",
144
+ "description": "A JSON Object containing the adapter suspended status",
145
+ "schema": {
146
+ "title": "result",
147
+ "type": "object"
148
+ }
149
+ },
150
+ "roles": [
151
+ "admin"
152
+ ],
153
+ "route": {
154
+ "verb": "POST",
155
+ "path": "/iapSuspendAdapter"
156
+ },
157
+ "task": true
158
+ },
159
+ {
160
+ "name": "iapUnsuspendAdapter",
161
+ "summary": "Unsuspends the adapter",
162
+ "description": "Unsuspends the adapter",
163
+ "input": [],
164
+ "output": {
165
+ "name": "result",
166
+ "type": "object",
167
+ "description": "A JSON Object containing the adapter suspended status",
168
+ "schema": {
169
+ "title": "result",
170
+ "type": "object"
171
+ }
172
+ },
173
+ "roles": [
174
+ "admin"
175
+ ],
176
+ "route": {
177
+ "verb": "POST",
178
+ "path": "/iapUnsuspendAdapter"
179
+ },
180
+ "task": true
181
+ },
182
+ {
183
+ "name": "iapGetAdapterQueue",
184
+ "summary": "Return the requests that are waiting in the queue if throttling is enabled",
185
+ "description": "Return the requests that are waiting in the queue if throttling is enabled",
186
+ "input": [],
187
+ "output": {
188
+ "name": "result",
189
+ "type": "object",
190
+ "description": "A JSON Object containing the adapter queue",
191
+ "schema": {
192
+ "title": "result",
193
+ "type": "object"
194
+ }
195
+ },
196
+ "roles": [
197
+ "admin"
198
+ ],
199
+ "route": {
200
+ "verb": "POST",
201
+ "path": "/iapGetAdapterQueue"
202
+ },
203
+ "task": true
204
+ },
205
+ {
206
+ "name": "iapTroubleshootAdapter",
207
+ "summary": "Runs troubleshoot script for adapter",
208
+ "description": "Runs troubleshoot script for adapter",
209
+ "input": [
210
+ {
211
+ "name": "props",
212
+ "type": "object",
213
+ "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'}}",
214
+ "required": true,
215
+ "schema": {
216
+ "title": "props",
217
+ "type": "object"
218
+ }
219
+ },
220
+ {
221
+ "name": "persistFlag",
222
+ "type": "boolean",
223
+ "info": "Whether the input properties should be saved",
224
+ "required": true
225
+ }
226
+ ],
227
+ "output": {
228
+ "name": "result",
229
+ "type": "object",
230
+ "description": "A JSON Object containing the test results",
231
+ "schema": {
232
+ "title": "result",
233
+ "type": "object"
234
+ }
235
+ },
236
+ "roles": [
237
+ "admin"
238
+ ],
239
+ "route": {
240
+ "verb": "POST",
241
+ "path": "/iapTroubleshootAdapter"
242
+ },
243
+ "task": true
244
+ },
245
+ {
246
+ "name": "iapRunAdapterHealthcheck",
247
+ "summary": "Runs healthcheck script for adapter",
248
+ "description": "Runs healthcheck script for adapter",
249
+ "input": [],
250
+ "output": {
251
+ "name": "result",
252
+ "type": "boolean",
253
+ "description": "Whether healthcheck passed or failed"
254
+ },
255
+ "roles": [
256
+ "admin"
257
+ ],
258
+ "route": {
259
+ "verb": "POST",
260
+ "path": "/iapRunAdapterHealthcheck"
261
+ },
262
+ "task": true
263
+ },
264
+ {
265
+ "name": "iapRunAdapterConnectivity",
266
+ "summary": "Runs connectivity check script for adapter",
267
+ "description": "Runs connectivity check script for adapter",
268
+ "input": [],
269
+ "output": {
270
+ "name": "result",
271
+ "type": "object",
272
+ "description": "A JSON Object containing the test results",
273
+ "schema": {
274
+ "title": "result",
275
+ "type": "object"
276
+ }
277
+ },
278
+ "roles": [
279
+ "admin"
280
+ ],
281
+ "route": {
282
+ "verb": "POST",
283
+ "path": "/iapRunAdapterConnectivity"
284
+ },
285
+ "task": true
286
+ },
287
+ {
288
+ "name": "iapRunAdapterBasicGet",
289
+ "summary": "Runs basicGet script for adapter",
290
+ "description": "Runs basicGet script for adapter",
291
+ "input": [],
292
+ "output": {
293
+ "name": "result",
294
+ "type": "object",
295
+ "description": "A JSON Object containing the test results",
296
+ "schema": {
297
+ "title": "result",
298
+ "type": "object"
299
+ }
300
+ },
301
+ "roles": [
302
+ "admin"
303
+ ],
304
+ "route": {
305
+ "verb": "POST",
306
+ "path": "/iapRunAdapterBasicGet"
307
+ },
308
+ "task": true
309
+ },
310
+ {
311
+ "name": "iapMoveAdapterEntitiesToDB",
312
+ "summary": "Moves entities from an adapter into the IAP database",
313
+ "description": "Moves entities from an adapter into the IAP database",
314
+ "input": [],
315
+ "output": {
316
+ "name": "res",
317
+ "type": "object",
318
+ "description": "A JSON Object containing status, code and the response from the mongo transaction",
319
+ "schema": {
320
+ "title": "res",
321
+ "type": "object"
322
+ }
323
+ },
324
+ "roles": [
325
+ "admin"
326
+ ],
327
+ "route": {
328
+ "verb": "POST",
329
+ "path": "/iapMoveAdapterEntitiesToDB"
330
+ },
331
+ "task": true
332
+ },
333
+ {
334
+ "name": "genericAdapterRequest",
335
+ "summary": "Makes the requested generic call",
336
+ "description": "Makes the requested generic call",
337
+ "input": [
338
+ {
339
+ "name": "uriPath",
340
+ "type": "string",
341
+ "info": "the path of the api call - do not include the host, port, base path or version",
342
+ "description": "the path of the api call",
343
+ "schema": {
344
+ "title": "uriPath",
345
+ "type": "string"
346
+ },
347
+ "required": true
348
+ },
349
+ {
350
+ "name": "restMethod",
351
+ "type": "string",
352
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
353
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
354
+ "schema": {
355
+ "title": "restMethod",
356
+ "type": "string"
357
+ },
358
+ "required": true
359
+ },
360
+ {
361
+ "name": "queryData",
362
+ "type": "object",
363
+ "info": "the query parameters to be put on the url (optional)",
364
+ "description": "the query parameters to be put on the url (optional)",
365
+ "schema": {
366
+ "title": "queryData",
367
+ "type": "object"
368
+ },
369
+ "required": false
370
+ },
371
+ {
372
+ "name": "requestBody",
373
+ "type": "object",
374
+ "info": "the payload to be sent with the request (optional)",
375
+ "description": "the payload to be sent with the request (optional)",
376
+ "schema": {
377
+ "title": "requestBody",
378
+ "type": "object"
379
+ },
380
+ "required": false
381
+ },
382
+ {
383
+ "name": "addlHeaders",
384
+ "type": "object",
385
+ "info": "additional headers to be put on the call (optional)",
386
+ "description": "additional headers to be put on the call (optional)",
387
+ "schema": {
388
+ "title": "addlHeaders",
389
+ "type": "object"
390
+ },
391
+ "required": false
392
+ }
393
+ ],
394
+ "output": {
395
+ "name": "result",
396
+ "type": "object",
397
+ "description": "A JSON Object containing status, code and the result",
398
+ "schema": {
399
+ "title": "result",
400
+ "type": "object"
401
+ }
402
+ },
403
+ "roles": [
404
+ "admin"
405
+ ],
406
+ "route": {
407
+ "verb": "POST",
408
+ "path": "/genericAdapterRequest"
409
+ },
410
+ "task": true
411
+ },
412
+ {
413
+ "name": "genericAdapterRequestNoBasePath",
414
+ "summary": "Makes the requested generic call",
415
+ "description": "Makes the requested generic call",
416
+ "input": [
417
+ {
418
+ "name": "uriPath",
419
+ "type": "string",
420
+ "info": "the path of the api call - do not include the host, port, base path or version",
421
+ "description": "the path of the api call",
422
+ "schema": {
423
+ "title": "uriPath",
424
+ "type": "string"
425
+ },
426
+ "required": true
427
+ },
428
+ {
429
+ "name": "restMethod",
430
+ "type": "string",
431
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
432
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
433
+ "schema": {
434
+ "title": "restMethod",
435
+ "type": "string"
436
+ },
437
+ "required": true
438
+ },
439
+ {
440
+ "name": "queryData",
441
+ "type": "object",
442
+ "info": "the query parameters to be put on the url (optional)",
443
+ "description": "the query parameters to be put on the url (optional)",
444
+ "schema": {
445
+ "title": "queryData",
446
+ "type": "object"
447
+ },
448
+ "required": false
449
+ },
450
+ {
451
+ "name": "requestBody",
452
+ "type": "object",
453
+ "info": "the payload to be sent with the request (optional)",
454
+ "description": "the payload to be sent with the request (optional)",
455
+ "schema": {
456
+ "title": "requestBody",
457
+ "type": "object"
458
+ },
459
+ "required": false
460
+ },
461
+ {
462
+ "name": "addlHeaders",
463
+ "type": "object",
464
+ "info": "additional headers to be put on the call (optional)",
465
+ "description": "additional headers to be put on the call (optional)",
466
+ "schema": {
467
+ "title": "addlHeaders",
468
+ "type": "object"
469
+ },
470
+ "required": false
471
+ }
472
+ ],
473
+ "output": {
474
+ "name": "result",
475
+ "type": "object",
476
+ "description": "A JSON Object containing status, code and the result",
477
+ "schema": {
478
+ "title": "result",
479
+ "type": "object"
480
+ }
481
+ },
482
+ "roles": [
483
+ "admin"
484
+ ],
485
+ "route": {
486
+ "verb": "POST",
487
+ "path": "/genericAdapterRequestNoBasePath"
488
+ },
489
+ "task": true
490
+ },
491
+ {
492
+ "name": "getDevice",
493
+ "summary": "Get the Appliance",
494
+ "description": "Get the Appliance",
495
+ "input": [
496
+ {
497
+ "name": "deviceName",
498
+ "type": "string",
499
+ "info": "An Appliance Device Name",
500
+ "required": true,
501
+ "schema": {
502
+ "title": "deviceName",
503
+ "type": "string"
504
+ }
505
+ }
506
+ ],
507
+ "output": {
508
+ "name": "result",
509
+ "type": "object",
510
+ "description": "A JSON Object containing status, code and the result",
511
+ "schema": {
512
+ "title": "result",
513
+ "type": "object"
514
+ }
515
+ },
516
+ "roles": [
517
+ "admin"
518
+ ],
519
+ "route": {
520
+ "verb": "POST",
521
+ "path": "/getDevice"
522
+ },
523
+ "task": true
524
+ },
525
+ {
526
+ "name": "getDevicesFiltered",
527
+ "summary": "Get Appliances that match the filter",
528
+ "description": "Get Appliances that match the filter",
529
+ "input": [
530
+ {
531
+ "name": "options",
532
+ "type": "object",
533
+ "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
534
+ "required": true,
535
+ "schema": {
536
+ "title": "options",
537
+ "type": "object"
538
+ }
539
+ }
540
+ ],
541
+ "output": {
542
+ "name": "result",
543
+ "type": "array",
544
+ "description": "A JSON Object containing status, code and the result",
545
+ "schema": {
546
+ "title": "result",
547
+ "type": "array"
548
+ }
549
+ },
550
+ "roles": [
551
+ "admin"
552
+ ],
553
+ "route": {
554
+ "verb": "POST",
555
+ "path": "/getDevicesFiltered"
556
+ },
557
+ "task": true
558
+ },
559
+ {
560
+ "name": "isAlive",
561
+ "summary": "Checks the status for the provided Appliance",
562
+ "description": "Checks the status for the provided Appliance",
563
+ "input": [
564
+ {
565
+ "name": "deviceName",
566
+ "type": "string",
567
+ "info": "An Appliance Device Name",
568
+ "required": true,
569
+ "schema": {
570
+ "title": "deviceName",
571
+ "type": "string"
572
+ }
573
+ }
574
+ ],
575
+ "output": {
576
+ "name": "result",
577
+ "type": "boolean",
578
+ "description": "A JSON Object containing status, code and the result",
579
+ "schema": {
580
+ "title": "result",
581
+ "type": "boolean"
582
+ }
583
+ },
584
+ "roles": [
585
+ "admin"
586
+ ],
587
+ "route": {
588
+ "verb": "POST",
589
+ "path": "/isAlive"
590
+ },
591
+ "task": true
592
+ },
593
+ {
594
+ "name": "getConfig",
595
+ "summary": "Gets a config for the provided Appliance",
596
+ "description": "Gets a config for the provided Appliance",
597
+ "input": [
598
+ {
599
+ "name": "deviceName",
600
+ "type": "string",
601
+ "info": "An Appliance Device Name",
602
+ "required": true,
603
+ "schema": {
604
+ "title": "deviceName",
605
+ "type": "string"
606
+ }
607
+ },
608
+ {
609
+ "name": "format",
610
+ "type": "string",
611
+ "info": "The format to be returned - this is ignored as we always return json",
612
+ "required": false,
613
+ "schema": {
614
+ "title": "format",
615
+ "type": "string"
616
+ }
617
+ }
618
+ ],
619
+ "output": {
620
+ "name": "result",
621
+ "type": "object",
622
+ "description": "A JSON Object containing status, code and the result",
623
+ "schema": {
624
+ "title": "result",
625
+ "type": "object"
626
+ }
627
+ },
628
+ "roles": [
629
+ "admin"
630
+ ],
631
+ "route": {
632
+ "verb": "POST",
633
+ "path": "/getConfig"
634
+ },
635
+ "task": true
636
+ },
637
+ {
638
+ "name": "iapGetDeviceCount",
639
+ "summary": "Gets a device count from the system",
640
+ "description": "Gets a device count from the system",
641
+ "input": [],
642
+ "output": {
643
+ "name": "result",
644
+ "type": "object",
645
+ "description": "A JSON Object containing status, code and the result",
646
+ "schema": {
647
+ "title": "result",
648
+ "type": "object"
649
+ }
650
+ },
651
+ "roles": [
652
+ "admin"
653
+ ],
654
+ "route": {
655
+ "verb": "POST",
656
+ "path": "/iapGetDeviceCount"
657
+ },
658
+ "task": true
659
+ },
660
+ {
661
+ "name": "createEntry",
662
+ "summary": "Create Entry",
663
+ "description": "Create Entry",
664
+ "input": [
665
+ {
666
+ "name": "formName",
667
+ "type": "string",
668
+ "info": "the form name: string",
669
+ "required": true,
670
+ "schema": {
671
+ "title": "formName",
672
+ "type": "string"
673
+ }
674
+ },
675
+ {
676
+ "name": "query",
677
+ "type": "object",
678
+ "info": "object of query/option data - fields, etc: object",
679
+ "required": false,
680
+ "schema": {
681
+ "title": "query",
682
+ "type": "object"
683
+ }
684
+ },
685
+ {
686
+ "name": "body",
687
+ "type": "object",
688
+ "info": ": object",
689
+ "required": true,
690
+ "schema": {
691
+ "type": "object",
692
+ "definitions": {}
693
+ }
694
+ }
695
+ ],
696
+ "output": {
697
+ "name": "result",
698
+ "type": "object",
699
+ "description": "A JSON Object containing status, code and the result",
700
+ "schema": {
701
+ "title": "result",
702
+ "type": "object"
703
+ }
704
+ },
705
+ "roles": [
706
+ "admin"
707
+ ],
708
+ "route": {
709
+ "verb": "POST",
710
+ "path": "/createEntry"
711
+ },
712
+ "task": true
713
+ },
714
+ {
715
+ "name": "getMultipleEntries",
716
+ "summary": "Get Multiple Entries",
717
+ "description": "Get Multiple Entries",
718
+ "input": [
719
+ {
720
+ "name": "formName",
721
+ "type": "string",
722
+ "info": "the form name: string",
723
+ "required": true,
724
+ "schema": {
725
+ "title": "formName",
726
+ "type": "string"
727
+ }
728
+ },
729
+ {
730
+ "name": "query",
731
+ "type": "object",
732
+ "info": "object of query/option data - fields, sort, limit, offset, etc: object",
733
+ "required": false,
734
+ "schema": {
735
+ "title": "query",
736
+ "type": "object"
737
+ }
738
+ }
739
+ ],
740
+ "output": {
741
+ "name": "result",
742
+ "type": "object",
743
+ "description": "A JSON Object containing status, code and the result",
744
+ "schema": {
745
+ "title": "result",
746
+ "type": "object"
747
+ }
748
+ },
749
+ "roles": [
750
+ "admin"
751
+ ],
752
+ "route": {
753
+ "verb": "POST",
754
+ "path": "/getMultipleEntries"
755
+ },
756
+ "task": true
757
+ },
758
+ {
759
+ "name": "getFormSchemaOptions",
760
+ "summary": "Get Options of Form Schema",
761
+ "description": "Get Options of Form Schema",
762
+ "input": [
763
+ {
764
+ "name": "formName",
765
+ "type": "string",
766
+ "info": "the form name: string",
767
+ "required": true,
768
+ "schema": {
769
+ "title": "formName",
770
+ "type": "string"
771
+ }
772
+ },
773
+ {
774
+ "name": "query",
775
+ "type": "object",
776
+ "info": "object of query/option data - fields, etc: object",
777
+ "required": false,
778
+ "schema": {
779
+ "title": "query",
780
+ "type": "object"
781
+ }
782
+ }
783
+ ],
784
+ "output": {
785
+ "name": "result",
786
+ "type": "object",
787
+ "description": "A JSON Object containing status, code and the result",
788
+ "schema": {
789
+ "title": "result",
790
+ "type": "object"
791
+ }
792
+ },
793
+ "roles": [
794
+ "admin"
795
+ ],
796
+ "route": {
797
+ "verb": "POST",
798
+ "path": "/getFormSchemaOptions"
799
+ },
800
+ "task": true
801
+ },
802
+ {
803
+ "name": "updateEntry",
804
+ "summary": "Update Entry",
805
+ "description": "Update Entry",
806
+ "input": [
807
+ {
808
+ "name": "formName",
809
+ "type": "string",
810
+ "info": "the form name: string",
811
+ "required": true,
812
+ "schema": {
813
+ "title": "formName",
814
+ "type": "string"
815
+ }
816
+ },
817
+ {
818
+ "name": "entryId",
819
+ "type": "string",
820
+ "info": "the entry id: string",
821
+ "required": true,
822
+ "schema": {
823
+ "title": "entryId",
824
+ "type": "string"
825
+ }
826
+ },
827
+ {
828
+ "name": "body",
829
+ "type": "object",
830
+ "info": ": object",
831
+ "required": true,
832
+ "schema": {
833
+ "type": "object",
834
+ "definitions": {}
835
+ }
836
+ }
837
+ ],
838
+ "output": {
839
+ "name": "result",
840
+ "type": "object",
841
+ "description": "A JSON Object containing status, code and the result",
842
+ "schema": {
843
+ "title": "result",
844
+ "type": "object"
845
+ }
846
+ },
847
+ "roles": [
848
+ "admin"
849
+ ],
850
+ "route": {
851
+ "verb": "POST",
852
+ "path": "/updateEntry"
853
+ },
854
+ "task": true
855
+ },
856
+ {
857
+ "name": "getEntryById",
858
+ "summary": "Get Entry",
859
+ "description": "Get Entry",
860
+ "input": [
861
+ {
862
+ "name": "formName",
863
+ "type": "string",
864
+ "info": "the form name: string",
865
+ "required": true,
866
+ "schema": {
867
+ "title": "formName",
868
+ "type": "string"
869
+ }
870
+ },
871
+ {
872
+ "name": "entryId",
873
+ "type": "string",
874
+ "info": "the entry id: string",
875
+ "required": true,
876
+ "schema": {
877
+ "title": "entryId",
878
+ "type": "string"
879
+ }
880
+ },
881
+ {
882
+ "name": "query",
883
+ "type": "object",
884
+ "info": "object of query/option data - fields, etc: object",
885
+ "required": false,
886
+ "schema": {
887
+ "title": "query",
888
+ "type": "object"
889
+ }
890
+ }
891
+ ],
892
+ "output": {
893
+ "name": "result",
894
+ "type": "object",
895
+ "description": "A JSON Object containing status, code and the result",
896
+ "schema": {
897
+ "title": "result",
898
+ "type": "object"
899
+ }
900
+ },
901
+ "roles": [
902
+ "admin"
903
+ ],
904
+ "route": {
905
+ "verb": "POST",
906
+ "path": "/getEntryById"
907
+ },
908
+ "task": true
909
+ },
910
+ {
911
+ "name": "deleteEntryById",
912
+ "summary": "Delete Entry",
913
+ "description": "Delete Entry",
914
+ "input": [
915
+ {
916
+ "name": "formName",
917
+ "type": "string",
918
+ "info": "the form name: string",
919
+ "required": true,
920
+ "schema": {
921
+ "title": "formName",
922
+ "type": "string"
923
+ }
924
+ },
925
+ {
926
+ "name": "entryId",
927
+ "type": "string",
928
+ "info": "the entry id: string",
929
+ "required": true,
930
+ "schema": {
931
+ "title": "entryId",
932
+ "type": "string"
933
+ }
934
+ },
935
+ {
936
+ "name": "options",
937
+ "type": "object",
938
+ "info": "delete options: object",
939
+ "required": false,
940
+ "schema": {
941
+ "title": "options",
942
+ "type": "object"
943
+ }
944
+ }
945
+ ],
946
+ "output": {
947
+ "name": "result",
948
+ "type": "object",
949
+ "description": "A JSON Object containing status, code and the result",
950
+ "schema": {
951
+ "title": "result",
952
+ "type": "object"
953
+ }
954
+ },
955
+ "roles": [
956
+ "admin"
957
+ ],
958
+ "route": {
959
+ "verb": "POST",
960
+ "path": "/deleteEntryById"
961
+ },
962
+ "task": true
963
+ },
964
+ {
965
+ "name": "getEntryFormSchemaOptions",
966
+ "summary": "Get Options of Entry Form Schema",
967
+ "description": "Get Options of Entry Form Schema",
968
+ "input": [
969
+ {
970
+ "name": "formName",
971
+ "type": "string",
972
+ "info": "the form name: string",
973
+ "required": true,
974
+ "schema": {
975
+ "title": "formName",
976
+ "type": "string"
977
+ }
978
+ },
979
+ {
980
+ "name": "entryId",
981
+ "type": "string",
982
+ "info": "the entry id: string",
983
+ "required": true,
984
+ "schema": {
985
+ "title": "entryId",
986
+ "type": "string"
987
+ }
988
+ },
989
+ {
990
+ "name": "query",
991
+ "type": "object",
992
+ "info": "object of query/option data - fields, etc: object",
993
+ "required": false,
994
+ "schema": {
995
+ "title": "query",
996
+ "type": "object"
997
+ }
998
+ }
999
+ ],
1000
+ "output": {
1001
+ "name": "result",
1002
+ "type": "object",
1003
+ "description": "A JSON Object containing status, code and the result",
1004
+ "schema": {
1005
+ "title": "result",
1006
+ "type": "object"
1007
+ }
1008
+ },
1009
+ "roles": [
1010
+ "admin"
1011
+ ],
1012
+ "route": {
1013
+ "verb": "POST",
1014
+ "path": "/getEntryFormSchemaOptions"
1015
+ },
1016
+ "task": true
1017
+ },
1018
+ {
1019
+ "name": "login",
1020
+ "summary": "Login",
1021
+ "description": "Login",
1022
+ "input": [
1023
+ {
1024
+ "name": "bodyFormData",
1025
+ "type": "object",
1026
+ "info": ": object",
1027
+ "required": true,
1028
+ "schema": {
1029
+ "title": "bodyFormData",
1030
+ "type": "object"
1031
+ }
1032
+ }
1033
+ ],
1034
+ "output": {
1035
+ "name": "result",
1036
+ "type": "object",
1037
+ "description": "A JSON Object containing status, code and the result",
1038
+ "schema": {
1039
+ "title": "result",
1040
+ "type": "object"
1041
+ }
1042
+ },
1043
+ "roles": [
1044
+ "admin"
1045
+ ],
1046
+ "route": {
1047
+ "verb": "POST",
1048
+ "path": "/login"
1049
+ },
1050
+ "task": true
1051
+ },
1052
+ {
1053
+ "name": "logout",
1054
+ "summary": "Logout",
1055
+ "description": "Logout",
1056
+ "input": [],
1057
+ "output": {
1058
+ "name": "result",
1059
+ "type": "object",
1060
+ "description": "A JSON Object containing status, code and the result",
1061
+ "schema": {
1062
+ "title": "result",
1063
+ "type": "object"
1064
+ }
1065
+ },
1066
+ "roles": [
1067
+ "admin"
1068
+ ],
1069
+ "route": {
1070
+ "verb": "GET",
1071
+ "path": "/logout"
1072
+ },
1073
+ "task": true
1074
+ },
1075
+ {
1076
+ "name": "processEvent",
1077
+ "summary": "Process Event",
1078
+ "description": "Create or Update Incident, Work Order, CI Association as applicable",
1079
+ "input": [
1080
+ {
1081
+ "name": "values",
1082
+ "type": "object",
1083
+ "info": "Values object to be created with record",
1084
+ "required": true,
1085
+ "schema": {
1086
+ "title": "values",
1087
+ "type": "object"
1088
+ }
1089
+ }
1090
+ ],
1091
+ "output": {
1092
+ "name": "result",
1093
+ "type": "object",
1094
+ "description": "A JSON Object containing Incident Number",
1095
+ "schema": {
1096
+ "title": "result",
1097
+ "type": "object"
1098
+ }
1099
+ },
1100
+ "roles": [
1101
+ "admin"
1102
+ ],
1103
+ "route": {
1104
+ "verb": "POST",
1105
+ "path": "/processEvent"
1106
+ },
1107
+ "task": true
1108
+ },
1109
+ {
1110
+ "name": "createIncident",
1111
+ "summary": "Create Incident",
1112
+ "description": "Create ITSM incident",
1113
+ "input": [
1114
+ {
1115
+ "name": "values",
1116
+ "type": "object",
1117
+ "info": "Values object to be created with record",
1118
+ "required": true,
1119
+ "schema": {
1120
+ "title": "values",
1121
+ "type": "object"
1122
+ }
1123
+ }
1124
+ ],
1125
+ "output": {
1126
+ "name": "result",
1127
+ "type": "object",
1128
+ "description": "A JSON Object containing Incident Number",
1129
+ "schema": {
1130
+ "title": "result",
1131
+ "type": "object"
1132
+ }
1133
+ },
1134
+ "roles": [
1135
+ "admin"
1136
+ ],
1137
+ "route": {
1138
+ "verb": "POST",
1139
+ "path": "/createIncident"
1140
+ },
1141
+ "task": true
1142
+ },
1143
+ {
1144
+ "name": "updateIncident",
1145
+ "summary": "Update Incident",
1146
+ "description": "Update ITSM incident",
1147
+ "input": [
1148
+ {
1149
+ "name": "requestId",
1150
+ "type": "string",
1151
+ "info": "Request Id of Incident",
1152
+ "required": true,
1153
+ "schema": {
1154
+ "title": "incident",
1155
+ "type": "string"
1156
+ }
1157
+ },
1158
+ {
1159
+ "name": "values",
1160
+ "type": "object",
1161
+ "info": "Values object for updating the incident",
1162
+ "required": true,
1163
+ "schema": {
1164
+ "title": "values",
1165
+ "type": "object"
1166
+ }
1167
+ }
1168
+ ],
1169
+ "output": {
1170
+ "name": "result",
1171
+ "type": "object",
1172
+ "description": "A JSON Object containing Incident Number",
1173
+ "schema": {
1174
+ "title": "result",
1175
+ "type": "object"
1176
+ }
1177
+ },
1178
+ "roles": [
1179
+ "admin"
1180
+ ],
1181
+ "route": {
1182
+ "verb": "POST",
1183
+ "path": "/updateIncident"
1184
+ },
1185
+ "task": true
1186
+ },
1187
+ {
1188
+ "name": "getIncident",
1189
+ "summary": "Get Incident",
1190
+ "description": "Get ITSM incident by InstanceId",
1191
+ "input": [
1192
+ {
1193
+ "name": "instanceId",
1194
+ "type": "string",
1195
+ "info": "instanceId returned from the createIncident",
1196
+ "required": true,
1197
+ "schema": {
1198
+ "title": "instanceId",
1199
+ "type": "string"
1200
+ }
1201
+ }
1202
+ ],
1203
+ "output": {
1204
+ "name": "result",
1205
+ "type": "object",
1206
+ "description": "A JSON Object containing Incident details",
1207
+ "schema": {
1208
+ "title": "result",
1209
+ "type": "object"
1210
+ }
1211
+ },
1212
+ "roles": [
1213
+ "admin"
1214
+ ],
1215
+ "route": {
1216
+ "verb": "GET",
1217
+ "path": "/getIncident"
1218
+ },
1219
+ "task": true
1220
+ },
1221
+ {
1222
+ "name": "getIncidents",
1223
+ "summary": "Get Incidents",
1224
+ "description": "Get ITSM incidents",
1225
+ "input": [
1226
+ {
1227
+ "name": "query",
1228
+ "type": "string",
1229
+ "info": "Query string for incidents example: ('InstanceId'=\"AGGG123456\" AND 'Submitter'=\"pbunyon\")",
1230
+ "required": true,
1231
+ "schema": {
1232
+ "title": "query",
1233
+ "type": "string"
1234
+ }
1235
+ }
1236
+ ],
1237
+ "output": {
1238
+ "name": "result",
1239
+ "type": "object",
1240
+ "description": "A JSON Object containing Incident Number",
1241
+ "schema": {
1242
+ "title": "result",
1243
+ "type": "object"
1244
+ }
1245
+ },
1246
+ "roles": [
1247
+ "admin"
1248
+ ],
1249
+ "route": {
1250
+ "verb": "GET",
1251
+ "path": "/getIncidents"
1252
+ },
1253
+ "task": true
1254
+ },
1255
+ {
1256
+ "name": "createChangeRequest",
1257
+ "summary": "Create Change Request",
1258
+ "description": "Create ITSM Change Request",
1259
+ "input": [
1260
+ {
1261
+ "name": "values",
1262
+ "type": "object",
1263
+ "info": "Values object to be created with record",
1264
+ "required": true,
1265
+ "schema": {
1266
+ "title": "values",
1267
+ "type": "object"
1268
+ }
1269
+ }
1270
+ ],
1271
+ "output": {
1272
+ "name": "result",
1273
+ "type": "object",
1274
+ "description": "A JSON Object containing Change Request Number",
1275
+ "schema": {
1276
+ "title": "result",
1277
+ "type": "object"
1278
+ }
1279
+ },
1280
+ "roles": [
1281
+ "admin"
1282
+ ],
1283
+ "route": {
1284
+ "verb": "POST",
1285
+ "path": "/createChangeRequest"
1286
+ },
1287
+ "task": true
1288
+ },
1289
+ {
1290
+ "name": "updateChangeRequest",
1291
+ "summary": "Update Change Request",
1292
+ "description": "Update ITSM Change Request",
1293
+ "input": [
1294
+ {
1295
+ "name": "requestId",
1296
+ "type": "string",
1297
+ "info": "Request Id of Change Request",
1298
+ "required": true,
1299
+ "schema": {
1300
+ "title": "changeRequest",
1301
+ "type": "string"
1302
+ }
1303
+ },
1304
+ {
1305
+ "name": "values",
1306
+ "type": "object",
1307
+ "info": "Values object for updating the Change Request",
1308
+ "required": true,
1309
+ "schema": {
1310
+ "title": "values",
1311
+ "type": "object"
1312
+ }
1313
+ }
1314
+ ],
1315
+ "output": {
1316
+ "name": "result",
1317
+ "type": "object",
1318
+ "description": "A JSON Object containing Change Request Number",
1319
+ "schema": {
1320
+ "title": "result",
1321
+ "type": "object"
1322
+ }
1323
+ },
1324
+ "roles": [
1325
+ "admin"
1326
+ ],
1327
+ "route": {
1328
+ "verb": "POST",
1329
+ "path": "/updateChangeRequest"
1330
+ },
1331
+ "task": true
1332
+ },
1333
+ {
1334
+ "name": "getChangeRequest",
1335
+ "summary": "Get Change Request",
1336
+ "description": "Get ITSM Change Request by InstanceId",
1337
+ "input": [
1338
+ {
1339
+ "name": "instanceId",
1340
+ "type": "string",
1341
+ "info": "instanceId returned from the createChangeRequest",
1342
+ "required": true,
1343
+ "schema": {
1344
+ "title": "instanceId",
1345
+ "type": "string"
1346
+ }
1347
+ }
1348
+ ],
1349
+ "output": {
1350
+ "name": "result",
1351
+ "type": "object",
1352
+ "description": "A JSON Object containing changeRequest details",
1353
+ "schema": {
1354
+ "title": "result",
1355
+ "type": "object"
1356
+ }
1357
+ },
1358
+ "roles": [
1359
+ "admin"
1360
+ ],
1361
+ "route": {
1362
+ "verb": "GET",
1363
+ "path": "/getChangeRequest"
1364
+ },
1365
+ "task": true
1366
+ },
1367
+ {
1368
+ "name": "getChangeRequests",
1369
+ "summary": "Get Change Requests",
1370
+ "description": "Get ITSM Change Requests",
1371
+ "input": [
1372
+ {
1373
+ "name": "query",
1374
+ "type": "string",
1375
+ "info": "Query string for changeRequests example: ('InstanceId'=\"AGGG123456\" AND 'Submitter'=\"pbunyon\")",
1376
+ "required": true,
1377
+ "schema": {
1378
+ "title": "query",
1379
+ "type": "string"
1380
+ }
1381
+ }
1382
+ ],
1383
+ "output": {
1384
+ "name": "result",
1385
+ "type": "object",
1386
+ "description": "A JSON Object containing changeRequest Number",
1387
+ "schema": {
1388
+ "title": "result",
1389
+ "type": "object"
1390
+ }
1391
+ },
1392
+ "roles": [
1393
+ "admin"
1394
+ ],
1395
+ "route": {
1396
+ "verb": "GET",
1397
+ "path": "/getChangeRequests"
1398
+ },
1399
+ "task": true
1400
+ }
1401
+ ],
1402
+ "views": []
1403
+ }