@itentialopensource/adapter-adtran_mosaic_devicemanager 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.
Files changed (69) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/CHANGELOG.md +9 -0
  5. package/CODE_OF_CONDUCT.md +48 -0
  6. package/CONTRIBUTING.md +158 -0
  7. package/ENHANCE.md +69 -0
  8. package/LICENSE +201 -0
  9. package/PROPERTIES.md +247 -0
  10. package/README.md +257 -0
  11. package/SUMMARY.md +9 -0
  12. package/TROUBLESHOOT.md +46 -0
  13. package/adapter.js +9118 -0
  14. package/adapterBase.js +1299 -0
  15. package/entities/.generic/action.json +109 -0
  16. package/entities/.generic/schema.json +23 -0
  17. package/entities/.system/action.json +50 -0
  18. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  19. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  20. package/entities/.system/schema.json +19 -0
  21. package/entities/.system/schemaTokenReq.json +53 -0
  22. package/entities/.system/schemaTokenResp.json +53 -0
  23. package/entities/DeviceAPI/action.json +1030 -0
  24. package/entities/DeviceAPI/mockdatafiles/configureDeviceLoggingLevel-default.json +3 -0
  25. package/entities/DeviceAPI/mockdatafiles/createDeviceAttributes-default.json +3 -0
  26. package/entities/DeviceAPI/mockdatafiles/createDevicePOST-default.json +4 -0
  27. package/entities/DeviceAPI/mockdatafiles/deviceTraceLevel-default.json +3 -0
  28. package/entities/DeviceAPI/mockdatafiles/modifyDeviceAttributes-default.json +3 -0
  29. package/entities/DeviceAPI/mockdatafiles/requestDeviceAttributeRefresh-default.json +4 -0
  30. package/entities/DeviceAPI/schema.json +68 -0
  31. package/entities/SubscriberAPI/action.json +901 -0
  32. package/entities/SubscriberAPI/mockdatafiles/deleteSubscriberAttributes-default.json +6 -0
  33. package/entities/SubscriberAPI/mockdatafiles/getUserRoles-default.json +4 -0
  34. package/entities/SubscriberAPI/mockdatafiles/modifySubscriber-default.json +4 -0
  35. package/entities/SubscriberAPI/mockdatafiles/statisticsForSpecificSubscriber-default.json +5 -0
  36. package/entities/SubscriberAPI/mockdatafiles/statisticsForSubscribers-default.json +3 -0
  37. package/entities/SubscriberAPI/schema.json +73 -0
  38. package/error.json +190 -0
  39. package/package.json +87 -0
  40. package/pronghorn.json +4935 -0
  41. package/propertiesDecorators.json +14 -0
  42. package/propertiesSchema.json +1204 -0
  43. package/refs?service=git-upload-pack +0 -0
  44. package/report/creationReport.json +599 -0
  45. package/report/openapi.json +7211 -0
  46. package/report/updateReport1651531040781.json +114 -0
  47. package/sampleProperties.json +106 -0
  48. package/test/integration/adapterTestBasicGet.js +85 -0
  49. package/test/integration/adapterTestConnectivity.js +93 -0
  50. package/test/integration/adapterTestIntegration.js +3582 -0
  51. package/test/unit/adapterBaseTestUnit.js +942 -0
  52. package/test/unit/adapterTestUnit.js +5053 -0
  53. package/utils/addAuth.js +94 -0
  54. package/utils/artifactize.js +146 -0
  55. package/utils/basicGet.js +50 -0
  56. package/utils/checkMigrate.js +63 -0
  57. package/utils/entitiesToDB.js +224 -0
  58. package/utils/findPath.js +74 -0
  59. package/utils/modify.js +154 -0
  60. package/utils/packModificationScript.js +35 -0
  61. package/utils/patches2bundledDeps.js +90 -0
  62. package/utils/pre-commit.sh +27 -0
  63. package/utils/removeHooks.js +20 -0
  64. package/utils/setup.js +33 -0
  65. package/utils/tbScript.js +169 -0
  66. package/utils/tbUtils.js +464 -0
  67. package/utils/testRunner.js +298 -0
  68. package/utils/troubleshootingAdapter.js +190 -0
  69. package/workflows/README.md +3 -0
package/pronghorn.json ADDED
@@ -0,0 +1,4935 @@
1
+ {
2
+ "id": "@itentialopensource/adapter-adtran_mosaic_devicemanager",
3
+ "type": "Adapter",
4
+ "export": "AdtranMosaicDeviceManager",
5
+ "title": "AdtranMosaicDeviceManager",
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
+ "name": "apiPath",
91
+ "type": "string",
92
+ "info": "The API Path you want to check - make sure to not include base path and version",
93
+ "description": "The API Path you want to check - make sure to not include base path and version",
94
+ "schema": {
95
+ "title": "apiPath",
96
+ "type": "string"
97
+ },
98
+ "required": true
99
+ }],
100
+ "output": {
101
+ "name": "result",
102
+ "type": "object",
103
+ "description": "A JSON Object containing the result",
104
+ "schema": {
105
+ "title": "result",
106
+ "type": "object"
107
+ }
108
+ },
109
+ "roles": [
110
+ "admin"
111
+ ],
112
+ "route": {
113
+ "verb": "POST",
114
+ "path": "/iapFindAdapterPath"
115
+ },
116
+ "task": true
117
+ },
118
+ {
119
+ "name": "iapSuspendAdapter",
120
+ "summary": "Suspends the adapter",
121
+ "description": "Suspends the adapter",
122
+ "input": [{
123
+ "name": "mode",
124
+ "type": "enum",
125
+ "enumerals": ["pause", "error"],
126
+ "info": "How incoming requests are handled. Defaults to 'pause'",
127
+ "description": "How incoming requests are handled. Defaults to 'pause'",
128
+ "schema": {
129
+ "title": "mode",
130
+ "type": "string"
131
+ },
132
+ "required": false
133
+ }],
134
+ "output": {
135
+ "name": "result",
136
+ "type": "object",
137
+ "description": "A JSON Object containing the adapter suspended status",
138
+ "schema": {
139
+ "title": "result",
140
+ "type": "object"
141
+ }
142
+ },
143
+ "roles": [
144
+ "admin"
145
+ ],
146
+ "route": {
147
+ "verb": "POST",
148
+ "path": "/iapSuspendAdapter"
149
+ },
150
+ "task": true
151
+ },
152
+ {
153
+ "name": "iapUnsuspendAdapter",
154
+ "summary": "Unsuspends the adapter",
155
+ "description": "Unsuspends the adapter",
156
+ "input": [],
157
+ "output": {
158
+ "name": "result",
159
+ "type": "object",
160
+ "description": "A JSON Object containing the adapter suspended status",
161
+ "schema": {
162
+ "title": "result",
163
+ "type": "object"
164
+ }
165
+ },
166
+ "roles": [
167
+ "admin"
168
+ ],
169
+ "route": {
170
+ "verb": "POST",
171
+ "path": "/iapUnsuspendAdapter"
172
+ },
173
+ "task": true
174
+ },
175
+ {
176
+ "name": "iapGetAdapterQueue",
177
+ "summary": "Return the requests that are waiting in the queue if throttling is enabled",
178
+ "description": "Return the requests that are waiting in the queue if throttling is enabled",
179
+ "input": [],
180
+ "output": {
181
+ "name": "result",
182
+ "type": "object",
183
+ "description": "A JSON Object containing the adapter queue",
184
+ "schema": {
185
+ "title": "result",
186
+ "type": "object"
187
+ }
188
+ },
189
+ "roles": [
190
+ "admin"
191
+ ],
192
+ "route": {
193
+ "verb": "POST",
194
+ "path": "/iapGetAdapterQueue"
195
+ },
196
+ "task": true
197
+ },
198
+ {
199
+ "name": "iapTroubleshootAdapter",
200
+ "summary": "Runs troubleshoot script for adapter",
201
+ "description": "Runs troubleshoot script for adapter",
202
+ "input": [
203
+ {
204
+ "name": "props",
205
+ "type": "object",
206
+ "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'}}",
207
+ "required": true,
208
+ "schema": {
209
+ "title": "props",
210
+ "type": "object"
211
+ }
212
+ },
213
+ {
214
+ "name": "persistFlag",
215
+ "type": "boolean",
216
+ "info": "Whether the input properties should be saved",
217
+ "required": true
218
+ }
219
+ ],
220
+ "output": {
221
+ "name": "result",
222
+ "type": "object",
223
+ "description": "A JSON Object containing the test results",
224
+ "schema": {
225
+ "title": "result",
226
+ "type": "object"
227
+ }
228
+ },
229
+ "roles": [
230
+ "admin"
231
+ ],
232
+ "route": {
233
+ "verb": "POST",
234
+ "path": "/iapTroubleshootAdapter"
235
+ },
236
+ "task": true
237
+ },
238
+ {
239
+ "name": "iapRunAdapterHealthcheck",
240
+ "summary": "Runs healthcheck script for adapter",
241
+ "description": "Runs healthcheck script for adapter",
242
+ "input": [],
243
+ "output": {
244
+ "name": "result",
245
+ "type": "boolean",
246
+ "description": "Whether healthcheck passed or failed"
247
+ },
248
+ "roles": [
249
+ "admin"
250
+ ],
251
+ "route": {
252
+ "verb": "POST",
253
+ "path": "/iapRunAdapterHealthcheck"
254
+ },
255
+ "task": true
256
+ },
257
+ {
258
+ "name": "iapRunAdapterConnectivity",
259
+ "summary": "Runs connectivity check script for adapter",
260
+ "description": "Runs connectivity check script for adapter",
261
+ "input": [],
262
+ "output": {
263
+ "name": "result",
264
+ "type": "object",
265
+ "description": "A JSON Object containing the test results",
266
+ "schema": {
267
+ "title": "result",
268
+ "type": "object"
269
+ }
270
+ },
271
+ "roles": [
272
+ "admin"
273
+ ],
274
+ "route": {
275
+ "verb": "POST",
276
+ "path": "/iapRunAdapterConnectivity"
277
+ },
278
+ "task": true
279
+ },
280
+ {
281
+ "name": "iapRunAdapterBasicGet",
282
+ "summary": "Runs basicGet script for adapter",
283
+ "description": "Runs basicGet script for adapter",
284
+ "input": [],
285
+ "output": {
286
+ "name": "result",
287
+ "type": "object",
288
+ "description": "A JSON Object containing the test results",
289
+ "schema": {
290
+ "title": "result",
291
+ "type": "object"
292
+ }
293
+ },
294
+ "roles": [
295
+ "admin"
296
+ ],
297
+ "route": {
298
+ "verb": "POST",
299
+ "path": "/iapRunAdapterBasicGet"
300
+ },
301
+ "task": true
302
+ },
303
+ {
304
+ "name": "iapMoveAdapterEntitiesToDB",
305
+ "summary": "Moves entities from an adapter into the IAP database",
306
+ "description": "Moves entities from an adapter into the IAP database",
307
+ "input": [],
308
+ "output": {
309
+ "name": "res",
310
+ "type": "object",
311
+ "description": "A JSON Object containing status, code and the response from the mongo transaction",
312
+ "schema": {
313
+ "title": "res",
314
+ "type": "object"
315
+ }
316
+ },
317
+ "roles": [
318
+ "admin"
319
+ ],
320
+ "route": {
321
+ "verb": "POST",
322
+ "path": "/iapMoveAdapterEntitiesToDB"
323
+ },
324
+ "task": true
325
+ },
326
+ {
327
+ "name": "genericAdapterRequest",
328
+ "summary": "Makes the requested generic call",
329
+ "description": "Makes the requested generic call",
330
+ "input": [
331
+ {
332
+ "name": "uriPath",
333
+ "type": "string",
334
+ "info": "the path of the api call - do not include the host, port, base path or version",
335
+ "description": "the path of the api call",
336
+ "schema": {
337
+ "title": "uriPath",
338
+ "type": "string"
339
+ },
340
+ "required": true
341
+ },
342
+ {
343
+ "name": "restMethod",
344
+ "type": "string",
345
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
346
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
347
+ "schema": {
348
+ "title": "restMethod",
349
+ "type": "string"
350
+ },
351
+ "required": true
352
+ },
353
+ {
354
+ "name": "queryData",
355
+ "type": "object",
356
+ "info": "the query parameters to be put on the url (optional)",
357
+ "description": "the query parameters to be put on the url (optional)",
358
+ "schema": {
359
+ "title": "queryData",
360
+ "type": "object"
361
+ },
362
+ "required": false
363
+ },
364
+ {
365
+ "name": "requestBody",
366
+ "type": "object",
367
+ "info": "the payload to be sent with the request (optional)",
368
+ "description": "the payload to be sent with the request (optional)",
369
+ "schema": {
370
+ "title": "requestBody",
371
+ "type": "object"
372
+ },
373
+ "required": false
374
+ },
375
+ {
376
+ "name": "addlHeaders",
377
+ "type": "object",
378
+ "info": "additional headers to be put on the call (optional)",
379
+ "description": "additional headers to be put on the call (optional)",
380
+ "schema": {
381
+ "title": "addlHeaders",
382
+ "type": "object"
383
+ },
384
+ "required": false
385
+ }
386
+ ],
387
+ "output": {
388
+ "name": "result",
389
+ "type": "object",
390
+ "description": "A JSON Object containing status, code and the result",
391
+ "schema": {
392
+ "title": "result",
393
+ "type": "object"
394
+ }
395
+ },
396
+ "roles": [
397
+ "admin"
398
+ ],
399
+ "route": {
400
+ "verb": "POST",
401
+ "path": "/genericAdapterRequest"
402
+ },
403
+ "task": true
404
+ },
405
+ {
406
+ "name": "getDevice",
407
+ "summary": "Get the Appliance",
408
+ "description": "Get the Appliance",
409
+ "input": [
410
+ {
411
+ "name": "deviceName",
412
+ "type": "string",
413
+ "info": "An Appliance Device Name",
414
+ "required": true,
415
+ "schema": {
416
+ "title": "deviceName",
417
+ "type": "string"
418
+ }
419
+ }
420
+ ],
421
+ "output": {
422
+ "name": "result",
423
+ "type": "object",
424
+ "description": "A JSON Object containing status, code and the result",
425
+ "schema": {
426
+ "title": "result",
427
+ "type": "object"
428
+ }
429
+ },
430
+ "roles": [
431
+ "admin"
432
+ ],
433
+ "route": {
434
+ "verb": "POST",
435
+ "path": "/getDevice"
436
+ },
437
+ "task": false
438
+ },
439
+ {
440
+ "name": "getDevicesFiltered",
441
+ "summary": "Get Appliances that match the filter",
442
+ "description": "Get Appliances that match the filter",
443
+ "input": [
444
+ {
445
+ "name": "options",
446
+ "type": "object",
447
+ "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
448
+ "required": true,
449
+ "schema": {
450
+ "title": "options",
451
+ "type": "object"
452
+ }
453
+ }
454
+ ],
455
+ "output": {
456
+ "name": "result",
457
+ "type": "array",
458
+ "description": "A JSON Object containing status, code and the result",
459
+ "schema": {
460
+ "title": "result",
461
+ "type": "array"
462
+ }
463
+ },
464
+ "roles": [
465
+ "admin"
466
+ ],
467
+ "route": {
468
+ "verb": "POST",
469
+ "path": "/getDevicesFiltered"
470
+ },
471
+ "task": false
472
+ },
473
+ {
474
+ "name": "isAlive",
475
+ "summary": "Checks the status for the provided Appliance",
476
+ "description": "Checks the status for the provided Appliance",
477
+ "input": [
478
+ {
479
+ "name": "deviceName",
480
+ "type": "string",
481
+ "info": "An Appliance Device Name",
482
+ "required": true,
483
+ "schema": {
484
+ "title": "deviceName",
485
+ "type": "string"
486
+ }
487
+ }
488
+ ],
489
+ "output": {
490
+ "name": "result",
491
+ "type": "boolean",
492
+ "description": "A JSON Object containing status, code and the result",
493
+ "schema": {
494
+ "title": "result",
495
+ "type": "boolean"
496
+ }
497
+ },
498
+ "roles": [
499
+ "admin"
500
+ ],
501
+ "route": {
502
+ "verb": "POST",
503
+ "path": "/isAlive"
504
+ },
505
+ "task": false
506
+ },
507
+ {
508
+ "name": "getConfig",
509
+ "summary": "Gets a config for the provided Appliance",
510
+ "description": "Gets a config for the provided Appliance",
511
+ "input": [
512
+ {
513
+ "name": "deviceName",
514
+ "type": "string",
515
+ "info": "An Appliance Device Name",
516
+ "required": true,
517
+ "schema": {
518
+ "title": "deviceName",
519
+ "type": "string"
520
+ }
521
+ },
522
+ {
523
+ "name": "format",
524
+ "type": "string",
525
+ "info": "The format to be returned - this is ignored as we always return json",
526
+ "required": false,
527
+ "schema": {
528
+ "title": "format",
529
+ "type": "string"
530
+ }
531
+ }
532
+ ],
533
+ "output": {
534
+ "name": "result",
535
+ "type": "object",
536
+ "description": "A JSON Object containing status, code and the result",
537
+ "schema": {
538
+ "title": "result",
539
+ "type": "object"
540
+ }
541
+ },
542
+ "roles": [
543
+ "admin"
544
+ ],
545
+ "route": {
546
+ "verb": "POST",
547
+ "path": "/getConfig"
548
+ },
549
+ "task": false
550
+ },
551
+ {
552
+ "name": "iapGetDeviceCount",
553
+ "summary": "Gets a device count from the system",
554
+ "description": "Gets a device count from the system",
555
+ "input": [],
556
+ "output": {
557
+ "name": "result",
558
+ "type": "object",
559
+ "description": "A JSON Object containing status, code and the result",
560
+ "schema": {
561
+ "title": "result",
562
+ "type": "object"
563
+ }
564
+ },
565
+ "roles": [
566
+ "admin"
567
+ ],
568
+ "route": {
569
+ "verb": "POST",
570
+ "path": "/iapGetDeviceCount"
571
+ },
572
+ "task": false
573
+ },
574
+ {
575
+ "name": "updateListOfDevicesConnectedToACS",
576
+ "summary": "Add a new device to the list of devices connected to the ACS",
577
+ "description": "Add a new device to the list of devices connected to the ACS",
578
+ "input": [
579
+ {
580
+ "name": "body",
581
+ "type": "object",
582
+ "info": ": {\"manufacturer\": \"string\", \"oui\": \"string\", \"productClass\": \"string\", \"serial\": \"string\", \"provisioningCode\": \"string\", \"rootName\": \"string\"}",
583
+ "required": true,
584
+ "schema": {
585
+ "properties": {
586
+ "manufacturer": {
587
+ "type": "string"
588
+ },
589
+ "oui": {
590
+ "type": "string"
591
+ },
592
+ "productClass": {
593
+ "type": "string"
594
+ },
595
+ "serial": {
596
+ "type": "string"
597
+ },
598
+ "provisioningCode": {
599
+ "type": "string"
600
+ },
601
+ "rootName": {
602
+ "type": "string"
603
+ }
604
+ },
605
+ "type": "object",
606
+ "required": [
607
+ "manufacturer",
608
+ "oui",
609
+ "productClass",
610
+ "serial",
611
+ "provisioningCode",
612
+ "rootName"
613
+ ]
614
+ }
615
+ }
616
+ ],
617
+ "output": {
618
+ "name": "result",
619
+ "type": "object",
620
+ "description": "A JSON Object containing status, code and the result",
621
+ "schema": {
622
+ "title": "result",
623
+ "type": "object"
624
+ }
625
+ },
626
+ "roles": [
627
+ "admin"
628
+ ],
629
+ "route": {
630
+ "verb": "POST",
631
+ "path": "/updateListOfDevicesConnectedToACS"
632
+ },
633
+ "task": true
634
+ },
635
+ {
636
+ "name": "listOfDeviceTypesDefindedInACS",
637
+ "summary": "Retrieves the list of device types defined in the ACS",
638
+ "description": "Retrieves the list of device types defined in the ACS. A device type consists of a product class and a hardware version, which is used matched against devices checking into the ACS, and other information which is used for informational purposes. Four optional query string parameters may be passed to narrow the results: hardwareVersion, productClass, modelName, oui.",
639
+ "input": [
640
+ {
641
+ "name": "first",
642
+ "type": "number",
643
+ "info": "the first result to return: 123",
644
+ "required": true,
645
+ "schema": {
646
+ "title": "first",
647
+ "type": "number"
648
+ }
649
+ },
650
+ {
651
+ "name": "count",
652
+ "type": "number",
653
+ "info": "the number of results to return: 123",
654
+ "required": true,
655
+ "schema": {
656
+ "title": "count",
657
+ "type": "number"
658
+ }
659
+ }
660
+ ],
661
+ "output": {
662
+ "name": "result",
663
+ "type": "object",
664
+ "description": "A JSON Object containing status, code and the result",
665
+ "schema": {
666
+ "title": "result",
667
+ "type": "object"
668
+ }
669
+ },
670
+ "roles": [
671
+ "admin"
672
+ ],
673
+ "route": {
674
+ "verb": "POST",
675
+ "path": "/listOfDeviceTypesDefindedInACS"
676
+ },
677
+ "task": true
678
+ },
679
+ {
680
+ "name": "createDeviceType",
681
+ "summary": "Add a new device type",
682
+ "description": "Add a new device type",
683
+ "input": [
684
+ {
685
+ "name": "body",
686
+ "type": "object",
687
+ "info": ": {\"friendlyName\": \"string\", \"friendlyManufacturerName\": \"string\", \"hardwareVersion\": \"string\", \"productClass\": \"string\", \"modelName\": \"string\", \"imageURL\": \"string\", \"wanInterfaceType\": \"string\"}",
688
+ "required": true,
689
+ "schema": {
690
+ "properties": {
691
+ "friendlyName": {
692
+ "type": "string"
693
+ },
694
+ "friendlyManufacturerName": {
695
+ "type": "string"
696
+ },
697
+ "hardwareVersion": {
698
+ "type": "string"
699
+ },
700
+ "productClass": {
701
+ "type": "string"
702
+ },
703
+ "modelName": {
704
+ "type": "string"
705
+ },
706
+ "imageURL": {
707
+ "type": "string"
708
+ },
709
+ "wanInterfaceType": {
710
+ "type": "string"
711
+ }
712
+ },
713
+ "type": "object",
714
+ "required": [
715
+ "friendlyName",
716
+ "friendlyManufacturerName",
717
+ "hardwareVersion",
718
+ "productClass",
719
+ "modelName",
720
+ "imageURL",
721
+ "wanInterfaceType"
722
+ ]
723
+ }
724
+ }
725
+ ],
726
+ "output": {
727
+ "name": "result",
728
+ "type": "object",
729
+ "description": "A JSON Object containing status, code and the result",
730
+ "schema": {
731
+ "title": "result",
732
+ "type": "object"
733
+ }
734
+ },
735
+ "roles": [
736
+ "admin"
737
+ ],
738
+ "route": {
739
+ "verb": "POST",
740
+ "path": "/createDeviceType"
741
+ },
742
+ "task": true
743
+ },
744
+ {
745
+ "name": "listOfDeviceTypesCheckingInToACS",
746
+ "summary": "Retrieves the list of device types defined in the ACS",
747
+ "description": "Retrieves a list of a single device type that are checking into the ACS. A device type consists of a product class and a hardware version.",
748
+ "input": [
749
+ {
750
+ "name": "deviceTypeId",
751
+ "type": "string",
752
+ "info": "device type identity: string",
753
+ "required": true,
754
+ "schema": {
755
+ "title": "deviceTypeId",
756
+ "type": "string"
757
+ }
758
+ }
759
+ ],
760
+ "output": {
761
+ "name": "result",
762
+ "type": "object",
763
+ "description": "A JSON Object containing status, code and the result",
764
+ "schema": {
765
+ "title": "result",
766
+ "type": "object"
767
+ }
768
+ },
769
+ "roles": [
770
+ "admin"
771
+ ],
772
+ "route": {
773
+ "verb": "POST",
774
+ "path": "/listOfDeviceTypesCheckingInToACS"
775
+ },
776
+ "task": true
777
+ },
778
+ {
779
+ "name": "modifyDeviceType",
780
+ "summary": "Updates a single device type",
781
+ "description": "Updates a single device type",
782
+ "input": [
783
+ {
784
+ "name": "deviceTypeId",
785
+ "type": "string",
786
+ "info": "device type identity: string",
787
+ "required": true,
788
+ "schema": {
789
+ "title": "deviceTypeId",
790
+ "type": "string"
791
+ }
792
+ },
793
+ {
794
+ "name": "body",
795
+ "type": "object",
796
+ "info": ": {\"friendlyName\": \"string\", \"friendlyManufacturerName\": \"string\", \"hardwareVersion\": \"string\", \"productClass\": \"string\", \"modelName\": \"string\", \"imageURL\": \"string\", \"wanInterfaceType\": \"string\"}",
797
+ "required": true,
798
+ "schema": {
799
+ "properties": {
800
+ "friendlyName": {
801
+ "type": "string"
802
+ },
803
+ "friendlyManufacturerName": {
804
+ "type": "string"
805
+ },
806
+ "hardwareVersion": {
807
+ "type": "string"
808
+ },
809
+ "productClass": {
810
+ "type": "string"
811
+ },
812
+ "modelName": {
813
+ "type": "string"
814
+ },
815
+ "imageURL": {
816
+ "type": "string"
817
+ },
818
+ "wanInterfaceType": {
819
+ "type": "string"
820
+ }
821
+ },
822
+ "type": "object",
823
+ "required": [
824
+ "friendlyName",
825
+ "friendlyManufacturerName",
826
+ "hardwareVersion",
827
+ "productClass",
828
+ "modelName",
829
+ "imageURL",
830
+ "wanInterfaceType"
831
+ ]
832
+ }
833
+ }
834
+ ],
835
+ "output": {
836
+ "name": "result",
837
+ "type": "object",
838
+ "description": "A JSON Object containing status, code and the result",
839
+ "schema": {
840
+ "title": "result",
841
+ "type": "object"
842
+ }
843
+ },
844
+ "roles": [
845
+ "admin"
846
+ ],
847
+ "route": {
848
+ "verb": "POST",
849
+ "path": "/modifyDeviceType"
850
+ },
851
+ "task": true
852
+ },
853
+ {
854
+ "name": "removeDeviceType",
855
+ "summary": "Remove Device Type",
856
+ "description": "Remove Device Type",
857
+ "input": [
858
+ {
859
+ "name": "deviceTypeId",
860
+ "type": "string",
861
+ "info": "device type identity: string",
862
+ "required": true,
863
+ "schema": {
864
+ "title": "deviceTypeId",
865
+ "type": "string"
866
+ }
867
+ }
868
+ ],
869
+ "output": {
870
+ "name": "result",
871
+ "type": "object",
872
+ "description": "A JSON Object containing status, code and the result",
873
+ "schema": {
874
+ "title": "result",
875
+ "type": "object"
876
+ }
877
+ },
878
+ "roles": [
879
+ "admin"
880
+ ],
881
+ "route": {
882
+ "verb": "POST",
883
+ "path": "/removeDeviceType"
884
+ },
885
+ "task": true
886
+ },
887
+ {
888
+ "name": "deviceStatisticsByManufacturer",
889
+ "summary": "Retrieves the counts of different devices by manufacturer",
890
+ "description": "Retrieves the counts of different devices by manufacturer",
891
+ "input": [],
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": "GET",
906
+ "path": "/deviceStatisticsByManufacturer"
907
+ },
908
+ "task": true
909
+ },
910
+ {
911
+ "name": "countsOfDeviceClassesByManufacturer",
912
+ "summary": "Retrieves the counts of different device product classes by manufacturer",
913
+ "description": "Retrieves the counts of different device product classes by manufacturer",
914
+ "input": [
915
+ {
916
+ "name": "manufacturer",
917
+ "type": "string",
918
+ "info": "manufacturer: string",
919
+ "required": true,
920
+ "schema": {
921
+ "title": "manufacturer",
922
+ "type": "string"
923
+ }
924
+ }
925
+ ],
926
+ "output": {
927
+ "name": "result",
928
+ "type": "object",
929
+ "description": "A JSON Object containing status, code and the result",
930
+ "schema": {
931
+ "title": "result",
932
+ "type": "object"
933
+ }
934
+ },
935
+ "roles": [
936
+ "admin"
937
+ ],
938
+ "route": {
939
+ "verb": "POST",
940
+ "path": "/countsOfDeviceClassesByManufacturer"
941
+ },
942
+ "task": true
943
+ },
944
+ {
945
+ "name": "dailyDeviceCountsFor7Days",
946
+ "summary": "Retrieves the number of new devices seen each day, over the last 7 days",
947
+ "description": "Retrieves the number of new devices seen each day, over the last 7 days",
948
+ "input": [],
949
+ "output": {
950
+ "name": "result",
951
+ "type": "object",
952
+ "description": "A JSON Object containing status, code and the result",
953
+ "schema": {
954
+ "title": "result",
955
+ "type": "object"
956
+ }
957
+ },
958
+ "roles": [
959
+ "admin"
960
+ ],
961
+ "route": {
962
+ "verb": "GET",
963
+ "path": "/dailyDeviceCountsFor7Days"
964
+ },
965
+ "task": true
966
+ },
967
+ {
968
+ "name": "countOfDevicesCheckedInFor7Days",
969
+ "summary": "Retrieves the number of devices that have checked in each day, over the last 7 days",
970
+ "description": "Retrieves the number of devices that have checked in each day, over the last 7 days",
971
+ "input": [],
972
+ "output": {
973
+ "name": "result",
974
+ "type": "object",
975
+ "description": "A JSON Object containing status, code and the result",
976
+ "schema": {
977
+ "title": "result",
978
+ "type": "object"
979
+ }
980
+ },
981
+ "roles": [
982
+ "admin"
983
+ ],
984
+ "route": {
985
+ "verb": "GET",
986
+ "path": "/countOfDevicesCheckedInFor7Days"
987
+ },
988
+ "task": true
989
+ },
990
+ {
991
+ "name": "countOfDevicesByDeviceType",
992
+ "summary": "Retrieves the number of devices by device type, ordered descending by count",
993
+ "description": "Retrieves the number of devices by device type, ordered descending by count",
994
+ "input": [
995
+ {
996
+ "name": "first",
997
+ "type": "number",
998
+ "info": "the first result to return: 123",
999
+ "required": true,
1000
+ "schema": {
1001
+ "title": "first",
1002
+ "type": "number"
1003
+ }
1004
+ },
1005
+ {
1006
+ "name": "count",
1007
+ "type": "number",
1008
+ "info": "the number of results to return: 123",
1009
+ "required": true,
1010
+ "schema": {
1011
+ "title": "count",
1012
+ "type": "number"
1013
+ }
1014
+ },
1015
+ {
1016
+ "name": "days",
1017
+ "type": "number",
1018
+ "info": "only count devices that have informed within these last n days: 123",
1019
+ "required": true,
1020
+ "schema": {
1021
+ "title": "days",
1022
+ "type": "number"
1023
+ }
1024
+ }
1025
+ ],
1026
+ "output": {
1027
+ "name": "result",
1028
+ "type": "object",
1029
+ "description": "A JSON Object containing status, code and the result",
1030
+ "schema": {
1031
+ "title": "result",
1032
+ "type": "object"
1033
+ }
1034
+ },
1035
+ "roles": [
1036
+ "admin"
1037
+ ],
1038
+ "route": {
1039
+ "verb": "POST",
1040
+ "path": "/countOfDevicesByDeviceType"
1041
+ },
1042
+ "task": true
1043
+ },
1044
+ {
1045
+ "name": "countOfSubscribersByLabel",
1046
+ "summary": "Retrieves the number of subscribers by label, ordered descending by count",
1047
+ "description": "Retrieves the number of subscribers by label, ordered descending by count",
1048
+ "input": [
1049
+ {
1050
+ "name": "first",
1051
+ "type": "number",
1052
+ "info": "the first result to return: 123",
1053
+ "required": true,
1054
+ "schema": {
1055
+ "title": "first",
1056
+ "type": "number"
1057
+ }
1058
+ },
1059
+ {
1060
+ "name": "count",
1061
+ "type": "number",
1062
+ "info": "the number of results to return: 123",
1063
+ "required": true,
1064
+ "schema": {
1065
+ "title": "count",
1066
+ "type": "number"
1067
+ }
1068
+ }
1069
+ ],
1070
+ "output": {
1071
+ "name": "result",
1072
+ "type": "object",
1073
+ "description": "A JSON Object containing status, code and the result",
1074
+ "schema": {
1075
+ "title": "result",
1076
+ "type": "object"
1077
+ }
1078
+ },
1079
+ "roles": [
1080
+ "admin"
1081
+ ],
1082
+ "route": {
1083
+ "verb": "POST",
1084
+ "path": "/countOfSubscribersByLabel"
1085
+ },
1086
+ "task": true
1087
+ },
1088
+ {
1089
+ "name": "deviceSolicitStatus",
1090
+ "summary": "Gets the solicit status",
1091
+ "description": "Gets the solicit status",
1092
+ "input": [
1093
+ {
1094
+ "name": "deviceIds",
1095
+ "type": "string",
1096
+ "info": "A comma separated list of device ids to retrieve. Default returns all devices.: string",
1097
+ "required": true,
1098
+ "schema": {
1099
+ "title": "deviceIds",
1100
+ "type": "string"
1101
+ }
1102
+ }
1103
+ ],
1104
+ "output": {
1105
+ "name": "result",
1106
+ "type": "object",
1107
+ "description": "A JSON Object containing status, code and the result",
1108
+ "schema": {
1109
+ "title": "result",
1110
+ "type": "object"
1111
+ }
1112
+ },
1113
+ "roles": [
1114
+ "admin"
1115
+ ],
1116
+ "route": {
1117
+ "verb": "POST",
1118
+ "path": "/deviceSolicitStatus"
1119
+ },
1120
+ "task": true
1121
+ },
1122
+ {
1123
+ "name": "updateDeviceStatus",
1124
+ "summary": "Queues devices to update their status",
1125
+ "description": "Queues devices to update their status and causes and scheduled scripts to be run against the device. Passed data is an array of objects, each must contain ID and lastStatus. The value for lastStatus will be populated in the return value. When querying for related status, lastStatus will contain a value greater or equal to this value to indicate that the requested solicit has been completed",
1126
+ "input": [
1127
+ {
1128
+ "name": "deviceId",
1129
+ "type": "number",
1130
+ "info": "device id: 123",
1131
+ "required": true,
1132
+ "schema": {
1133
+ "title": "deviceId",
1134
+ "type": "number"
1135
+ }
1136
+ },
1137
+ {
1138
+ "name": "body",
1139
+ "type": "array",
1140
+ "info": ": array",
1141
+ "required": true,
1142
+ "schema": {
1143
+ "items": {
1144
+ "properties": {
1145
+ "id": {
1146
+ "type": "number"
1147
+ }
1148
+ },
1149
+ "type": "object"
1150
+ },
1151
+ "type": "array"
1152
+ }
1153
+ }
1154
+ ],
1155
+ "output": {
1156
+ "name": "result",
1157
+ "type": "object",
1158
+ "description": "A JSON Object containing status, code and the result",
1159
+ "schema": {
1160
+ "title": "result",
1161
+ "type": "object"
1162
+ }
1163
+ },
1164
+ "roles": [
1165
+ "admin"
1166
+ ],
1167
+ "route": {
1168
+ "verb": "POST",
1169
+ "path": "/updateDeviceStatus"
1170
+ },
1171
+ "task": true
1172
+ },
1173
+ {
1174
+ "name": "firmwareResourceListByDeviceType",
1175
+ "summary": "List the firmware",
1176
+ "description": "List the firmware compatible with the specified device type, ordered by release date. Prior version IDs refer to other firmware instances that this firmware may replace without losing settings.",
1177
+ "input": [
1178
+ {
1179
+ "name": "deviceTypeId",
1180
+ "type": "number",
1181
+ "info": "device type id: 123",
1182
+ "required": true,
1183
+ "schema": {
1184
+ "title": "deviceTypeId",
1185
+ "type": "number"
1186
+ }
1187
+ },
1188
+ {
1189
+ "name": "first",
1190
+ "type": "number",
1191
+ "info": "the first result to return: 123",
1192
+ "required": true,
1193
+ "schema": {
1194
+ "title": "first",
1195
+ "type": "number"
1196
+ }
1197
+ },
1198
+ {
1199
+ "name": "count",
1200
+ "type": "number",
1201
+ "info": "the number of results to return: 123",
1202
+ "required": true,
1203
+ "schema": {
1204
+ "title": "count",
1205
+ "type": "number"
1206
+ }
1207
+ },
1208
+ {
1209
+ "name": "deviceType",
1210
+ "type": "number",
1211
+ "info": "filter by deviceTypeId: 123",
1212
+ "required": true,
1213
+ "schema": {
1214
+ "title": "deviceType",
1215
+ "type": "number"
1216
+ }
1217
+ }
1218
+ ],
1219
+ "output": {
1220
+ "name": "result",
1221
+ "type": "object",
1222
+ "description": "A JSON Object containing status, code and the result",
1223
+ "schema": {
1224
+ "title": "result",
1225
+ "type": "object"
1226
+ }
1227
+ },
1228
+ "roles": [
1229
+ "admin"
1230
+ ],
1231
+ "route": {
1232
+ "verb": "POST",
1233
+ "path": "/firmwareResourceListByDeviceType"
1234
+ },
1235
+ "task": true
1236
+ },
1237
+ {
1238
+ "name": "addFirmwareResourceByDeviceType",
1239
+ "summary": "Add new firmware to all devices of the specified type",
1240
+ "description": "Add new firmware to all devices of the specified type",
1241
+ "input": [
1242
+ {
1243
+ "name": "deviceTypeId",
1244
+ "type": "number",
1245
+ "info": "device type id: 123",
1246
+ "required": true,
1247
+ "schema": {
1248
+ "title": "deviceTypeId",
1249
+ "type": "number"
1250
+ }
1251
+ },
1252
+ {
1253
+ "name": "body",
1254
+ "type": "object",
1255
+ "info": ": {\"softwareVersion\": \"string\", \"binaryURL\": \"string\", \"releaseDate\": \"string\"}",
1256
+ "required": true,
1257
+ "schema": {
1258
+ "properties": {
1259
+ "softwareVersion": {
1260
+ "type": "string"
1261
+ },
1262
+ "binaryURL": {
1263
+ "type": "string"
1264
+ },
1265
+ "releaseDate": {
1266
+ "type": "string"
1267
+ }
1268
+ },
1269
+ "type": "object"
1270
+ }
1271
+ }
1272
+ ],
1273
+ "output": {
1274
+ "name": "result",
1275
+ "type": "object",
1276
+ "description": "A JSON Object containing status, code and the result",
1277
+ "schema": {
1278
+ "title": "result",
1279
+ "type": "object"
1280
+ }
1281
+ },
1282
+ "roles": [
1283
+ "admin"
1284
+ ],
1285
+ "route": {
1286
+ "verb": "POST",
1287
+ "path": "/addFirmwareResourceByDeviceType"
1288
+ },
1289
+ "task": true
1290
+ },
1291
+ {
1292
+ "name": "firmwareDescription",
1293
+ "summary": "Retrieves a single firmware description",
1294
+ "description": "Retrieves a single firmware description for the specified device type. The description consists of information such as its upgrade path and the publicly accessible URL where the firmware's image resides",
1295
+ "input": [
1296
+ {
1297
+ "name": "deviceTypeId",
1298
+ "type": "number",
1299
+ "info": "device type id: 123",
1300
+ "required": true,
1301
+ "schema": {
1302
+ "title": "deviceTypeId",
1303
+ "type": "number"
1304
+ }
1305
+ },
1306
+ {
1307
+ "name": "firmwareId",
1308
+ "type": "number",
1309
+ "info": "firmware id: 123",
1310
+ "required": true,
1311
+ "schema": {
1312
+ "title": "firmwareId",
1313
+ "type": "number"
1314
+ }
1315
+ }
1316
+ ],
1317
+ "output": {
1318
+ "name": "result",
1319
+ "type": "object",
1320
+ "description": "A JSON Object containing status, code and the result",
1321
+ "schema": {
1322
+ "title": "result",
1323
+ "type": "object"
1324
+ }
1325
+ },
1326
+ "roles": [
1327
+ "admin"
1328
+ ],
1329
+ "route": {
1330
+ "verb": "POST",
1331
+ "path": "/firmwareDescription"
1332
+ },
1333
+ "task": true
1334
+ },
1335
+ {
1336
+ "name": "removeFirmwareDescription",
1337
+ "summary": "Removes a single firmware description",
1338
+ "description": "Removes a single firmware description",
1339
+ "input": [
1340
+ {
1341
+ "name": "deviceTypeId",
1342
+ "type": "number",
1343
+ "info": "device type id: 123",
1344
+ "required": true,
1345
+ "schema": {
1346
+ "title": "deviceTypeId",
1347
+ "type": "number"
1348
+ }
1349
+ },
1350
+ {
1351
+ "name": "firmwareId",
1352
+ "type": "number",
1353
+ "info": "firmware id: 123",
1354
+ "required": true,
1355
+ "schema": {
1356
+ "title": "firmwareId",
1357
+ "type": "number"
1358
+ }
1359
+ }
1360
+ ],
1361
+ "output": {
1362
+ "name": "result",
1363
+ "type": "object",
1364
+ "description": "A JSON Object containing status, code and the result",
1365
+ "schema": {
1366
+ "title": "result",
1367
+ "type": "object"
1368
+ }
1369
+ },
1370
+ "roles": [
1371
+ "admin"
1372
+ ],
1373
+ "route": {
1374
+ "verb": "POST",
1375
+ "path": "/removeFirmwareDescription"
1376
+ },
1377
+ "task": true
1378
+ },
1379
+ {
1380
+ "name": "modifyFirmwareDescription",
1381
+ "summary": "Updates a single firmware description",
1382
+ "description": "While it is possible to change the device type ID, a subsequent update to the same URL will result in a 404 error because the URL also includes the deviceTypeId",
1383
+ "input": [
1384
+ {
1385
+ "name": "deviceTypeId",
1386
+ "type": "number",
1387
+ "info": "device type id: 123",
1388
+ "required": true,
1389
+ "schema": {
1390
+ "title": "deviceTypeId",
1391
+ "type": "number"
1392
+ }
1393
+ },
1394
+ {
1395
+ "name": "firmwareId",
1396
+ "type": "number",
1397
+ "info": "firmware id: 123",
1398
+ "required": true,
1399
+ "schema": {
1400
+ "title": "firmwareId",
1401
+ "type": "number"
1402
+ }
1403
+ },
1404
+ {
1405
+ "name": "body",
1406
+ "type": "object",
1407
+ "info": ": {\"deviceTypeId\": 123, \"softwareVersion\": \"string\", \"binaryURL\": \"string\", \"releaseDate\": \"string\"}",
1408
+ "required": true,
1409
+ "schema": {
1410
+ "properties": {
1411
+ "deviceTypeId": {
1412
+ "type": "number"
1413
+ },
1414
+ "softwareVersion": {
1415
+ "type": "string"
1416
+ },
1417
+ "binaryURL": {
1418
+ "type": "string"
1419
+ },
1420
+ "releaseDate": {
1421
+ "type": "string"
1422
+ }
1423
+ },
1424
+ "type": "object"
1425
+ }
1426
+ }
1427
+ ],
1428
+ "output": {
1429
+ "name": "result",
1430
+ "type": "object",
1431
+ "description": "A JSON Object containing status, code and the result",
1432
+ "schema": {
1433
+ "title": "result",
1434
+ "type": "object"
1435
+ }
1436
+ },
1437
+ "roles": [
1438
+ "admin"
1439
+ ],
1440
+ "route": {
1441
+ "verb": "POST",
1442
+ "path": "/modifyFirmwareDescription"
1443
+ },
1444
+ "task": true
1445
+ },
1446
+ {
1447
+ "name": "firmwareResourceLabelsByIDForDeviceType",
1448
+ "summary": "Retrieves the labels associated to the firmware resource",
1449
+ "description": "Retrieves the labels associated to the firmware resource specified by the device type and the firmware resource ID",
1450
+ "input": [
1451
+ {
1452
+ "name": "deviceTypeId",
1453
+ "type": "number",
1454
+ "info": "device type id: 123",
1455
+ "required": true,
1456
+ "schema": {
1457
+ "title": "deviceTypeId",
1458
+ "type": "number"
1459
+ }
1460
+ },
1461
+ {
1462
+ "name": "firmwareId",
1463
+ "type": "number",
1464
+ "info": "firmware id: 123",
1465
+ "required": true,
1466
+ "schema": {
1467
+ "title": "firmwareId",
1468
+ "type": "number"
1469
+ }
1470
+ }
1471
+ ],
1472
+ "output": {
1473
+ "name": "result",
1474
+ "type": "object",
1475
+ "description": "A JSON Object containing status, code and the result",
1476
+ "schema": {
1477
+ "title": "result",
1478
+ "type": "object"
1479
+ }
1480
+ },
1481
+ "roles": [
1482
+ "admin"
1483
+ ],
1484
+ "route": {
1485
+ "verb": "POST",
1486
+ "path": "/firmwareResourceLabelsByIDForDeviceType"
1487
+ },
1488
+ "task": true
1489
+ },
1490
+ {
1491
+ "name": "modifyFirmwareLabels",
1492
+ "summary": "Updates the labels for a firmware",
1493
+ "description": "Updates the labels for a firmware",
1494
+ "input": [
1495
+ {
1496
+ "name": "deviceTypeId",
1497
+ "type": "number",
1498
+ "info": "device type id: 123",
1499
+ "required": true,
1500
+ "schema": {
1501
+ "title": "deviceTypeId",
1502
+ "type": "number"
1503
+ }
1504
+ },
1505
+ {
1506
+ "name": "firmwareId",
1507
+ "type": "number",
1508
+ "info": "firmware id: 123",
1509
+ "required": true,
1510
+ "schema": {
1511
+ "title": "firmwareId",
1512
+ "type": "number"
1513
+ }
1514
+ },
1515
+ {
1516
+ "name": "body",
1517
+ "type": "array",
1518
+ "info": ": array",
1519
+ "required": true,
1520
+ "schema": {
1521
+ "items": {
1522
+ "type": "string"
1523
+ },
1524
+ "type": "array"
1525
+ }
1526
+ }
1527
+ ],
1528
+ "output": {
1529
+ "name": "result",
1530
+ "type": "object",
1531
+ "description": "A JSON Object containing status, code and the result",
1532
+ "schema": {
1533
+ "title": "result",
1534
+ "type": "object"
1535
+ }
1536
+ },
1537
+ "roles": [
1538
+ "admin"
1539
+ ],
1540
+ "route": {
1541
+ "verb": "POST",
1542
+ "path": "/modifyFirmwareLabels"
1543
+ },
1544
+ "task": true
1545
+ },
1546
+ {
1547
+ "name": "countOfDevicesInACSByDeviceType",
1548
+ "summary": "Retrieves a count of the devices are in the system, broken out by device type",
1549
+ "description": "Retrieves a count of the devices are in the system, broken out by device type",
1550
+ "input": [],
1551
+ "output": {
1552
+ "name": "result",
1553
+ "type": "object",
1554
+ "description": "A JSON Object containing status, code and the result",
1555
+ "schema": {
1556
+ "title": "result",
1557
+ "type": "object"
1558
+ }
1559
+ },
1560
+ "roles": [
1561
+ "admin"
1562
+ ],
1563
+ "route": {
1564
+ "verb": "GET",
1565
+ "path": "/countOfDevicesInACSByDeviceType"
1566
+ },
1567
+ "task": true
1568
+ },
1569
+ {
1570
+ "name": "deviceDetailsGET",
1571
+ "summary": "Gets basic device information for a device including its identification, inform information and dev",
1572
+ "description": "Gets basic device information for a device including its identification, inform information and device type",
1573
+ "input": [
1574
+ {
1575
+ "name": "id",
1576
+ "type": "number",
1577
+ "info": "device id: 123",
1578
+ "required": true,
1579
+ "schema": {
1580
+ "title": "id",
1581
+ "type": "number"
1582
+ }
1583
+ }
1584
+ ],
1585
+ "output": {
1586
+ "name": "result",
1587
+ "type": "object",
1588
+ "description": "A JSON Object containing status, code and the result",
1589
+ "schema": {
1590
+ "title": "result",
1591
+ "type": "object"
1592
+ }
1593
+ },
1594
+ "roles": [
1595
+ "admin"
1596
+ ],
1597
+ "route": {
1598
+ "verb": "POST",
1599
+ "path": "/deviceDetailsGET"
1600
+ },
1601
+ "task": true
1602
+ },
1603
+ {
1604
+ "name": "getDeviceTemplate",
1605
+ "summary": "Get empty JSON template to populate for creating a device",
1606
+ "description": "Get empty JSON template to populate for creating a device",
1607
+ "input": [],
1608
+ "output": {
1609
+ "name": "result",
1610
+ "type": "object",
1611
+ "description": "A JSON Object containing status, code and the result",
1612
+ "schema": {
1613
+ "title": "result",
1614
+ "type": "object"
1615
+ }
1616
+ },
1617
+ "roles": [
1618
+ "admin"
1619
+ ],
1620
+ "route": {
1621
+ "verb": "GET",
1622
+ "path": "/getDeviceTemplate"
1623
+ },
1624
+ "task": true
1625
+ },
1626
+ {
1627
+ "name": "createDevicePOST",
1628
+ "summary": "Creates a new future device",
1629
+ "description": "Creates a new future device",
1630
+ "input": [
1631
+ {
1632
+ "name": "body",
1633
+ "type": "object",
1634
+ "info": ": {\"sn\": \"string\", \"oui\": \"string\"}",
1635
+ "required": true,
1636
+ "schema": {
1637
+ "type": "object",
1638
+ "properties": {
1639
+ "sn": {
1640
+ "type": "string"
1641
+ },
1642
+ "oui": {
1643
+ "type": "string"
1644
+ }
1645
+ }
1646
+ }
1647
+ }
1648
+ ],
1649
+ "output": {
1650
+ "name": "result",
1651
+ "type": "object",
1652
+ "description": "A JSON Object containing status, code and the result",
1653
+ "schema": {
1654
+ "type": "object",
1655
+ "properties": {
1656
+ "deviceId": {
1657
+ "type": "string"
1658
+ },
1659
+ "disposition": {
1660
+ "type": "string"
1661
+ }
1662
+ }
1663
+ }
1664
+ },
1665
+ "roles": [
1666
+ "admin"
1667
+ ],
1668
+ "route": {
1669
+ "verb": "POST",
1670
+ "path": "/createDevicePOST"
1671
+ },
1672
+ "task": true
1673
+ },
1674
+ {
1675
+ "name": "deleteDevice",
1676
+ "summary": "Delete the device",
1677
+ "description": "Delete the device. This will fail if there is an associated subscriber",
1678
+ "input": [
1679
+ {
1680
+ "name": "id",
1681
+ "type": "number",
1682
+ "info": "device id: 123",
1683
+ "required": true,
1684
+ "schema": {
1685
+ "title": "id",
1686
+ "type": "number"
1687
+ }
1688
+ }
1689
+ ],
1690
+ "output": {
1691
+ "name": "result",
1692
+ "type": "object",
1693
+ "description": "A JSON Object containing status, code and the result",
1694
+ "schema": {
1695
+ "title": "result",
1696
+ "type": "object"
1697
+ }
1698
+ },
1699
+ "roles": [
1700
+ "admin"
1701
+ ],
1702
+ "route": {
1703
+ "verb": "POST",
1704
+ "path": "/deleteDevice"
1705
+ },
1706
+ "task": true
1707
+ },
1708
+ {
1709
+ "name": "lockDevice",
1710
+ "summary": "Lock a device for web service writes",
1711
+ "description": "Lock a device for web service writes",
1712
+ "input": [
1713
+ {
1714
+ "name": "id",
1715
+ "type": "number",
1716
+ "info": "device id: 123",
1717
+ "required": true,
1718
+ "schema": {
1719
+ "title": "id",
1720
+ "type": "number"
1721
+ }
1722
+ }
1723
+ ],
1724
+ "output": {
1725
+ "name": "result",
1726
+ "type": "object",
1727
+ "description": "A JSON Object containing status, code and the result",
1728
+ "schema": {
1729
+ "title": "result",
1730
+ "type": "object"
1731
+ }
1732
+ },
1733
+ "roles": [
1734
+ "admin"
1735
+ ],
1736
+ "route": {
1737
+ "verb": "POST",
1738
+ "path": "/lockDevice"
1739
+ },
1740
+ "task": true
1741
+ },
1742
+ {
1743
+ "name": "deviceAttributeList",
1744
+ "summary": "Gets a list of device attributes",
1745
+ "description": "Gets a list of device attributes represent the tree of data provided from the device. See the TR-098 for information on the InternetGatewayDevice data model or another Technical Report depending on the device's capabilities. A filter may be applied in the query string to restrict results",
1746
+ "input": [
1747
+ {
1748
+ "name": "id",
1749
+ "type": "number",
1750
+ "info": "device id: 123",
1751
+ "required": true,
1752
+ "schema": {
1753
+ "title": "id",
1754
+ "type": "number"
1755
+ }
1756
+ },
1757
+ {
1758
+ "name": "recursive",
1759
+ "type": "boolean",
1760
+ "info": "whether to recurse through sub objects: boolean",
1761
+ "required": false,
1762
+ "schema": {
1763
+ "title": "recursive",
1764
+ "type": "boolean"
1765
+ }
1766
+ },
1767
+ {
1768
+ "name": "withValues",
1769
+ "type": "boolean",
1770
+ "info": "whether to return object properties: boolean",
1771
+ "required": false,
1772
+ "schema": {
1773
+ "title": "withValues",
1774
+ "type": "boolean"
1775
+ }
1776
+ },
1777
+ {
1778
+ "name": "withLeaves",
1779
+ "type": "boolean",
1780
+ "info": "whether to return leaf objects. ignored if withValues = true: boolean",
1781
+ "required": false,
1782
+ "schema": {
1783
+ "title": "withLeaves",
1784
+ "type": "boolean"
1785
+ }
1786
+ },
1787
+ {
1788
+ "name": "attributeDate",
1789
+ "type": "string",
1790
+ "info": "to return values as of date: string",
1791
+ "required": false,
1792
+ "schema": {
1793
+ "title": "attributeDate",
1794
+ "type": "string"
1795
+ }
1796
+ },
1797
+ {
1798
+ "name": "filter",
1799
+ "type": "string",
1800
+ "info": "by simple string: InternetGatewayDevice.ManagementServer or InternetGatewayDevice.LANDevice.* by JSON object: { InternetGatewayDevice: { DeviceInfo: { SoftwareVersion: '*...(description truncated): string",
1801
+ "required": false,
1802
+ "schema": {
1803
+ "title": "filter",
1804
+ "type": "string"
1805
+ }
1806
+ }
1807
+ ],
1808
+ "output": {
1809
+ "name": "result",
1810
+ "type": "object",
1811
+ "description": "A JSON Object containing status, code and the result",
1812
+ "schema": {
1813
+ "title": "result",
1814
+ "type": "object"
1815
+ }
1816
+ },
1817
+ "roles": [
1818
+ "admin"
1819
+ ],
1820
+ "route": {
1821
+ "verb": "POST",
1822
+ "path": "/deviceAttributeList"
1823
+ },
1824
+ "task": true
1825
+ },
1826
+ {
1827
+ "name": "modifyDeviceAttributes",
1828
+ "summary": "Creates an attribute update action which sets the attributes to the specified values and adds it to",
1829
+ "description": "Creates an attribute update action which sets the attributes to the specified values and adds it to the device's pending action list",
1830
+ "input": [
1831
+ {
1832
+ "name": "id",
1833
+ "type": "number",
1834
+ "info": "device id: 123",
1835
+ "required": true,
1836
+ "schema": {
1837
+ "title": "id",
1838
+ "type": "number"
1839
+ }
1840
+ },
1841
+ {
1842
+ "name": "reboot",
1843
+ "type": "boolean",
1844
+ "info": "reboot the device after the operation: boolean",
1845
+ "required": false,
1846
+ "schema": {
1847
+ "title": "reboot",
1848
+ "type": "boolean"
1849
+ }
1850
+ },
1851
+ {
1852
+ "name": "body",
1853
+ "type": "object",
1854
+ "info": ": object",
1855
+ "required": true,
1856
+ "schema": {
1857
+ "type": "object"
1858
+ }
1859
+ }
1860
+ ],
1861
+ "output": {
1862
+ "name": "result",
1863
+ "type": "object",
1864
+ "description": "A JSON Object containing status, code and the result",
1865
+ "schema": {
1866
+ "type": "object",
1867
+ "properties": {
1868
+ "scriptRunId": {
1869
+ "type": "number"
1870
+ }
1871
+ }
1872
+ }
1873
+ },
1874
+ "roles": [
1875
+ "admin"
1876
+ ],
1877
+ "route": {
1878
+ "verb": "POST",
1879
+ "path": "/modifyDeviceAttributes"
1880
+ },
1881
+ "task": true
1882
+ },
1883
+ {
1884
+ "name": "createDeviceAttributes",
1885
+ "summary": "Creates an attribute create action which creates new objects under the 'parent' attribute and adds",
1886
+ "description": "Creates an attribute create action which creates new objects under the 'parent' attribute and adds it to the device's pending action list",
1887
+ "input": [
1888
+ {
1889
+ "name": "id",
1890
+ "type": "number",
1891
+ "info": "device id: 123",
1892
+ "required": true,
1893
+ "schema": {
1894
+ "title": "id",
1895
+ "type": "number"
1896
+ }
1897
+ },
1898
+ {
1899
+ "name": "reboot",
1900
+ "type": "boolean",
1901
+ "info": "reboot the device after the operation: boolean",
1902
+ "required": false,
1903
+ "schema": {
1904
+ "title": "reboot",
1905
+ "type": "boolean"
1906
+ }
1907
+ },
1908
+ {
1909
+ "name": "body",
1910
+ "type": "object",
1911
+ "info": ": object",
1912
+ "required": true,
1913
+ "schema": {
1914
+ "type": "object"
1915
+ }
1916
+ }
1917
+ ],
1918
+ "output": {
1919
+ "name": "result",
1920
+ "type": "object",
1921
+ "description": "A JSON Object containing status, code and the result",
1922
+ "schema": {
1923
+ "type": "object",
1924
+ "properties": {
1925
+ "scriptRunId": {
1926
+ "type": "number"
1927
+ }
1928
+ }
1929
+ }
1930
+ },
1931
+ "roles": [
1932
+ "admin"
1933
+ ],
1934
+ "route": {
1935
+ "verb": "POST",
1936
+ "path": "/createDeviceAttributes"
1937
+ },
1938
+ "task": true
1939
+ },
1940
+ {
1941
+ "name": "removeDeviceAttributes",
1942
+ "summary": "Creates an attribute delete action which deletes the given objects and adds it to the device's pend",
1943
+ "description": "Creates an attribute delete action which deletes the given objects and adds it to the device's pending action list",
1944
+ "input": [
1945
+ {
1946
+ "name": "id",
1947
+ "type": "number",
1948
+ "info": "device id: 123",
1949
+ "required": true,
1950
+ "schema": {
1951
+ "title": "id",
1952
+ "type": "number"
1953
+ }
1954
+ }
1955
+ ],
1956
+ "output": {
1957
+ "name": "result",
1958
+ "type": "object",
1959
+ "description": "A JSON Object containing status, code and the result",
1960
+ "schema": {
1961
+ "title": "result",
1962
+ "type": "object"
1963
+ }
1964
+ },
1965
+ "roles": [
1966
+ "admin"
1967
+ ],
1968
+ "route": {
1969
+ "verb": "POST",
1970
+ "path": "/removeDeviceAttributes"
1971
+ },
1972
+ "task": true
1973
+ },
1974
+ {
1975
+ "name": "requestDeviceAttributeRefresh",
1976
+ "summary": "Creates an action which will cause the device to send values for the requested attributes",
1977
+ "description": "Creates an action which will cause the device to send values for the requested attributes",
1978
+ "input": [
1979
+ {
1980
+ "name": "id",
1981
+ "type": "number",
1982
+ "info": "device id: 123",
1983
+ "required": true,
1984
+ "schema": {
1985
+ "title": "id",
1986
+ "type": "number"
1987
+ }
1988
+ },
1989
+ {
1990
+ "name": "body",
1991
+ "type": "object",
1992
+ "info": ": object",
1993
+ "required": true,
1994
+ "schema": {
1995
+ "type": "object"
1996
+ }
1997
+ }
1998
+ ],
1999
+ "output": {
2000
+ "name": "result",
2001
+ "type": "object",
2002
+ "description": "A JSON Object containing status, code and the result",
2003
+ "schema": {
2004
+ "type": "object",
2005
+ "properties": {
2006
+ "scriptName": {
2007
+ "type": "string"
2008
+ },
2009
+ "scriptRunId": {
2010
+ "type": "number"
2011
+ }
2012
+ }
2013
+ }
2014
+ },
2015
+ "roles": [
2016
+ "admin"
2017
+ ],
2018
+ "route": {
2019
+ "verb": "POST",
2020
+ "path": "/requestDeviceAttributeRefresh"
2021
+ },
2022
+ "task": true
2023
+ },
2024
+ {
2025
+ "name": "deviceNewActionList",
2026
+ "summary": "Retrieves a list of recent actions added to this device",
2027
+ "description": "Retrieves a list of recent actions added to this device",
2028
+ "input": [
2029
+ {
2030
+ "name": "id",
2031
+ "type": "number",
2032
+ "info": "device id: 123",
2033
+ "required": true,
2034
+ "schema": {
2035
+ "title": "id",
2036
+ "type": "number"
2037
+ }
2038
+ },
2039
+ {
2040
+ "name": "since",
2041
+ "type": "string",
2042
+ "info": "returns only actions which have been added since the specified timestamp. If this value is 'auto', actions added after two hours ago, or the time the oldest action pendin...(description truncated): string",
2043
+ "required": false,
2044
+ "schema": {
2045
+ "title": "since",
2046
+ "type": "string"
2047
+ }
2048
+ }
2049
+ ],
2050
+ "output": {
2051
+ "name": "result",
2052
+ "type": "object",
2053
+ "description": "A JSON Object containing status, code and the result",
2054
+ "schema": {
2055
+ "title": "result",
2056
+ "type": "object"
2057
+ }
2058
+ },
2059
+ "roles": [
2060
+ "admin"
2061
+ ],
2062
+ "route": {
2063
+ "verb": "POST",
2064
+ "path": "/deviceNewActionList"
2065
+ },
2066
+ "task": true
2067
+ },
2068
+ {
2069
+ "name": "queuedActionDetail",
2070
+ "summary": "Retrieves the detail for a single action which has been added to a device",
2071
+ "description": "Retrieves the detail for a single action which has been added to a device",
2072
+ "input": [
2073
+ {
2074
+ "name": "id",
2075
+ "type": "number",
2076
+ "info": "device id: 123",
2077
+ "required": true,
2078
+ "schema": {
2079
+ "title": "id",
2080
+ "type": "number"
2081
+ }
2082
+ },
2083
+ {
2084
+ "name": "scriptRunId",
2085
+ "type": "number",
2086
+ "info": "script run id: 123",
2087
+ "required": true,
2088
+ "schema": {
2089
+ "title": "scriptRunId",
2090
+ "type": "number"
2091
+ }
2092
+ }
2093
+ ],
2094
+ "output": {
2095
+ "name": "result",
2096
+ "type": "object",
2097
+ "description": "A JSON Object containing status, code and the result",
2098
+ "schema": {
2099
+ "title": "result",
2100
+ "type": "object"
2101
+ }
2102
+ },
2103
+ "roles": [
2104
+ "admin"
2105
+ ],
2106
+ "route": {
2107
+ "verb": "POST",
2108
+ "path": "/queuedActionDetail"
2109
+ },
2110
+ "task": true
2111
+ },
2112
+ {
2113
+ "name": "modifyScriptIDAndParametersForQueuedAction",
2114
+ "summary": "Updates the script ID and parameters for a single queued action",
2115
+ "description": "Updates the script ID and parameters for a single queued action. Only scripts created by the current user and are \"SCHEDULED\" can be modified",
2116
+ "input": [
2117
+ {
2118
+ "name": "id",
2119
+ "type": "number",
2120
+ "info": "device id: 123",
2121
+ "required": true,
2122
+ "schema": {
2123
+ "title": "id",
2124
+ "type": "number"
2125
+ }
2126
+ },
2127
+ {
2128
+ "name": "scriptRunId",
2129
+ "type": "number",
2130
+ "info": "script run id: 123",
2131
+ "required": true,
2132
+ "schema": {
2133
+ "title": "scriptRunId",
2134
+ "type": "number"
2135
+ }
2136
+ },
2137
+ {
2138
+ "name": "body",
2139
+ "type": "object",
2140
+ "info": ": {\"params\": [{\"name\": \"string\", \"value\": \"string\"}]}",
2141
+ "required": true,
2142
+ "schema": {
2143
+ "type": "object",
2144
+ "properties": {
2145
+ "params": {
2146
+ "type": "array",
2147
+ "items": {
2148
+ "type": "object",
2149
+ "properties": {
2150
+ "name": {
2151
+ "type": "string"
2152
+ },
2153
+ "value": {
2154
+ "type": "string"
2155
+ }
2156
+ }
2157
+ }
2158
+ }
2159
+ }
2160
+ }
2161
+ }
2162
+ ],
2163
+ "output": {
2164
+ "name": "result",
2165
+ "type": "object",
2166
+ "description": "A JSON Object containing status, code and the result",
2167
+ "schema": {
2168
+ "title": "result",
2169
+ "type": "object"
2170
+ }
2171
+ },
2172
+ "roles": [
2173
+ "admin"
2174
+ ],
2175
+ "route": {
2176
+ "verb": "POST",
2177
+ "path": "/modifyScriptIDAndParametersForQueuedAction"
2178
+ },
2179
+ "task": true
2180
+ },
2181
+ {
2182
+ "name": "queuedAction",
2183
+ "summary": "Removes a single queued action. Only scripts created by the current user and are \"SCHEDULED\" can be",
2184
+ "description": "Removes a single queued action. Only scripts created by the current user and are \"SCHEDULED\" can be removed",
2185
+ "input": [
2186
+ {
2187
+ "name": "id",
2188
+ "type": "number",
2189
+ "info": "device id: 123",
2190
+ "required": true,
2191
+ "schema": {
2192
+ "title": "id",
2193
+ "type": "number"
2194
+ }
2195
+ },
2196
+ {
2197
+ "name": "scriptRunId",
2198
+ "type": "number",
2199
+ "info": "script run id: 123",
2200
+ "required": true,
2201
+ "schema": {
2202
+ "title": "scriptRunId",
2203
+ "type": "number"
2204
+ }
2205
+ }
2206
+ ],
2207
+ "output": {
2208
+ "name": "result",
2209
+ "type": "object",
2210
+ "description": "A JSON Object containing status, code and the result",
2211
+ "schema": {
2212
+ "title": "result",
2213
+ "type": "object"
2214
+ }
2215
+ },
2216
+ "roles": [
2217
+ "admin"
2218
+ ],
2219
+ "route": {
2220
+ "verb": "POST",
2221
+ "path": "/queuedAction"
2222
+ },
2223
+ "task": true
2224
+ },
2225
+ {
2226
+ "name": "triggerDeviceEvent",
2227
+ "summary": "Fires an event for the related device",
2228
+ "description": "Fires an event for the related device. Any actions resulting from this event will be queued for this call return. This restful service is for internal functions only and is not available for third-party integration",
2229
+ "input": [
2230
+ {
2231
+ "name": "id",
2232
+ "type": "number",
2233
+ "info": "device id: 123",
2234
+ "required": true,
2235
+ "schema": {
2236
+ "title": "id",
2237
+ "type": "number"
2238
+ }
2239
+ },
2240
+ {
2241
+ "name": "body",
2242
+ "type": "object",
2243
+ "info": ": {\"event\": \"Must be one of [INITIAL_CONTACT, REBOOT, SUBSCRIBER_ASSOCIATED, SERVICE_ENABLE, SERVICE_DISABLE, VALUE_CHANGE, TRANSFER_COMPLETED, DIAGNOSTIC_COMPLETED, INFORM]\"}",
2244
+ "required": true,
2245
+ "schema": {
2246
+ "type": "object",
2247
+ "properties": {
2248
+ "event": {
2249
+ "type": "string",
2250
+ "enum": [
2251
+ "INITIAL_CONTACT",
2252
+ "REBOOT",
2253
+ "SUBSCRIBER_ASSOCIATED",
2254
+ "SERVICE_ENABLE",
2255
+ "SERVICE_DISABLE",
2256
+ "VALUE_CHANGE",
2257
+ "TRANSFER_COMPLETED",
2258
+ "DIAGNOSTIC_COMPLETED",
2259
+ "INFORM"
2260
+ ]
2261
+ }
2262
+ }
2263
+ }
2264
+ }
2265
+ ],
2266
+ "output": {
2267
+ "name": "result",
2268
+ "type": "object",
2269
+ "description": "A JSON Object containing status, code and the result",
2270
+ "schema": {
2271
+ "title": "result",
2272
+ "type": "object"
2273
+ }
2274
+ },
2275
+ "roles": [
2276
+ "admin"
2277
+ ],
2278
+ "route": {
2279
+ "verb": "POST",
2280
+ "path": "/triggerDeviceEvent"
2281
+ },
2282
+ "task": true
2283
+ },
2284
+ {
2285
+ "name": "deviceLabels",
2286
+ "summary": "Gets the labels for a device",
2287
+ "description": "Gets the labels for a device",
2288
+ "input": [
2289
+ {
2290
+ "name": "id",
2291
+ "type": "number",
2292
+ "info": "device id: 123",
2293
+ "required": true,
2294
+ "schema": {
2295
+ "title": "id",
2296
+ "type": "number"
2297
+ }
2298
+ }
2299
+ ],
2300
+ "output": {
2301
+ "name": "result",
2302
+ "type": "object",
2303
+ "description": "A JSON Object containing status, code and the result",
2304
+ "schema": {
2305
+ "title": "result",
2306
+ "type": "object"
2307
+ }
2308
+ },
2309
+ "roles": [
2310
+ "admin"
2311
+ ],
2312
+ "route": {
2313
+ "verb": "POST",
2314
+ "path": "/deviceLabels"
2315
+ },
2316
+ "task": true
2317
+ },
2318
+ {
2319
+ "name": "modifyDeviceLabels",
2320
+ "summary": "Sets all labels for a device",
2321
+ "description": "Sets all labels for a device",
2322
+ "input": [
2323
+ {
2324
+ "name": "id",
2325
+ "type": "number",
2326
+ "info": "device id: 123",
2327
+ "required": true,
2328
+ "schema": {
2329
+ "title": "id",
2330
+ "type": "number"
2331
+ }
2332
+ },
2333
+ {
2334
+ "name": "body",
2335
+ "type": "array",
2336
+ "info": ": array",
2337
+ "required": true,
2338
+ "schema": {
2339
+ "type": "array",
2340
+ "items": {
2341
+ "type": "string"
2342
+ }
2343
+ }
2344
+ }
2345
+ ],
2346
+ "output": {
2347
+ "name": "result",
2348
+ "type": "object",
2349
+ "description": "A JSON Object containing status, code and the result",
2350
+ "schema": {
2351
+ "title": "result",
2352
+ "type": "object"
2353
+ }
2354
+ },
2355
+ "roles": [
2356
+ "admin"
2357
+ ],
2358
+ "route": {
2359
+ "verb": "POST",
2360
+ "path": "/modifyDeviceLabels"
2361
+ },
2362
+ "task": true
2363
+ },
2364
+ {
2365
+ "name": "createDeviceLabels",
2366
+ "summary": "Adds the given labels for a device",
2367
+ "description": "Adds the given labels for a device",
2368
+ "input": [
2369
+ {
2370
+ "name": "id",
2371
+ "type": "number",
2372
+ "info": "device id: 123",
2373
+ "required": true,
2374
+ "schema": {
2375
+ "title": "id",
2376
+ "type": "number"
2377
+ }
2378
+ },
2379
+ {
2380
+ "name": "body",
2381
+ "type": "array",
2382
+ "info": ": array",
2383
+ "required": true,
2384
+ "schema": {
2385
+ "type": "array",
2386
+ "items": {
2387
+ "type": "string"
2388
+ }
2389
+ }
2390
+ }
2391
+ ],
2392
+ "output": {
2393
+ "name": "result",
2394
+ "type": "object",
2395
+ "description": "A JSON Object containing status, code and the result",
2396
+ "schema": {
2397
+ "title": "result",
2398
+ "type": "object"
2399
+ }
2400
+ },
2401
+ "roles": [
2402
+ "admin"
2403
+ ],
2404
+ "route": {
2405
+ "verb": "POST",
2406
+ "path": "/createDeviceLabels"
2407
+ },
2408
+ "task": true
2409
+ },
2410
+ {
2411
+ "name": "deviceStatisticsSummary",
2412
+ "summary": "Returns a summary of miscellaneous statistics about a device",
2413
+ "description": "Returns a summary of miscellaneous statistics about a device",
2414
+ "input": [
2415
+ {
2416
+ "name": "id",
2417
+ "type": "number",
2418
+ "info": "device id: 123",
2419
+ "required": true,
2420
+ "schema": {
2421
+ "title": "id",
2422
+ "type": "number"
2423
+ }
2424
+ }
2425
+ ],
2426
+ "output": {
2427
+ "name": "result",
2428
+ "type": "object",
2429
+ "description": "A JSON Object containing status, code and the result",
2430
+ "schema": {
2431
+ "title": "result",
2432
+ "type": "object"
2433
+ }
2434
+ },
2435
+ "roles": [
2436
+ "admin"
2437
+ ],
2438
+ "route": {
2439
+ "verb": "POST",
2440
+ "path": "/deviceStatisticsSummary"
2441
+ },
2442
+ "task": true
2443
+ },
2444
+ {
2445
+ "name": "solicitStatus",
2446
+ "summary": "Gets the solicit status",
2447
+ "description": "Gets the solicit status",
2448
+ "input": [
2449
+ {
2450
+ "name": "id",
2451
+ "type": "number",
2452
+ "info": "device id: 123",
2453
+ "required": true,
2454
+ "schema": {
2455
+ "title": "id",
2456
+ "type": "number"
2457
+ }
2458
+ }
2459
+ ],
2460
+ "output": {
2461
+ "name": "result",
2462
+ "type": "object",
2463
+ "description": "A JSON Object containing status, code and the result",
2464
+ "schema": {
2465
+ "title": "result",
2466
+ "type": "object"
2467
+ }
2468
+ },
2469
+ "roles": [
2470
+ "admin"
2471
+ ],
2472
+ "route": {
2473
+ "verb": "POST",
2474
+ "path": "/solicitStatus"
2475
+ },
2476
+ "task": true
2477
+ },
2478
+ {
2479
+ "name": "createDeviceUpdateQueue",
2480
+ "summary": "Queues devices to update their status",
2481
+ "description": "Queues devices to update their status and causes and scheduled scripts to be run against the device. Passed data is an array of objects, each must contain id and lastStatus. The value for lastStatus will be populated in the return value. When querying for related status, lastStatus will contain a value greater or equal to this value to indicate that the requested solicit has been completed",
2482
+ "input": [
2483
+ {
2484
+ "name": "id",
2485
+ "type": "number",
2486
+ "info": "number of the device id: 123",
2487
+ "required": true,
2488
+ "schema": {
2489
+ "title": "id",
2490
+ "type": "number"
2491
+ }
2492
+ },
2493
+ {
2494
+ "name": "body",
2495
+ "type": "array",
2496
+ "info": ": array",
2497
+ "required": true,
2498
+ "schema": {
2499
+ "items": {
2500
+ "properties": {
2501
+ "id": {
2502
+ "type": "number"
2503
+ },
2504
+ "lastStatus": {
2505
+ "type": "number"
2506
+ }
2507
+ },
2508
+ "type": "object"
2509
+ },
2510
+ "type": "array"
2511
+ }
2512
+ }
2513
+ ],
2514
+ "output": {
2515
+ "name": "result",
2516
+ "type": "object",
2517
+ "description": "A JSON Object containing status, code and the result",
2518
+ "schema": {
2519
+ "title": "result",
2520
+ "type": "object"
2521
+ }
2522
+ },
2523
+ "roles": [
2524
+ "admin"
2525
+ ],
2526
+ "route": {
2527
+ "verb": "POST",
2528
+ "path": "/createDeviceUpdateQueue"
2529
+ },
2530
+ "task": true
2531
+ },
2532
+ {
2533
+ "name": "deviceSessionTraceList",
2534
+ "summary": "Returns a summary of recent trace logs for the device",
2535
+ "description": "Returns a summary of recent trace logs for the device. Results are ordered with the most recent session first",
2536
+ "input": [
2537
+ {
2538
+ "name": "id",
2539
+ "type": "number",
2540
+ "info": "device id: 123",
2541
+ "required": true,
2542
+ "schema": {
2543
+ "title": "id",
2544
+ "type": "number"
2545
+ }
2546
+ }
2547
+ ],
2548
+ "output": {
2549
+ "name": "result",
2550
+ "type": "object",
2551
+ "description": "A JSON Object containing status, code and the result",
2552
+ "schema": {
2553
+ "title": "result",
2554
+ "type": "object"
2555
+ }
2556
+ },
2557
+ "roles": [
2558
+ "admin"
2559
+ ],
2560
+ "route": {
2561
+ "verb": "POST",
2562
+ "path": "/deviceSessionTraceList"
2563
+ },
2564
+ "task": true
2565
+ },
2566
+ {
2567
+ "name": "createDeviceTraceLog",
2568
+ "summary": "Begin a new trace log for the device",
2569
+ "description": "Begin a new trace log for the device",
2570
+ "input": [
2571
+ {
2572
+ "name": "id",
2573
+ "type": "number",
2574
+ "info": "device id: 123",
2575
+ "required": true,
2576
+ "schema": {
2577
+ "title": "id",
2578
+ "type": "number"
2579
+ }
2580
+ },
2581
+ {
2582
+ "name": "body",
2583
+ "type": "object",
2584
+ "info": ": {\"sessionId\": \"string\", \"begin\": 123, \"hardwareVersion\": \"string\", \"softwareVersion\": \"string\", \"informEvents\": \"array\", \"informCount\": 123}",
2585
+ "required": true,
2586
+ "schema": {
2587
+ "type": "object",
2588
+ "properties": {
2589
+ "sessionId": {
2590
+ "type": "string"
2591
+ },
2592
+ "begin": {
2593
+ "type": "number"
2594
+ },
2595
+ "hardwareVersion": {
2596
+ "type": "string"
2597
+ },
2598
+ "softwareVersion": {
2599
+ "type": "string"
2600
+ },
2601
+ "informEvents": {
2602
+ "type": "array",
2603
+ "items": {
2604
+ "type": "string"
2605
+ }
2606
+ },
2607
+ "informCount": {
2608
+ "type": "number"
2609
+ }
2610
+ }
2611
+ }
2612
+ }
2613
+ ],
2614
+ "output": {
2615
+ "name": "result",
2616
+ "type": "object",
2617
+ "description": "A JSON Object containing status, code and the result",
2618
+ "schema": {
2619
+ "title": "result",
2620
+ "type": "object"
2621
+ }
2622
+ },
2623
+ "roles": [
2624
+ "admin"
2625
+ ],
2626
+ "route": {
2627
+ "verb": "POST",
2628
+ "path": "/createDeviceTraceLog"
2629
+ },
2630
+ "task": true
2631
+ },
2632
+ {
2633
+ "name": "deviceTraceLevel",
2634
+ "summary": "Gets the logging level for the device",
2635
+ "description": "Gets the logging level for the device",
2636
+ "input": [
2637
+ {
2638
+ "name": "id",
2639
+ "type": "number",
2640
+ "info": "device id: 123",
2641
+ "required": true,
2642
+ "schema": {
2643
+ "title": "id",
2644
+ "type": "number"
2645
+ }
2646
+ }
2647
+ ],
2648
+ "output": {
2649
+ "name": "result",
2650
+ "type": "object",
2651
+ "description": "A JSON Object containing status, code and the result",
2652
+ "schema": {
2653
+ "type": "object",
2654
+ "properties": {
2655
+ "loggingLevel": {
2656
+ "type": "string",
2657
+ "enum": [
2658
+ "NONE",
2659
+ "INFO",
2660
+ "DEBUG",
2661
+ "TRACE"
2662
+ ]
2663
+ }
2664
+ }
2665
+ }
2666
+ },
2667
+ "roles": [
2668
+ "admin"
2669
+ ],
2670
+ "route": {
2671
+ "verb": "POST",
2672
+ "path": "/deviceTraceLevel"
2673
+ },
2674
+ "task": true
2675
+ },
2676
+ {
2677
+ "name": "configureDeviceLoggingLevel",
2678
+ "summary": "Configure logging level for the device",
2679
+ "description": "Configure logging level for the device",
2680
+ "input": [
2681
+ {
2682
+ "name": "id",
2683
+ "type": "number",
2684
+ "info": "device id: 123",
2685
+ "required": true,
2686
+ "schema": {
2687
+ "title": "id",
2688
+ "type": "number"
2689
+ }
2690
+ },
2691
+ {
2692
+ "name": "body",
2693
+ "type": "object",
2694
+ "info": ": {\"loggingLevel\": \"Must be one of [NONE, INFO, DEBUG, TRACE]\"}",
2695
+ "required": true,
2696
+ "schema": {
2697
+ "type": "object",
2698
+ "properties": {
2699
+ "loggingLevel": {
2700
+ "type": "string",
2701
+ "enum": [
2702
+ "NONE",
2703
+ "INFO",
2704
+ "DEBUG",
2705
+ "TRACE"
2706
+ ]
2707
+ }
2708
+ }
2709
+ }
2710
+ }
2711
+ ],
2712
+ "output": {
2713
+ "name": "result",
2714
+ "type": "object",
2715
+ "description": "A JSON Object containing status, code and the result",
2716
+ "schema": {
2717
+ "type": "object",
2718
+ "properties": {
2719
+ "loggingLevel": {
2720
+ "type": "string",
2721
+ "enum": [
2722
+ "NONE",
2723
+ "INFO",
2724
+ "DEBUG",
2725
+ "TRACE"
2726
+ ]
2727
+ }
2728
+ }
2729
+ }
2730
+ },
2731
+ "roles": [
2732
+ "admin"
2733
+ ],
2734
+ "route": {
2735
+ "verb": "POST",
2736
+ "path": "/configureDeviceLoggingLevel"
2737
+ },
2738
+ "task": true
2739
+ },
2740
+ {
2741
+ "name": "deviceSessionTraceSummary",
2742
+ "summary": "Returns a summary of the session trace log for a device",
2743
+ "description": "Returns a summary of the session trace log for a device",
2744
+ "input": [
2745
+ {
2746
+ "name": "id",
2747
+ "type": "number",
2748
+ "info": "device id: 123",
2749
+ "required": true,
2750
+ "schema": {
2751
+ "title": "id",
2752
+ "type": "number"
2753
+ }
2754
+ },
2755
+ {
2756
+ "name": "traceId",
2757
+ "type": "number",
2758
+ "info": "trace id: 123",
2759
+ "required": true,
2760
+ "schema": {
2761
+ "title": "traceId",
2762
+ "type": "number"
2763
+ }
2764
+ }
2765
+ ],
2766
+ "output": {
2767
+ "name": "result",
2768
+ "type": "object",
2769
+ "description": "A JSON Object containing status, code and the result",
2770
+ "schema": {
2771
+ "title": "result",
2772
+ "type": "object"
2773
+ }
2774
+ },
2775
+ "roles": [
2776
+ "admin"
2777
+ ],
2778
+ "route": {
2779
+ "verb": "POST",
2780
+ "path": "/deviceSessionTraceSummary"
2781
+ },
2782
+ "task": true
2783
+ },
2784
+ {
2785
+ "name": "deviceSessionTraceDetail",
2786
+ "summary": "Retrieve the details of a single CPE session",
2787
+ "description": "Retrieve the details of a single CPE session. Results are ordered as they were logged.",
2788
+ "input": [
2789
+ {
2790
+ "name": "id",
2791
+ "type": "number",
2792
+ "info": "device id: 123",
2793
+ "required": true,
2794
+ "schema": {
2795
+ "title": "id",
2796
+ "type": "number"
2797
+ }
2798
+ },
2799
+ {
2800
+ "name": "traceId",
2801
+ "type": "number",
2802
+ "info": "trace id: 123",
2803
+ "required": true,
2804
+ "schema": {
2805
+ "title": "traceId",
2806
+ "type": "number"
2807
+ }
2808
+ }
2809
+ ],
2810
+ "output": {
2811
+ "name": "result",
2812
+ "type": "object",
2813
+ "description": "A JSON Object containing status, code and the result",
2814
+ "schema": {
2815
+ "title": "result",
2816
+ "type": "object"
2817
+ }
2818
+ },
2819
+ "roles": [
2820
+ "admin"
2821
+ ],
2822
+ "route": {
2823
+ "verb": "POST",
2824
+ "path": "/deviceSessionTraceDetail"
2825
+ },
2826
+ "task": true
2827
+ },
2828
+ {
2829
+ "name": "accessDevicesOnActivationServer",
2830
+ "summary": "Gets devices known by the activation server",
2831
+ "description": "Gets devices known by the activation server",
2832
+ "input": [
2833
+ {
2834
+ "name": "first",
2835
+ "type": "number",
2836
+ "info": "the first result to return: 123",
2837
+ "required": true,
2838
+ "schema": {
2839
+ "title": "first",
2840
+ "type": "number"
2841
+ }
2842
+ },
2843
+ {
2844
+ "name": "count",
2845
+ "type": "number",
2846
+ "info": "the number of results to return: 123",
2847
+ "required": true,
2848
+ "schema": {
2849
+ "title": "count",
2850
+ "type": "number"
2851
+ }
2852
+ },
2853
+ {
2854
+ "name": "q",
2855
+ "type": "string",
2856
+ "info": "devicetosearchfor.SearchesbyOUI/SerialNumber/provisioningcode: string",
2857
+ "required": true,
2858
+ "schema": {
2859
+ "title": "q",
2860
+ "type": "string"
2861
+ }
2862
+ }
2863
+ ],
2864
+ "output": {
2865
+ "name": "result",
2866
+ "type": "object",
2867
+ "description": "A JSON Object containing status, code and the result",
2868
+ "schema": {
2869
+ "title": "result",
2870
+ "type": "object"
2871
+ }
2872
+ },
2873
+ "roles": [
2874
+ "admin"
2875
+ ],
2876
+ "route": {
2877
+ "verb": "POST",
2878
+ "path": "/accessDevicesOnActivationServer"
2879
+ },
2880
+ "task": true
2881
+ },
2882
+ {
2883
+ "name": "aCSSubscriberList",
2884
+ "summary": "Retrieves a list of subscribers in the system",
2885
+ "description": "Retrieves a list of subscribers in the system",
2886
+ "input": [],
2887
+ "output": {
2888
+ "name": "result",
2889
+ "type": "object",
2890
+ "description": "A JSON Object containing status, code and the result",
2891
+ "schema": {
2892
+ "title": "result",
2893
+ "type": "object"
2894
+ }
2895
+ },
2896
+ "roles": [
2897
+ "admin"
2898
+ ],
2899
+ "route": {
2900
+ "verb": "GET",
2901
+ "path": "/aCSSubscriberList"
2902
+ },
2903
+ "task": true
2904
+ },
2905
+ {
2906
+ "name": "createNewACSSubscriberPOST",
2907
+ "summary": "Creates a new subscriber",
2908
+ "description": "Creates a new subscriber",
2909
+ "input": [
2910
+ {
2911
+ "name": "body",
2912
+ "type": "object",
2913
+ "info": ": {\"dto\": {\"Subscriber\": {\"FullName\": \"string\", \"EmailAddress\": \"string\"}, \"subscriptions\": \"array\", \"labels\": \"array\", \"credentials\": \"object\", \"code\": \"string\"}}",
2914
+ "required": true,
2915
+ "schema": {
2916
+ "type": "object",
2917
+ "properties": {
2918
+ "dto": {
2919
+ "type": "object",
2920
+ "properties": {
2921
+ "Subscriber": {
2922
+ "type": "object",
2923
+ "properties": {
2924
+ "FullName": {
2925
+ "type": "string"
2926
+ },
2927
+ "EmailAddress": {
2928
+ "type": "string"
2929
+ }
2930
+ }
2931
+ },
2932
+ "subscriptions": {
2933
+ "type": "array",
2934
+ "items": {
2935
+ "type": "string"
2936
+ }
2937
+ },
2938
+ "labels": {
2939
+ "type": "array",
2940
+ "items": {
2941
+ "type": "string"
2942
+ }
2943
+ },
2944
+ "credentials": {
2945
+ "type": "object"
2946
+ },
2947
+ "code": {
2948
+ "type": "string"
2949
+ }
2950
+ }
2951
+ }
2952
+ }
2953
+ }
2954
+ }
2955
+ ],
2956
+ "output": {
2957
+ "name": "result",
2958
+ "type": "object",
2959
+ "description": "A JSON Object containing status, code and the result",
2960
+ "schema": {
2961
+ "title": "result",
2962
+ "type": "object"
2963
+ }
2964
+ },
2965
+ "roles": [
2966
+ "admin"
2967
+ ],
2968
+ "route": {
2969
+ "verb": "POST",
2970
+ "path": "/createNewACSSubscriberPOST"
2971
+ },
2972
+ "task": true
2973
+ },
2974
+ {
2975
+ "name": "requestPasswordChange",
2976
+ "summary": "Requests an automated change of password with email notification",
2977
+ "description": "Requests an automated change of password with email notification",
2978
+ "input": [
2979
+ {
2980
+ "name": "body",
2981
+ "type": "object",
2982
+ "info": ": {\"email\": \"string\", \"locale\": \"string\"}",
2983
+ "required": true,
2984
+ "schema": {
2985
+ "type": "object",
2986
+ "properties": {
2987
+ "email": {
2988
+ "type": "string"
2989
+ },
2990
+ "locale": {
2991
+ "type": "string"
2992
+ }
2993
+ }
2994
+ }
2995
+ }
2996
+ ],
2997
+ "output": {
2998
+ "name": "result",
2999
+ "type": "object",
3000
+ "description": "A JSON Object containing status, code and the result",
3001
+ "schema": {
3002
+ "title": "result",
3003
+ "type": "object"
3004
+ }
3005
+ },
3006
+ "roles": [
3007
+ "admin"
3008
+ ],
3009
+ "route": {
3010
+ "verb": "POST",
3011
+ "path": "/requestPasswordChange"
3012
+ },
3013
+ "task": true
3014
+ },
3015
+ {
3016
+ "name": "statisticsForSubscribers",
3017
+ "summary": "Gets summary information for all active subscribers",
3018
+ "description": "Gets summary information for all active subscribers",
3019
+ "input": [],
3020
+ "output": {
3021
+ "name": "result",
3022
+ "type": "object",
3023
+ "description": "A JSON Object containing status, code and the result",
3024
+ "schema": {
3025
+ "type": "object",
3026
+ "properties": {
3027
+ "totalActiveSubscribers": {
3028
+ "type": "number"
3029
+ }
3030
+ }
3031
+ }
3032
+ },
3033
+ "roles": [
3034
+ "admin"
3035
+ ],
3036
+ "route": {
3037
+ "verb": "GET",
3038
+ "path": "/statisticsForSubscribers"
3039
+ },
3040
+ "task": true
3041
+ },
3042
+ {
3043
+ "name": "statisticsForSpecificSubscriber",
3044
+ "summary": "Retrieve a subscriber indicated by {personId}.",
3045
+ "description": "Retrieve a subscriber indicated by {personId}. A subscriber is a person which may have any number of devices",
3046
+ "input": [
3047
+ {
3048
+ "name": "personId",
3049
+ "type": "string",
3050
+ "info": "person id: string",
3051
+ "required": true,
3052
+ "schema": {
3053
+ "title": "personId",
3054
+ "type": "string"
3055
+ }
3056
+ }
3057
+ ],
3058
+ "output": {
3059
+ "name": "result",
3060
+ "type": "object",
3061
+ "description": "A JSON Object containing status, code and the result",
3062
+ "schema": {
3063
+ "type": "object",
3064
+ "properties": {
3065
+ "id": {
3066
+ "type": "number"
3067
+ },
3068
+ "fullname": {
3069
+ "type": "string"
3070
+ },
3071
+ "email": {
3072
+ "type": "string"
3073
+ }
3074
+ }
3075
+ }
3076
+ },
3077
+ "roles": [
3078
+ "admin"
3079
+ ],
3080
+ "route": {
3081
+ "verb": "POST",
3082
+ "path": "/statisticsForSpecificSubscriber"
3083
+ },
3084
+ "task": true
3085
+ },
3086
+ {
3087
+ "name": "modifySubscriber",
3088
+ "summary": "Update a subscriber",
3089
+ "description": "Update a subscriber",
3090
+ "input": [
3091
+ {
3092
+ "name": "personId",
3093
+ "type": "string",
3094
+ "info": "person id: string",
3095
+ "required": true,
3096
+ "schema": {
3097
+ "title": "personId",
3098
+ "type": "string"
3099
+ }
3100
+ },
3101
+ {
3102
+ "name": "body",
3103
+ "type": "object",
3104
+ "info": ": {\"code\": \"string\"}",
3105
+ "required": true,
3106
+ "schema": {
3107
+ "type": "object",
3108
+ "properties": {
3109
+ "code": {
3110
+ "type": "string"
3111
+ }
3112
+ }
3113
+ }
3114
+ }
3115
+ ],
3116
+ "output": {
3117
+ "name": "result",
3118
+ "type": "object",
3119
+ "description": "A JSON Object containing status, code and the result",
3120
+ "schema": {
3121
+ "type": "object",
3122
+ "properties": {
3123
+ "id": {
3124
+ "type": "number"
3125
+ },
3126
+ "code": {
3127
+ "type": "string"
3128
+ }
3129
+ }
3130
+ }
3131
+ },
3132
+ "roles": [
3133
+ "admin"
3134
+ ],
3135
+ "route": {
3136
+ "verb": "POST",
3137
+ "path": "/modifySubscriber"
3138
+ },
3139
+ "task": true
3140
+ },
3141
+ {
3142
+ "name": "deleteSubscriber",
3143
+ "summary": "Delete an existing subscriber",
3144
+ "description": "Delete an existing subscriber. This will fail if there is a management group with active services",
3145
+ "input": [
3146
+ {
3147
+ "name": "personId",
3148
+ "type": "string",
3149
+ "info": "person id: string",
3150
+ "required": true,
3151
+ "schema": {
3152
+ "title": "personId",
3153
+ "type": "string"
3154
+ }
3155
+ }
3156
+ ],
3157
+ "output": {
3158
+ "name": "result",
3159
+ "type": "object",
3160
+ "description": "A JSON Object containing status, code and the result",
3161
+ "schema": {
3162
+ "title": "result",
3163
+ "type": "object"
3164
+ }
3165
+ },
3166
+ "roles": [
3167
+ "admin"
3168
+ ],
3169
+ "route": {
3170
+ "verb": "POST",
3171
+ "path": "/deleteSubscriber"
3172
+ },
3173
+ "task": true
3174
+ },
3175
+ {
3176
+ "name": "subscriberLabelSet",
3177
+ "summary": "Retrieves the subscriber's set of labels",
3178
+ "description": "Retrieves the subscriber's set of labels",
3179
+ "input": [
3180
+ {
3181
+ "name": "personId",
3182
+ "type": "string",
3183
+ "info": "person id: string",
3184
+ "required": true,
3185
+ "schema": {
3186
+ "title": "personId",
3187
+ "type": "string"
3188
+ }
3189
+ }
3190
+ ],
3191
+ "output": {
3192
+ "name": "result",
3193
+ "type": "object",
3194
+ "description": "A JSON Object containing status, code and the result",
3195
+ "schema": {
3196
+ "title": "result",
3197
+ "type": "object"
3198
+ }
3199
+ },
3200
+ "roles": [
3201
+ "admin"
3202
+ ],
3203
+ "route": {
3204
+ "verb": "POST",
3205
+ "path": "/subscriberLabelSet"
3206
+ },
3207
+ "task": true
3208
+ },
3209
+ {
3210
+ "name": "defineLabelsForSubscriber",
3211
+ "summary": "Sets the labels for a subscriber",
3212
+ "description": "Sets the labels for a subscriber",
3213
+ "input": [
3214
+ {
3215
+ "name": "personId",
3216
+ "type": "string",
3217
+ "info": "person id: string",
3218
+ "required": true,
3219
+ "schema": {
3220
+ "title": "personId",
3221
+ "type": "string"
3222
+ }
3223
+ },
3224
+ {
3225
+ "name": "body",
3226
+ "type": "array",
3227
+ "info": ": array",
3228
+ "required": true,
3229
+ "schema": {
3230
+ "type": "array",
3231
+ "items": {
3232
+ "type": "string"
3233
+ }
3234
+ }
3235
+ }
3236
+ ],
3237
+ "output": {
3238
+ "name": "result",
3239
+ "type": "object",
3240
+ "description": "A JSON Object containing status, code and the result",
3241
+ "schema": {
3242
+ "title": "result",
3243
+ "type": "object"
3244
+ }
3245
+ },
3246
+ "roles": [
3247
+ "admin"
3248
+ ],
3249
+ "route": {
3250
+ "verb": "POST",
3251
+ "path": "/defineLabelsForSubscriber"
3252
+ },
3253
+ "task": true
3254
+ },
3255
+ {
3256
+ "name": "createSubscriberLabels",
3257
+ "summary": "Adds the labels for a subscriber",
3258
+ "description": "Adds the labels for a subscriber",
3259
+ "input": [
3260
+ {
3261
+ "name": "personId",
3262
+ "type": "string",
3263
+ "info": "person id: string",
3264
+ "required": true,
3265
+ "schema": {
3266
+ "title": "personId",
3267
+ "type": "string"
3268
+ }
3269
+ },
3270
+ {
3271
+ "name": "body",
3272
+ "type": "array",
3273
+ "info": ": array",
3274
+ "required": true,
3275
+ "schema": {
3276
+ "type": "array",
3277
+ "items": {
3278
+ "type": "string"
3279
+ }
3280
+ }
3281
+ }
3282
+ ],
3283
+ "output": {
3284
+ "name": "result",
3285
+ "type": "object",
3286
+ "description": "A JSON Object containing status, code and the result",
3287
+ "schema": {
3288
+ "title": "result",
3289
+ "type": "object"
3290
+ }
3291
+ },
3292
+ "roles": [
3293
+ "admin"
3294
+ ],
3295
+ "route": {
3296
+ "verb": "POST",
3297
+ "path": "/createSubscriberLabels"
3298
+ },
3299
+ "task": true
3300
+ },
3301
+ {
3302
+ "name": "subscriberManagementGroups",
3303
+ "summary": "Retrieves the list of management groups associated to the subscriber",
3304
+ "description": "Retrieves the list of management groups associated to the subscriber. A management group consists of a managed device and a number of service package subscriptions on that device.",
3305
+ "input": [
3306
+ {
3307
+ "name": "personId",
3308
+ "type": "string",
3309
+ "info": "person id: string",
3310
+ "required": true,
3311
+ "schema": {
3312
+ "title": "personId",
3313
+ "type": "string"
3314
+ }
3315
+ },
3316
+ {
3317
+ "name": "cA",
3318
+ "type": "string",
3319
+ "info": "version, returns only groups which have a clearaccess firmware, and a firmware version greater than or equal to (version). No paging is available for this search type: string",
3320
+ "required": false,
3321
+ "schema": {
3322
+ "title": "cA",
3323
+ "type": "string"
3324
+ }
3325
+ },
3326
+ {
3327
+ "name": "q",
3328
+ "type": "string",
3329
+ "info": "the serial number/pcode/oui are done using a case insensitive 'like' operator and are 'ORed' paging is available for this search type using first and count parameters in ...(description truncated): string",
3330
+ "required": false,
3331
+ "schema": {
3332
+ "title": "q",
3333
+ "type": "string"
3334
+ }
3335
+ }
3336
+ ],
3337
+ "output": {
3338
+ "name": "result",
3339
+ "type": "object",
3340
+ "description": "A JSON Object containing status, code and the result",
3341
+ "schema": {
3342
+ "title": "result",
3343
+ "type": "object"
3344
+ }
3345
+ },
3346
+ "roles": [
3347
+ "admin"
3348
+ ],
3349
+ "route": {
3350
+ "verb": "POST",
3351
+ "path": "/subscriberManagementGroups"
3352
+ },
3353
+ "task": true
3354
+ },
3355
+ {
3356
+ "name": "createSubscriberManagementGroup",
3357
+ "summary": "Creates a management group for the subscriber.",
3358
+ "description": "Creates a management group for the subscriber. If managedDevice is present, deviceSignature is ignored. If present, deviceSignature must contain exactly one of: 1. oui and serialNumber, 2. or provisioningCode, 3. or cpProvisioningId",
3359
+ "input": [
3360
+ {
3361
+ "name": "personId",
3362
+ "type": "string",
3363
+ "info": "person id: string",
3364
+ "required": true,
3365
+ "schema": {
3366
+ "title": "personId",
3367
+ "type": "string"
3368
+ }
3369
+ },
3370
+ {
3371
+ "name": "body",
3372
+ "type": "object",
3373
+ "info": ": {\"managedDevice\": {\"id\": 123}, \"deviceSignature\": {\"oui\": \"string\", \"serialNumber\": \"string\", \"provisioningCode\": \"string\", \"cpProvisioningId\": 123}}",
3374
+ "required": true,
3375
+ "schema": {
3376
+ "type": "object",
3377
+ "properties": {
3378
+ "managedDevice": {
3379
+ "type": "object",
3380
+ "properties": {
3381
+ "id": {
3382
+ "type": "number"
3383
+ }
3384
+ }
3385
+ },
3386
+ "deviceSignature": {
3387
+ "type": "object",
3388
+ "properties": {
3389
+ "oui": {
3390
+ "type": "string"
3391
+ },
3392
+ "serialNumber": {
3393
+ "type": "string"
3394
+ },
3395
+ "provisioningCode": {
3396
+ "type": "string"
3397
+ },
3398
+ "cpProvisioningId": {
3399
+ "type": "number"
3400
+ }
3401
+ }
3402
+ }
3403
+ }
3404
+ }
3405
+ }
3406
+ ],
3407
+ "output": {
3408
+ "name": "result",
3409
+ "type": "object",
3410
+ "description": "A JSON Object containing status, code and the result",
3411
+ "schema": {
3412
+ "title": "result",
3413
+ "type": "object"
3414
+ }
3415
+ },
3416
+ "roles": [
3417
+ "admin"
3418
+ ],
3419
+ "route": {
3420
+ "verb": "POST",
3421
+ "path": "/createSubscriberManagementGroup"
3422
+ },
3423
+ "task": true
3424
+ },
3425
+ {
3426
+ "name": "subscriberManagementGroupDetails",
3427
+ "summary": "Returns a management group for the subscriber",
3428
+ "description": "Returns a management group for the subscriber. A management group consists of a managed device or device signature, and a number of service package subscriptions. If managedDevice is present, deviceSignature is ignored. If present, deviceSignature must contain exactly one of: 1. oui and serialNumber, 2. provisioningCode, or 3. cpProvisioningId.",
3429
+ "input": [
3430
+ {
3431
+ "name": "personId",
3432
+ "type": "string",
3433
+ "info": "person id: string",
3434
+ "required": true,
3435
+ "schema": {
3436
+ "title": "personId",
3437
+ "type": "string"
3438
+ }
3439
+ },
3440
+ {
3441
+ "name": "managementGroupId",
3442
+ "type": "string",
3443
+ "info": "management group id: string",
3444
+ "required": true,
3445
+ "schema": {
3446
+ "title": "managementGroupId",
3447
+ "type": "string"
3448
+ }
3449
+ }
3450
+ ],
3451
+ "output": {
3452
+ "name": "result",
3453
+ "type": "object",
3454
+ "description": "A JSON Object containing status, code and the result",
3455
+ "schema": {
3456
+ "title": "result",
3457
+ "type": "object"
3458
+ }
3459
+ },
3460
+ "roles": [
3461
+ "admin"
3462
+ ],
3463
+ "route": {
3464
+ "verb": "POST",
3465
+ "path": "/subscriberManagementGroupDetails"
3466
+ },
3467
+ "task": true
3468
+ },
3469
+ {
3470
+ "name": "modifySubscriberManagementGroup",
3471
+ "summary": "Updates a management group for the subscriber",
3472
+ "description": "Updates a management group for the subscriber. If managedDevice is present, deviceSignature is ignored. If present, deviceSignature must contain exactly one of: 1. oui and serialNumber, 2. provisioningCode, or 3.cpProvisioningId.",
3473
+ "input": [
3474
+ {
3475
+ "name": "personId",
3476
+ "type": "string",
3477
+ "info": "person id: string",
3478
+ "required": true,
3479
+ "schema": {
3480
+ "title": "personId",
3481
+ "type": "string"
3482
+ }
3483
+ },
3484
+ {
3485
+ "name": "managementGroupId",
3486
+ "type": "string",
3487
+ "info": "management group id: string",
3488
+ "required": true,
3489
+ "schema": {
3490
+ "title": "managementGroupId",
3491
+ "type": "string"
3492
+ }
3493
+ },
3494
+ {
3495
+ "name": "body",
3496
+ "type": "object",
3497
+ "info": ": {\"managedDevice\": {\"id\": 123}, \"deviceSignature\": {\"oui\": \"string\", \"serialNumber\": \"string\", \"provisioningCode\": \"string\", \"cpProvisioningId\": 123}}",
3498
+ "required": true,
3499
+ "schema": {
3500
+ "type": "object",
3501
+ "properties": {
3502
+ "managedDevice": {
3503
+ "type": "object",
3504
+ "properties": {
3505
+ "id": {
3506
+ "type": "number"
3507
+ }
3508
+ }
3509
+ },
3510
+ "deviceSignature": {
3511
+ "type": "object",
3512
+ "properties": {
3513
+ "oui": {
3514
+ "type": "string"
3515
+ },
3516
+ "serialNumber": {
3517
+ "type": "string"
3518
+ },
3519
+ "provisioningCode": {
3520
+ "type": "string"
3521
+ },
3522
+ "cpProvisioningId": {
3523
+ "type": "number"
3524
+ }
3525
+ }
3526
+ }
3527
+ }
3528
+ }
3529
+ }
3530
+ ],
3531
+ "output": {
3532
+ "name": "result",
3533
+ "type": "object",
3534
+ "description": "A JSON Object containing status, code and the result",
3535
+ "schema": {
3536
+ "title": "result",
3537
+ "type": "object"
3538
+ }
3539
+ },
3540
+ "roles": [
3541
+ "admin"
3542
+ ],
3543
+ "route": {
3544
+ "verb": "POST",
3545
+ "path": "/modifySubscriberManagementGroup"
3546
+ },
3547
+ "task": true
3548
+ },
3549
+ {
3550
+ "name": "subscriberManagementGroup",
3551
+ "summary": "Deletes this management group",
3552
+ "description": "Deletes this management group. This method will fail if there are any subscriptions which have not already been removed",
3553
+ "input": [
3554
+ {
3555
+ "name": "personId",
3556
+ "type": "string",
3557
+ "info": "person id: string",
3558
+ "required": true,
3559
+ "schema": {
3560
+ "title": "personId",
3561
+ "type": "string"
3562
+ }
3563
+ },
3564
+ {
3565
+ "name": "managementGroupId",
3566
+ "type": "string",
3567
+ "info": "management group id: string",
3568
+ "required": true,
3569
+ "schema": {
3570
+ "title": "managementGroupId",
3571
+ "type": "string"
3572
+ }
3573
+ }
3574
+ ],
3575
+ "output": {
3576
+ "name": "result",
3577
+ "type": "object",
3578
+ "description": "A JSON Object containing status, code and the result",
3579
+ "schema": {
3580
+ "title": "result",
3581
+ "type": "object"
3582
+ }
3583
+ },
3584
+ "roles": [
3585
+ "admin"
3586
+ ],
3587
+ "route": {
3588
+ "verb": "POST",
3589
+ "path": "/subscriberManagementGroup"
3590
+ },
3591
+ "task": true
3592
+ },
3593
+ {
3594
+ "name": "subscriptionsForManagementGroup",
3595
+ "summary": "Lists the subscriptions in the current management group",
3596
+ "description": "Lists the subscriptions in the current management group",
3597
+ "input": [
3598
+ {
3599
+ "name": "personId",
3600
+ "type": "string",
3601
+ "info": "person id: string",
3602
+ "required": true,
3603
+ "schema": {
3604
+ "title": "personId",
3605
+ "type": "string"
3606
+ }
3607
+ },
3608
+ {
3609
+ "name": "managementGroupId",
3610
+ "type": "string",
3611
+ "info": "management group id: string",
3612
+ "required": true,
3613
+ "schema": {
3614
+ "title": "managementGroupId",
3615
+ "type": "string"
3616
+ }
3617
+ }
3618
+ ],
3619
+ "output": {
3620
+ "name": "result",
3621
+ "type": "object",
3622
+ "description": "A JSON Object containing status, code and the result",
3623
+ "schema": {
3624
+ "title": "result",
3625
+ "type": "object"
3626
+ }
3627
+ },
3628
+ "roles": [
3629
+ "admin"
3630
+ ],
3631
+ "route": {
3632
+ "verb": "POST",
3633
+ "path": "/subscriptionsForManagementGroup"
3634
+ },
3635
+ "task": true
3636
+ },
3637
+ {
3638
+ "name": "addSubscriptionToManagementGroup",
3639
+ "summary": "Adds a subscription to the management group",
3640
+ "description": "If the status becomes \"ENABLED\", the ACS will attempt to enable the service on the device specified in the management group. If the status becomes \"DISABLED\", the ACS will disable the service.",
3641
+ "input": [
3642
+ {
3643
+ "name": "personId",
3644
+ "type": "string",
3645
+ "info": "person id: string",
3646
+ "required": true,
3647
+ "schema": {
3648
+ "title": "personId",
3649
+ "type": "string"
3650
+ }
3651
+ },
3652
+ {
3653
+ "name": "managementGroupId",
3654
+ "type": "string",
3655
+ "info": "management group id: string",
3656
+ "required": true,
3657
+ "schema": {
3658
+ "title": "managementGroupId",
3659
+ "type": "string"
3660
+ }
3661
+ },
3662
+ {
3663
+ "name": "body",
3664
+ "type": "object",
3665
+ "info": ": {\"status\": \"Must be one of [ENABLED, ENABLING, DISABLED, DISABLING]\", \"package\": {\"id\": 123, \"name\": \"string\"}}",
3666
+ "required": true,
3667
+ "schema": {
3668
+ "type": "object",
3669
+ "properties": {
3670
+ "status": {
3671
+ "type": "string",
3672
+ "enum": [
3673
+ "ENABLED",
3674
+ "ENABLING",
3675
+ "DISABLED",
3676
+ "DISABLING"
3677
+ ]
3678
+ },
3679
+ "package": {
3680
+ "type": "object",
3681
+ "properties": {
3682
+ "id": {
3683
+ "type": "number"
3684
+ },
3685
+ "name": {
3686
+ "type": "string"
3687
+ }
3688
+ }
3689
+ }
3690
+ }
3691
+ }
3692
+ }
3693
+ ],
3694
+ "output": {
3695
+ "name": "result",
3696
+ "type": "object",
3697
+ "description": "A JSON Object containing status, code and the result",
3698
+ "schema": {
3699
+ "title": "result",
3700
+ "type": "object"
3701
+ }
3702
+ },
3703
+ "roles": [
3704
+ "admin"
3705
+ ],
3706
+ "route": {
3707
+ "verb": "POST",
3708
+ "path": "/addSubscriptionToManagementGroup"
3709
+ },
3710
+ "task": true
3711
+ },
3712
+ {
3713
+ "name": "serviceSubscriptionDetails",
3714
+ "summary": "Retrieve information about a subscription. to a service with the specified {packageName}",
3715
+ "description": "Retrieve information about a subscription. to a service with the specified {packageName}",
3716
+ "input": [
3717
+ {
3718
+ "name": "personId",
3719
+ "type": "string",
3720
+ "info": "person id: string",
3721
+ "required": true,
3722
+ "schema": {
3723
+ "title": "personId",
3724
+ "type": "string"
3725
+ }
3726
+ },
3727
+ {
3728
+ "name": "managementGroupId",
3729
+ "type": "string",
3730
+ "info": "management group id: string",
3731
+ "required": true,
3732
+ "schema": {
3733
+ "title": "managementGroupId",
3734
+ "type": "string"
3735
+ }
3736
+ },
3737
+ {
3738
+ "name": "packageName",
3739
+ "type": "string",
3740
+ "info": "package name: string",
3741
+ "required": true,
3742
+ "schema": {
3743
+ "title": "packageName",
3744
+ "type": "string"
3745
+ }
3746
+ }
3747
+ ],
3748
+ "output": {
3749
+ "name": "result",
3750
+ "type": "object",
3751
+ "description": "A JSON Object containing status, code and the result",
3752
+ "schema": {
3753
+ "title": "result",
3754
+ "type": "object"
3755
+ }
3756
+ },
3757
+ "roles": [
3758
+ "admin"
3759
+ ],
3760
+ "route": {
3761
+ "verb": "POST",
3762
+ "path": "/serviceSubscriptionDetails"
3763
+ },
3764
+ "task": true
3765
+ },
3766
+ {
3767
+ "name": "subscriptionPackageStatus",
3768
+ "summary": "Updates the status of the given subscription package",
3769
+ "description": "Updates the status of the given subscription package",
3770
+ "input": [
3771
+ {
3772
+ "name": "personId",
3773
+ "type": "string",
3774
+ "info": "person id: string",
3775
+ "required": true,
3776
+ "schema": {
3777
+ "title": "personId",
3778
+ "type": "string"
3779
+ }
3780
+ },
3781
+ {
3782
+ "name": "managementGroupId",
3783
+ "type": "string",
3784
+ "info": "management group id: string",
3785
+ "required": true,
3786
+ "schema": {
3787
+ "title": "managementGroupId",
3788
+ "type": "string"
3789
+ }
3790
+ },
3791
+ {
3792
+ "name": "packageName",
3793
+ "type": "string",
3794
+ "info": "package name: string",
3795
+ "required": true,
3796
+ "schema": {
3797
+ "title": "packageName",
3798
+ "type": "string"
3799
+ }
3800
+ },
3801
+ {
3802
+ "name": "body",
3803
+ "type": "object",
3804
+ "info": ": {\"status\": \"Must be one of [ENABLED, ENABLING, DISABLED, DISABLING]\"}",
3805
+ "required": true,
3806
+ "schema": {
3807
+ "type": "object",
3808
+ "properties": {
3809
+ "status": {
3810
+ "type": "string",
3811
+ "enum": [
3812
+ "ENABLED",
3813
+ "ENABLING",
3814
+ "DISABLED",
3815
+ "DISABLING"
3816
+ ]
3817
+ }
3818
+ }
3819
+ }
3820
+ }
3821
+ ],
3822
+ "output": {
3823
+ "name": "result",
3824
+ "type": "object",
3825
+ "description": "A JSON Object containing status, code and the result",
3826
+ "schema": {
3827
+ "title": "result",
3828
+ "type": "object"
3829
+ }
3830
+ },
3831
+ "roles": [
3832
+ "admin"
3833
+ ],
3834
+ "route": {
3835
+ "verb": "POST",
3836
+ "path": "/subscriptionPackageStatus"
3837
+ },
3838
+ "task": true
3839
+ },
3840
+ {
3841
+ "name": "subscriptionPackage",
3842
+ "summary": "Deletes the specified subscription",
3843
+ "description": "Deletes the specified subscription. Fails if the status is anything except DISABLED",
3844
+ "input": [
3845
+ {
3846
+ "name": "personId",
3847
+ "type": "string",
3848
+ "info": "person id: string",
3849
+ "required": true,
3850
+ "schema": {
3851
+ "title": "personId",
3852
+ "type": "string"
3853
+ }
3854
+ },
3855
+ {
3856
+ "name": "managementGroupId",
3857
+ "type": "string",
3858
+ "info": "management group id: string",
3859
+ "required": true,
3860
+ "schema": {
3861
+ "title": "managementGroupId",
3862
+ "type": "string"
3863
+ }
3864
+ },
3865
+ {
3866
+ "name": "packageName",
3867
+ "type": "string",
3868
+ "info": "package name: string",
3869
+ "required": true,
3870
+ "schema": {
3871
+ "title": "packageName",
3872
+ "type": "string"
3873
+ }
3874
+ }
3875
+ ],
3876
+ "output": {
3877
+ "name": "result",
3878
+ "type": "object",
3879
+ "description": "A JSON Object containing status, code and the result",
3880
+ "schema": {
3881
+ "title": "result",
3882
+ "type": "object"
3883
+ }
3884
+ },
3885
+ "roles": [
3886
+ "admin"
3887
+ ],
3888
+ "route": {
3889
+ "verb": "POST",
3890
+ "path": "/subscriptionPackage"
3891
+ },
3892
+ "task": true
3893
+ },
3894
+ {
3895
+ "name": "managementGroupDeviceSignature",
3896
+ "summary": "Returns the device signature of the management group",
3897
+ "description": "Returns the device signature of the management group. A device signature represents a device which may connect to the ACS at some future time. Upon doing so, the device matching a device signature is automatically associated to the subscriber and any service package which are marked as \"enabled\" will be applied. A device signature must contain exactly one of: 1. oui and serialNumber, 2. provisioningCode, or 3. cpProvisioningId.",
3898
+ "input": [
3899
+ {
3900
+ "name": "personId",
3901
+ "type": "string",
3902
+ "info": "person id: string",
3903
+ "required": true,
3904
+ "schema": {
3905
+ "title": "personId",
3906
+ "type": "string"
3907
+ }
3908
+ },
3909
+ {
3910
+ "name": "managementGroupId",
3911
+ "type": "string",
3912
+ "info": "management group id: string",
3913
+ "required": true,
3914
+ "schema": {
3915
+ "title": "managementGroupId",
3916
+ "type": "string"
3917
+ }
3918
+ }
3919
+ ],
3920
+ "output": {
3921
+ "name": "result",
3922
+ "type": "object",
3923
+ "description": "A JSON Object containing status, code and the result",
3924
+ "schema": {
3925
+ "title": "result",
3926
+ "type": "object"
3927
+ }
3928
+ },
3929
+ "roles": [
3930
+ "admin"
3931
+ ],
3932
+ "route": {
3933
+ "verb": "POST",
3934
+ "path": "/managementGroupDeviceSignature"
3935
+ },
3936
+ "task": true
3937
+ },
3938
+ {
3939
+ "name": "managementGroup",
3940
+ "summary": "Updates the properties of this management group",
3941
+ "description": "Updates the properties of this management group",
3942
+ "input": [
3943
+ {
3944
+ "name": "personId",
3945
+ "type": "string",
3946
+ "info": "person id: string",
3947
+ "required": true,
3948
+ "schema": {
3949
+ "title": "personId",
3950
+ "type": "string"
3951
+ }
3952
+ },
3953
+ {
3954
+ "name": "managementGroupId",
3955
+ "type": "string",
3956
+ "info": "management group id: string",
3957
+ "required": true,
3958
+ "schema": {
3959
+ "title": "managementGroupId",
3960
+ "type": "string"
3961
+ }
3962
+ },
3963
+ {
3964
+ "name": "body",
3965
+ "type": "object",
3966
+ "info": ": {\"oui\": \"string\", \"serialNumber\": \"string\", \"provisioningCode\": \"string\", \"cpProvisioningId\": 123}",
3967
+ "required": true,
3968
+ "schema": {
3969
+ "type": "object",
3970
+ "properties": {
3971
+ "oui": {
3972
+ "type": "string"
3973
+ },
3974
+ "serialNumber": {
3975
+ "type": "string"
3976
+ },
3977
+ "provisioningCode": {
3978
+ "type": "string"
3979
+ },
3980
+ "cpProvisioningId": {
3981
+ "type": "number"
3982
+ }
3983
+ }
3984
+ }
3985
+ }
3986
+ ],
3987
+ "output": {
3988
+ "name": "result",
3989
+ "type": "object",
3990
+ "description": "A JSON Object containing status, code and the result",
3991
+ "schema": {
3992
+ "title": "result",
3993
+ "type": "object"
3994
+ }
3995
+ },
3996
+ "roles": [
3997
+ "admin"
3998
+ ],
3999
+ "route": {
4000
+ "verb": "POST",
4001
+ "path": "/managementGroup"
4002
+ },
4003
+ "task": true
4004
+ },
4005
+ {
4006
+ "name": "subscriberAttributeTree",
4007
+ "summary": "Retrieves the subscriber's attribute tree",
4008
+ "description": "Retrieves the subscriber's attribute tree. Refer to the integration guide for schema details",
4009
+ "input": [
4010
+ {
4011
+ "name": "personId",
4012
+ "type": "string",
4013
+ "info": "person id: string",
4014
+ "required": true,
4015
+ "schema": {
4016
+ "title": "personId",
4017
+ "type": "string"
4018
+ }
4019
+ }
4020
+ ],
4021
+ "output": {
4022
+ "name": "result",
4023
+ "type": "object",
4024
+ "description": "A JSON Object containing status, code and the result",
4025
+ "schema": {
4026
+ "title": "result",
4027
+ "type": "object"
4028
+ }
4029
+ },
4030
+ "roles": [
4031
+ "admin"
4032
+ ],
4033
+ "route": {
4034
+ "verb": "POST",
4035
+ "path": "/subscriberAttributeTree"
4036
+ },
4037
+ "task": true
4038
+ },
4039
+ {
4040
+ "name": "subscriberAttribute",
4041
+ "summary": "Updates the attributes for the given subscriber",
4042
+ "description": "Updates the attributes for the given subscriber",
4043
+ "input": [
4044
+ {
4045
+ "name": "personId",
4046
+ "type": "string",
4047
+ "info": "person id: string",
4048
+ "required": true,
4049
+ "schema": {
4050
+ "title": "personId",
4051
+ "type": "string"
4052
+ }
4053
+ },
4054
+ {
4055
+ "name": "body",
4056
+ "type": "object",
4057
+ "info": ": object",
4058
+ "required": true,
4059
+ "schema": {
4060
+ "type": "object"
4061
+ }
4062
+ }
4063
+ ],
4064
+ "output": {
4065
+ "name": "result",
4066
+ "type": "object",
4067
+ "description": "A JSON Object containing status, code and the result",
4068
+ "schema": {
4069
+ "title": "result",
4070
+ "type": "object"
4071
+ }
4072
+ },
4073
+ "roles": [
4074
+ "admin"
4075
+ ],
4076
+ "route": {
4077
+ "verb": "POST",
4078
+ "path": "/subscriberAttribute"
4079
+ },
4080
+ "task": true
4081
+ },
4082
+ {
4083
+ "name": "subscriberAttributes",
4084
+ "summary": "Creates the attributes for the given subscriber",
4085
+ "description": "Creates the attributes for the given subscriber",
4086
+ "input": [
4087
+ {
4088
+ "name": "personId",
4089
+ "type": "string",
4090
+ "info": "person id: string",
4091
+ "required": true,
4092
+ "schema": {
4093
+ "title": "personId",
4094
+ "type": "string"
4095
+ }
4096
+ },
4097
+ {
4098
+ "name": "body",
4099
+ "type": "object",
4100
+ "info": ": object",
4101
+ "required": true,
4102
+ "schema": {
4103
+ "type": "object"
4104
+ }
4105
+ }
4106
+ ],
4107
+ "output": {
4108
+ "name": "result",
4109
+ "type": "object",
4110
+ "description": "A JSON Object containing status, code and the result",
4111
+ "schema": {
4112
+ "title": "result",
4113
+ "type": "object"
4114
+ }
4115
+ },
4116
+ "roles": [
4117
+ "admin"
4118
+ ],
4119
+ "route": {
4120
+ "verb": "POST",
4121
+ "path": "/subscriberAttributes"
4122
+ },
4123
+ "task": true
4124
+ },
4125
+ {
4126
+ "name": "deleteSubscriberAttributes",
4127
+ "summary": "Removes a portion of the attribute tree for the given subscriber",
4128
+ "description": "Removes a portion of the attribute tree for the given subscriber",
4129
+ "input": [
4130
+ {
4131
+ "name": "personId",
4132
+ "type": "string",
4133
+ "info": "person id: string",
4134
+ "required": true,
4135
+ "schema": {
4136
+ "title": "personId",
4137
+ "type": "string"
4138
+ }
4139
+ },
4140
+ {
4141
+ "name": "name",
4142
+ "type": "string",
4143
+ "info": "The portion of the attribute tree to remove: string",
4144
+ "required": true,
4145
+ "schema": {
4146
+ "title": "name",
4147
+ "type": "string"
4148
+ }
4149
+ }
4150
+ ],
4151
+ "output": {
4152
+ "name": "result",
4153
+ "type": "object",
4154
+ "description": "A JSON Object containing status, code and the result",
4155
+ "schema": {
4156
+ "type": "object",
4157
+ "properties": {
4158
+ "Subscriber": {
4159
+ "type": "object",
4160
+ "properties": {
4161
+ "FullName": {
4162
+ "type": "string"
4163
+ },
4164
+ "EmailAddress": {
4165
+ "type": "string"
4166
+ }
4167
+ }
4168
+ }
4169
+ }
4170
+ }
4171
+ },
4172
+ "roles": [
4173
+ "admin"
4174
+ ],
4175
+ "route": {
4176
+ "verb": "POST",
4177
+ "path": "/deleteSubscriberAttributes"
4178
+ },
4179
+ "task": true
4180
+ },
4181
+ {
4182
+ "name": "changePassword",
4183
+ "summary": "Self-administered subscriber password within the control panel",
4184
+ "description": "Self-administered subscriber password within the control panel",
4185
+ "input": [
4186
+ {
4187
+ "name": "personId",
4188
+ "type": "string",
4189
+ "info": "person id: string",
4190
+ "required": true,
4191
+ "schema": {
4192
+ "title": "personId",
4193
+ "type": "string"
4194
+ }
4195
+ },
4196
+ {
4197
+ "name": "body",
4198
+ "type": "object",
4199
+ "info": ": {\"currentPassword\": \"string\", \"newPassword\": \"string\"}",
4200
+ "required": true,
4201
+ "schema": {
4202
+ "type": "object",
4203
+ "properties": {
4204
+ "currentPassword": {
4205
+ "type": "string"
4206
+ },
4207
+ "newPassword": {
4208
+ "type": "string"
4209
+ }
4210
+ }
4211
+ }
4212
+ }
4213
+ ],
4214
+ "output": {
4215
+ "name": "result",
4216
+ "type": "object",
4217
+ "description": "A JSON Object containing status, code and the result",
4218
+ "schema": {
4219
+ "title": "result",
4220
+ "type": "object"
4221
+ }
4222
+ },
4223
+ "roles": [
4224
+ "admin"
4225
+ ],
4226
+ "route": {
4227
+ "verb": "POST",
4228
+ "path": "/changePassword"
4229
+ },
4230
+ "task": true
4231
+ },
4232
+ {
4233
+ "name": "createSubscriberLoginSessions",
4234
+ "summary": "Creates Subscriber Login Session",
4235
+ "description": "Creates Subscriber Login Session",
4236
+ "input": [
4237
+ {
4238
+ "name": "body",
4239
+ "type": "object",
4240
+ "info": ": {\"login\": \"string\", \"password\": \"string\"}",
4241
+ "required": true,
4242
+ "schema": {
4243
+ "type": "object",
4244
+ "properties": {
4245
+ "login": {
4246
+ "type": "string"
4247
+ },
4248
+ "password": {
4249
+ "type": "string"
4250
+ }
4251
+ }
4252
+ }
4253
+ }
4254
+ ],
4255
+ "output": {
4256
+ "name": "result",
4257
+ "type": "object",
4258
+ "description": "A JSON Object containing status, code and the result",
4259
+ "schema": {
4260
+ "title": "result",
4261
+ "type": "object"
4262
+ }
4263
+ },
4264
+ "roles": [
4265
+ "admin"
4266
+ ],
4267
+ "route": {
4268
+ "verb": "POST",
4269
+ "path": "/createSubscriberLoginSessions"
4270
+ },
4271
+ "task": true
4272
+ },
4273
+ {
4274
+ "name": "subscriberLoginSession",
4275
+ "summary": "Updates a subscriber's login session",
4276
+ "description": "Updates a subscriber's login session",
4277
+ "input": [
4278
+ {
4279
+ "name": "tokenId",
4280
+ "type": "string",
4281
+ "info": "token id: string",
4282
+ "required": true,
4283
+ "schema": {
4284
+ "title": "tokenId",
4285
+ "type": "string"
4286
+ }
4287
+ },
4288
+ {
4289
+ "name": "body",
4290
+ "type": "object",
4291
+ "info": ": {\"cpSessionId\": \"string\"}",
4292
+ "required": true,
4293
+ "schema": {
4294
+ "type": "object",
4295
+ "properties": {
4296
+ "cpSessionId": {
4297
+ "type": "string"
4298
+ }
4299
+ }
4300
+ }
4301
+ }
4302
+ ],
4303
+ "output": {
4304
+ "name": "result",
4305
+ "type": "object",
4306
+ "description": "A JSON Object containing status, code and the result",
4307
+ "schema": {
4308
+ "title": "result",
4309
+ "type": "object"
4310
+ }
4311
+ },
4312
+ "roles": [
4313
+ "admin"
4314
+ ],
4315
+ "route": {
4316
+ "verb": "POST",
4317
+ "path": "/subscriberLoginSession"
4318
+ },
4319
+ "task": true
4320
+ },
4321
+ {
4322
+ "name": "deleteSubscriberLoginSession",
4323
+ "summary": "Removes the session",
4324
+ "description": "Removes the session",
4325
+ "input": [
4326
+ {
4327
+ "name": "tokenId",
4328
+ "type": "string",
4329
+ "info": "token id: string",
4330
+ "required": true,
4331
+ "schema": {
4332
+ "title": "tokenId",
4333
+ "type": "string"
4334
+ }
4335
+ }
4336
+ ],
4337
+ "output": {
4338
+ "name": "result",
4339
+ "type": "object",
4340
+ "description": "A JSON Object containing status, code and the result",
4341
+ "schema": {
4342
+ "title": "result",
4343
+ "type": "object"
4344
+ }
4345
+ },
4346
+ "roles": [
4347
+ "admin"
4348
+ ],
4349
+ "route": {
4350
+ "verb": "POST",
4351
+ "path": "/deleteSubscriberLoginSession"
4352
+ },
4353
+ "task": true
4354
+ },
4355
+ {
4356
+ "name": "sessionExpirationStatus",
4357
+ "summary": "Gets the session expiration status",
4358
+ "description": "Gets the session expiration status",
4359
+ "input": [],
4360
+ "output": {
4361
+ "name": "result",
4362
+ "type": "object",
4363
+ "description": "A JSON Object containing status, code and the result",
4364
+ "schema": {
4365
+ "title": "result",
4366
+ "type": "object"
4367
+ }
4368
+ },
4369
+ "roles": [
4370
+ "admin"
4371
+ ],
4372
+ "route": {
4373
+ "verb": "GET",
4374
+ "path": "/sessionExpirationStatus"
4375
+ },
4376
+ "task": true
4377
+ },
4378
+ {
4379
+ "name": "aCSUserListGET",
4380
+ "summary": "Lists the set of ACS users",
4381
+ "description": "Lists the set of ACS users",
4382
+ "input": [],
4383
+ "output": {
4384
+ "name": "result",
4385
+ "type": "object",
4386
+ "description": "A JSON Object containing status, code and the result",
4387
+ "schema": {
4388
+ "title": "result",
4389
+ "type": "object"
4390
+ }
4391
+ },
4392
+ "roles": [
4393
+ "admin"
4394
+ ],
4395
+ "route": {
4396
+ "verb": "GET",
4397
+ "path": "/aCSUserListGET"
4398
+ },
4399
+ "task": true
4400
+ },
4401
+ {
4402
+ "name": "modifyACSUserList",
4403
+ "summary": "Add a user to the ACS",
4404
+ "description": "Add a user to the ACS",
4405
+ "input": [
4406
+ {
4407
+ "name": "body",
4408
+ "type": "object",
4409
+ "info": ": {\"login\": \"string\", \"fullname\": \"string\", \"email\": \"string\", \"password\": \"string\", \"domains\": \"array\"}",
4410
+ "required": true,
4411
+ "schema": {
4412
+ "type": "object",
4413
+ "properties": {
4414
+ "login": {
4415
+ "type": "string"
4416
+ },
4417
+ "fullname": {
4418
+ "type": "string"
4419
+ },
4420
+ "email": {
4421
+ "type": "string"
4422
+ },
4423
+ "password": {
4424
+ "type": "string"
4425
+ },
4426
+ "domains": {
4427
+ "type": "array",
4428
+ "items": {
4429
+ "type": "string"
4430
+ }
4431
+ }
4432
+ }
4433
+ }
4434
+ }
4435
+ ],
4436
+ "output": {
4437
+ "name": "result",
4438
+ "type": "object",
4439
+ "description": "A JSON Object containing status, code and the result",
4440
+ "schema": {
4441
+ "title": "result",
4442
+ "type": "object"
4443
+ }
4444
+ },
4445
+ "roles": [
4446
+ "admin"
4447
+ ],
4448
+ "route": {
4449
+ "verb": "POST",
4450
+ "path": "/modifyACSUserList"
4451
+ },
4452
+ "task": true
4453
+ },
4454
+ {
4455
+ "name": "userDetails",
4456
+ "summary": "Gets user details for the given login name",
4457
+ "description": "Gets user details for the given login name",
4458
+ "input": [
4459
+ {
4460
+ "name": "login",
4461
+ "type": "string",
4462
+ "info": "login name: string",
4463
+ "required": true,
4464
+ "schema": {
4465
+ "title": "login",
4466
+ "type": "string"
4467
+ }
4468
+ }
4469
+ ],
4470
+ "output": {
4471
+ "name": "result",
4472
+ "type": "object",
4473
+ "description": "A JSON Object containing status, code and the result",
4474
+ "schema": {
4475
+ "title": "result",
4476
+ "type": "object"
4477
+ }
4478
+ },
4479
+ "roles": [
4480
+ "admin"
4481
+ ],
4482
+ "route": {
4483
+ "verb": "POST",
4484
+ "path": "/userDetails"
4485
+ },
4486
+ "task": true
4487
+ },
4488
+ {
4489
+ "name": "modifyUserDetails",
4490
+ "summary": "Change the user's details",
4491
+ "description": "Change the user's details",
4492
+ "input": [
4493
+ {
4494
+ "name": "login",
4495
+ "type": "string",
4496
+ "info": "login name: string",
4497
+ "required": true,
4498
+ "schema": {
4499
+ "title": "login",
4500
+ "type": "string"
4501
+ }
4502
+ },
4503
+ {
4504
+ "name": "body",
4505
+ "type": "object",
4506
+ "info": ": {\"login\": \"string\", \"fullname\": \"string\", \"email\": \"string\", \"password\": \"string\", \"enabled\": \"boolean\", \"domains\": \"array\"}",
4507
+ "required": true,
4508
+ "schema": {
4509
+ "type": "object",
4510
+ "properties": {
4511
+ "login": {
4512
+ "type": "string"
4513
+ },
4514
+ "fullname": {
4515
+ "type": "string"
4516
+ },
4517
+ "email": {
4518
+ "type": "string"
4519
+ },
4520
+ "password": {
4521
+ "type": "string"
4522
+ },
4523
+ "enabled": {
4524
+ "type": "boolean"
4525
+ },
4526
+ "domains": {
4527
+ "type": "array",
4528
+ "items": {
4529
+ "type": "string"
4530
+ }
4531
+ }
4532
+ }
4533
+ }
4534
+ }
4535
+ ],
4536
+ "output": {
4537
+ "name": "result",
4538
+ "type": "object",
4539
+ "description": "A JSON Object containing status, code and the result",
4540
+ "schema": {
4541
+ "title": "result",
4542
+ "type": "object"
4543
+ }
4544
+ },
4545
+ "roles": [
4546
+ "admin"
4547
+ ],
4548
+ "route": {
4549
+ "verb": "POST",
4550
+ "path": "/modifyUserDetails"
4551
+ },
4552
+ "task": true
4553
+ },
4554
+ {
4555
+ "name": "deleteUser",
4556
+ "summary": "Removes a user",
4557
+ "description": "Removes a user",
4558
+ "input": [
4559
+ {
4560
+ "name": "login",
4561
+ "type": "string",
4562
+ "info": "login name: string",
4563
+ "required": true,
4564
+ "schema": {
4565
+ "title": "login",
4566
+ "type": "string"
4567
+ }
4568
+ }
4569
+ ],
4570
+ "output": {
4571
+ "name": "result",
4572
+ "type": "object",
4573
+ "description": "A JSON Object containing status, code and the result",
4574
+ "schema": {
4575
+ "title": "result",
4576
+ "type": "object"
4577
+ }
4578
+ },
4579
+ "roles": [
4580
+ "admin"
4581
+ ],
4582
+ "route": {
4583
+ "verb": "POST",
4584
+ "path": "/deleteUser"
4585
+ },
4586
+ "task": true
4587
+ },
4588
+ {
4589
+ "name": "userNotificationsForPast10Minutes",
4590
+ "summary": "Gets the current set of notifications occurred in the last 10 minutes",
4591
+ "description": "Gets the current set of notifications generated by the ACS to be viewed by the user. Includes all notifications which have occurred in the last 10 minutes",
4592
+ "input": [
4593
+ {
4594
+ "name": "login",
4595
+ "type": "string",
4596
+ "info": "login name: string",
4597
+ "required": true,
4598
+ "schema": {
4599
+ "title": "login",
4600
+ "type": "string"
4601
+ }
4602
+ }
4603
+ ],
4604
+ "output": {
4605
+ "name": "result",
4606
+ "type": "object",
4607
+ "description": "A JSON Object containing status, code and the result",
4608
+ "schema": {
4609
+ "title": "result",
4610
+ "type": "object"
4611
+ }
4612
+ },
4613
+ "roles": [
4614
+ "admin"
4615
+ ],
4616
+ "route": {
4617
+ "verb": "POST",
4618
+ "path": "/userNotificationsForPast10Minutes"
4619
+ },
4620
+ "task": true
4621
+ },
4622
+ {
4623
+ "name": "createUserNotification",
4624
+ "summary": "Adds a user notification",
4625
+ "description": "Adds a user notification",
4626
+ "input": [
4627
+ {
4628
+ "name": "login",
4629
+ "type": "string",
4630
+ "info": "login name: string",
4631
+ "required": true,
4632
+ "schema": {
4633
+ "title": "login",
4634
+ "type": "string"
4635
+ }
4636
+ },
4637
+ {
4638
+ "name": "body",
4639
+ "type": "object",
4640
+ "info": ": {\"id\": 123, \"code\": \"string\", \"labels\": \"array\"}",
4641
+ "required": true,
4642
+ "schema": {
4643
+ "type": "object",
4644
+ "properties": {
4645
+ "id": {
4646
+ "type": "number"
4647
+ },
4648
+ "code": {
4649
+ "type": "string"
4650
+ },
4651
+ "labels": {
4652
+ "type": "array",
4653
+ "items": {
4654
+ "type": "string"
4655
+ }
4656
+ }
4657
+ }
4658
+ }
4659
+ }
4660
+ ],
4661
+ "output": {
4662
+ "name": "result",
4663
+ "type": "object",
4664
+ "description": "A JSON Object containing status, code and the result",
4665
+ "schema": {
4666
+ "title": "result",
4667
+ "type": "object"
4668
+ }
4669
+ },
4670
+ "roles": [
4671
+ "admin"
4672
+ ],
4673
+ "route": {
4674
+ "verb": "POST",
4675
+ "path": "/createUserNotification"
4676
+ },
4677
+ "task": true
4678
+ },
4679
+ {
4680
+ "name": "modifyUserPreferences",
4681
+ "summary": "Updates the user's preferences",
4682
+ "description": "Updates the user's preferences",
4683
+ "input": [
4684
+ {
4685
+ "name": "login",
4686
+ "type": "string",
4687
+ "info": "login name: string",
4688
+ "required": true,
4689
+ "schema": {
4690
+ "title": "login",
4691
+ "type": "string"
4692
+ }
4693
+ },
4694
+ {
4695
+ "name": "body",
4696
+ "type": "object",
4697
+ "info": ": {\"language\": \"Must be one of [en, es, fr]\"}",
4698
+ "required": true,
4699
+ "schema": {
4700
+ "type": "object",
4701
+ "properties": {
4702
+ "language": {
4703
+ "type": "string",
4704
+ "enum": [
4705
+ "en",
4706
+ "es",
4707
+ "fr"
4708
+ ]
4709
+ }
4710
+ }
4711
+ }
4712
+ }
4713
+ ],
4714
+ "output": {
4715
+ "name": "result",
4716
+ "type": "object",
4717
+ "description": "A JSON Object containing status, code and the result",
4718
+ "schema": {
4719
+ "title": "result",
4720
+ "type": "object"
4721
+ }
4722
+ },
4723
+ "roles": [
4724
+ "admin"
4725
+ ],
4726
+ "route": {
4727
+ "verb": "POST",
4728
+ "path": "/modifyUserPreferences"
4729
+ },
4730
+ "task": true
4731
+ },
4732
+ {
4733
+ "name": "getUserRoles",
4734
+ "summary": "Lists the user's set of roles",
4735
+ "description": "Lists the user's set of roles",
4736
+ "input": [
4737
+ {
4738
+ "name": "login",
4739
+ "type": "string",
4740
+ "info": "login name: string",
4741
+ "required": true,
4742
+ "schema": {
4743
+ "title": "login",
4744
+ "type": "string"
4745
+ }
4746
+ }
4747
+ ],
4748
+ "output": {
4749
+ "name": "result",
4750
+ "type": "object",
4751
+ "description": "A JSON Object containing status, code and the result",
4752
+ "schema": {
4753
+ "type": "array",
4754
+ "items": {
4755
+ "type": "string",
4756
+ "enum": [
4757
+ "admin",
4758
+ "csr"
4759
+ ]
4760
+ },
4761
+ "maxLength": 1
4762
+ }
4763
+ },
4764
+ "roles": [
4765
+ "admin"
4766
+ ],
4767
+ "route": {
4768
+ "verb": "POST",
4769
+ "path": "/getUserRoles"
4770
+ },
4771
+ "task": true
4772
+ },
4773
+ {
4774
+ "name": "createUserRoles",
4775
+ "summary": "Updates user's roles",
4776
+ "description": "Updates user's roles",
4777
+ "input": [
4778
+ {
4779
+ "name": "login",
4780
+ "type": "string",
4781
+ "info": "login name: string",
4782
+ "required": true,
4783
+ "schema": {
4784
+ "title": "login",
4785
+ "type": "string"
4786
+ }
4787
+ },
4788
+ {
4789
+ "name": "body",
4790
+ "type": "array",
4791
+ "info": ": array",
4792
+ "required": true,
4793
+ "schema": {
4794
+ "type": "array",
4795
+ "items": {
4796
+ "type": "string"
4797
+ }
4798
+ }
4799
+ }
4800
+ ],
4801
+ "output": {
4802
+ "name": "result",
4803
+ "type": "object",
4804
+ "description": "A JSON Object containing status, code and the result",
4805
+ "schema": {
4806
+ "title": "result",
4807
+ "type": "object"
4808
+ }
4809
+ },
4810
+ "roles": [
4811
+ "admin"
4812
+ ],
4813
+ "route": {
4814
+ "verb": "POST",
4815
+ "path": "/createUserRoles"
4816
+ },
4817
+ "task": true
4818
+ },
4819
+ {
4820
+ "name": "getUserLabels",
4821
+ "summary": "Gets the labels for a user",
4822
+ "description": "Gets the labels for a user",
4823
+ "input": [
4824
+ {
4825
+ "name": "login",
4826
+ "type": "string",
4827
+ "info": "login name: string",
4828
+ "required": true,
4829
+ "schema": {
4830
+ "title": "login",
4831
+ "type": "string"
4832
+ }
4833
+ }
4834
+ ],
4835
+ "output": {
4836
+ "name": "result",
4837
+ "type": "object",
4838
+ "description": "A JSON Object containing status, code and the result",
4839
+ "schema": {
4840
+ "title": "result",
4841
+ "type": "object"
4842
+ }
4843
+ },
4844
+ "roles": [
4845
+ "admin"
4846
+ ],
4847
+ "route": {
4848
+ "verb": "POST",
4849
+ "path": "/getUserLabels"
4850
+ },
4851
+ "task": true
4852
+ },
4853
+ {
4854
+ "name": "createUserLabels",
4855
+ "summary": "Updates the labels for a user",
4856
+ "description": "Updates the labels for a user",
4857
+ "input": [
4858
+ {
4859
+ "name": "login",
4860
+ "type": "string",
4861
+ "info": "login name: string",
4862
+ "required": true,
4863
+ "schema": {
4864
+ "title": "login",
4865
+ "type": "string"
4866
+ }
4867
+ },
4868
+ {
4869
+ "name": "body",
4870
+ "type": "array",
4871
+ "info": ": array",
4872
+ "required": true,
4873
+ "schema": {
4874
+ "type": "array",
4875
+ "items": {
4876
+ "type": "string"
4877
+ }
4878
+ }
4879
+ }
4880
+ ],
4881
+ "output": {
4882
+ "name": "result",
4883
+ "type": "object",
4884
+ "description": "A JSON Object containing status, code and the result",
4885
+ "schema": {
4886
+ "title": "result",
4887
+ "type": "object"
4888
+ }
4889
+ },
4890
+ "roles": [
4891
+ "admin"
4892
+ ],
4893
+ "route": {
4894
+ "verb": "POST",
4895
+ "path": "/createUserLabels"
4896
+ },
4897
+ "task": true
4898
+ },
4899
+ {
4900
+ "name": "getMetaDataForSubscribers",
4901
+ "summary": "Gets a tree representing the subscriber attribute schema (metadata)",
4902
+ "description": "Gets a tree representing the subscriber attribute schema (metadata), filtered by the given expressions. It does not need to be qualified in the same way that the device attribute schema does because a subscriber can only have one kind of data tree.",
4903
+ "input": [
4904
+ {
4905
+ "name": "filter",
4906
+ "type": "string",
4907
+ "info": "tree filter, by simple string: Subscriber Subscriber.Address by JSON object: { Subscriber: { Address: \"*\", FullName: \"*\" } }: string",
4908
+ "required": true,
4909
+ "schema": {
4910
+ "title": "filter",
4911
+ "type": "string"
4912
+ }
4913
+ }
4914
+ ],
4915
+ "output": {
4916
+ "name": "result",
4917
+ "type": "object",
4918
+ "description": "A JSON Object containing status, code and the result",
4919
+ "schema": {
4920
+ "title": "result",
4921
+ "type": "object"
4922
+ }
4923
+ },
4924
+ "roles": [
4925
+ "admin"
4926
+ ],
4927
+ "route": {
4928
+ "verb": "POST",
4929
+ "path": "/getMetaDataForSubscribers"
4930
+ },
4931
+ "task": true
4932
+ }
4933
+ ],
4934
+ "views": []
4935
+ }