@itentialopensource/adapter-adtran_mosaic_devicemanager 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +564 -0
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +157 -329
- package/adapterBase.js +549 -879
- package/changelogs/changelog.md +16 -0
- package/metadata.json +47 -0
- package/package.json +23 -25
- package/pronghorn.json +981 -642
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +7211 -0
- package/report/adapter-openapi.yaml +6459 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691507605063.json +120 -0
- package/report/updateReport1692202606613.json +120 -0
- package/report/updateReport1694462023649.json +120 -0
- package/report/updateReport1698421007213.json +120 -0
- package/sampleProperties.json +63 -2
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +338 -112
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- package/workflows/README.md +0 -3
package/CALLS.md
CHANGED
|
@@ -165,5 +165,569 @@ Specific adapter calls are built based on the API of the Adtran Mosaic Device Ma
|
|
|
165
165
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
|
166
166
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
167
167
|
</tr>
|
|
168
|
+
<tr>
|
|
169
|
+
<td style="padding:15px">updateListOfDevicesConnectedToACS(body, callback)</td>
|
|
170
|
+
<td style="padding:15px">Add a new device to the list of devices connected to the ACS</td>
|
|
171
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/?{query}</td>
|
|
172
|
+
<td style="padding:15px">Yes</td>
|
|
173
|
+
</tr>
|
|
174
|
+
<tr>
|
|
175
|
+
<td style="padding:15px">listOfDeviceTypesDefindedInACS(first, count, callback)</td>
|
|
176
|
+
<td style="padding:15px">Retrieves the list of device types defined in the ACS</td>
|
|
177
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types?{query}</td>
|
|
178
|
+
<td style="padding:15px">Yes</td>
|
|
179
|
+
</tr>
|
|
180
|
+
<tr>
|
|
181
|
+
<td style="padding:15px">createDeviceType(body, callback)</td>
|
|
182
|
+
<td style="padding:15px">Add a new device type</td>
|
|
183
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types?{query}</td>
|
|
184
|
+
<td style="padding:15px">Yes</td>
|
|
185
|
+
</tr>
|
|
186
|
+
<tr>
|
|
187
|
+
<td style="padding:15px">listOfDeviceTypesCheckingInToACS(deviceTypeId, callback)</td>
|
|
188
|
+
<td style="padding:15px">Retrieves the list of device types defined in the ACS</td>
|
|
189
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}?{query}</td>
|
|
190
|
+
<td style="padding:15px">Yes</td>
|
|
191
|
+
</tr>
|
|
192
|
+
<tr>
|
|
193
|
+
<td style="padding:15px">modifyDeviceType(deviceTypeId, body, callback)</td>
|
|
194
|
+
<td style="padding:15px">Updates a single device type</td>
|
|
195
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}?{query}</td>
|
|
196
|
+
<td style="padding:15px">Yes</td>
|
|
197
|
+
</tr>
|
|
198
|
+
<tr>
|
|
199
|
+
<td style="padding:15px">removeDeviceType(deviceTypeId, callback)</td>
|
|
200
|
+
<td style="padding:15px">Remove Device Type</td>
|
|
201
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}?{query}</td>
|
|
202
|
+
<td style="padding:15px">Yes</td>
|
|
203
|
+
</tr>
|
|
204
|
+
<tr>
|
|
205
|
+
<td style="padding:15px">deviceStatisticsByManufacturer(callback)</td>
|
|
206
|
+
<td style="padding:15px">Retrieves the counts of different devices by manufacturer</td>
|
|
207
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/manufacturers?{query}</td>
|
|
208
|
+
<td style="padding:15px">Yes</td>
|
|
209
|
+
</tr>
|
|
210
|
+
<tr>
|
|
211
|
+
<td style="padding:15px">countsOfDeviceClassesByManufacturer(manufacturer, callback)</td>
|
|
212
|
+
<td style="padding:15px">Retrieves the counts of different device product classes by manufacturer</td>
|
|
213
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/manufacturers/{pathv1}?{query}</td>
|
|
214
|
+
<td style="padding:15px">Yes</td>
|
|
215
|
+
</tr>
|
|
216
|
+
<tr>
|
|
217
|
+
<td style="padding:15px">dailyDeviceCountsFor7Days(callback)</td>
|
|
218
|
+
<td style="padding:15px">Retrieves the number of new devices seen each day, over the last 7 days</td>
|
|
219
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/recentActivity/newDevices?{query}</td>
|
|
220
|
+
<td style="padding:15px">Yes</td>
|
|
221
|
+
</tr>
|
|
222
|
+
<tr>
|
|
223
|
+
<td style="padding:15px">countOfDevicesCheckedInFor7Days(callback)</td>
|
|
224
|
+
<td style="padding:15px">Retrieves the number of devices that have checked in each day, over the last 7 days</td>
|
|
225
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/recentActivity/devicesInforming?{query}</td>
|
|
226
|
+
<td style="padding:15px">Yes</td>
|
|
227
|
+
</tr>
|
|
228
|
+
<tr>
|
|
229
|
+
<td style="padding:15px">countOfDevicesByDeviceType(first, count, days, callback)</td>
|
|
230
|
+
<td style="padding:15px">Retrieves the number of devices by device type, ordered descending by count</td>
|
|
231
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/deviceTypes?{query}</td>
|
|
232
|
+
<td style="padding:15px">Yes</td>
|
|
233
|
+
</tr>
|
|
234
|
+
<tr>
|
|
235
|
+
<td style="padding:15px">countOfSubscribersByLabel(first, count, callback)</td>
|
|
236
|
+
<td style="padding:15px">Retrieves the number of subscribers by label, ordered descending by count</td>
|
|
237
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/labels/subscriberCounts?{query}</td>
|
|
238
|
+
<td style="padding:15px">Yes</td>
|
|
239
|
+
</tr>
|
|
240
|
+
<tr>
|
|
241
|
+
<td style="padding:15px">deviceSolicitStatus(deviceIds, callback)</td>
|
|
242
|
+
<td style="padding:15px">Gets the solicit status</td>
|
|
243
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/solicits?{query}</td>
|
|
244
|
+
<td style="padding:15px">Yes</td>
|
|
245
|
+
</tr>
|
|
246
|
+
<tr>
|
|
247
|
+
<td style="padding:15px">updateDeviceStatus(deviceId, body, callback)</td>
|
|
248
|
+
<td style="padding:15px">Queues devices to update their status</td>
|
|
249
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/stats/solicits/{pathv1}?{query}</td>
|
|
250
|
+
<td style="padding:15px">Yes</td>
|
|
251
|
+
</tr>
|
|
252
|
+
<tr>
|
|
253
|
+
<td style="padding:15px">firmwareResourceListByDeviceType(deviceTypeId, first, count, deviceType, callback)</td>
|
|
254
|
+
<td style="padding:15px">List the firmware</td>
|
|
255
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware?{query}</td>
|
|
256
|
+
<td style="padding:15px">Yes</td>
|
|
257
|
+
</tr>
|
|
258
|
+
<tr>
|
|
259
|
+
<td style="padding:15px">addFirmwareResourceByDeviceType(deviceTypeId, body, callback)</td>
|
|
260
|
+
<td style="padding:15px">Add new firmware to all devices of the specified type</td>
|
|
261
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware?{query}</td>
|
|
262
|
+
<td style="padding:15px">Yes</td>
|
|
263
|
+
</tr>
|
|
264
|
+
<tr>
|
|
265
|
+
<td style="padding:15px">firmwareDescription(deviceTypeId, firmwareId, callback)</td>
|
|
266
|
+
<td style="padding:15px">Retrieves a single firmware description</td>
|
|
267
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware/{pathv2}?{query}</td>
|
|
268
|
+
<td style="padding:15px">Yes</td>
|
|
269
|
+
</tr>
|
|
270
|
+
<tr>
|
|
271
|
+
<td style="padding:15px">removeFirmwareDescription(deviceTypeId, firmwareId, callback)</td>
|
|
272
|
+
<td style="padding:15px">Removes a single firmware description</td>
|
|
273
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware/{pathv2}?{query}</td>
|
|
274
|
+
<td style="padding:15px">Yes</td>
|
|
275
|
+
</tr>
|
|
276
|
+
<tr>
|
|
277
|
+
<td style="padding:15px">modifyFirmwareDescription(deviceTypeId, firmwareId, body, callback)</td>
|
|
278
|
+
<td style="padding:15px">Updates a single firmware description</td>
|
|
279
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware/{pathv2}?{query}</td>
|
|
280
|
+
<td style="padding:15px">Yes</td>
|
|
281
|
+
</tr>
|
|
282
|
+
<tr>
|
|
283
|
+
<td style="padding:15px">firmwareResourceLabelsByIDForDeviceType(deviceTypeId, firmwareId, callback)</td>
|
|
284
|
+
<td style="padding:15px">Retrieves the labels associated to the firmware resource</td>
|
|
285
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware/{pathv2}/labels?{query}</td>
|
|
286
|
+
<td style="padding:15px">Yes</td>
|
|
287
|
+
</tr>
|
|
288
|
+
<tr>
|
|
289
|
+
<td style="padding:15px">modifyFirmwareLabels(deviceTypeId, firmwareId, body, callback)</td>
|
|
290
|
+
<td style="padding:15px">Updates the labels for a firmware</td>
|
|
291
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/types/{pathv1}/firmware/{pathv2}/labels?{query}</td>
|
|
292
|
+
<td style="padding:15px">Yes</td>
|
|
293
|
+
</tr>
|
|
294
|
+
<tr>
|
|
295
|
+
<td style="padding:15px">countOfDevicesInACSByDeviceType(callback)</td>
|
|
296
|
+
<td style="padding:15px">Retrieves a count of the devices are in the system, broken out by device type</td>
|
|
297
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/summary?{query}</td>
|
|
298
|
+
<td style="padding:15px">Yes</td>
|
|
299
|
+
</tr>
|
|
300
|
+
<tr>
|
|
301
|
+
<td style="padding:15px">deviceDetailsGET(id, callback)</td>
|
|
302
|
+
<td style="padding:15px">Gets basic device information for a device including its identification, inform information and dev</td>
|
|
303
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}?{query}</td>
|
|
304
|
+
<td style="padding:15px">Yes</td>
|
|
305
|
+
</tr>
|
|
306
|
+
<tr>
|
|
307
|
+
<td style="padding:15px">getDeviceTemplate(callback)</td>
|
|
308
|
+
<td style="padding:15px">Get empty JSON template to populate for creating a device</td>
|
|
309
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/api/v1/templates/device?{query}</td>
|
|
310
|
+
<td style="padding:15px">Yes</td>
|
|
311
|
+
</tr>
|
|
312
|
+
<tr>
|
|
313
|
+
<td style="padding:15px">createDevicePOST(body, callback)</td>
|
|
314
|
+
<td style="padding:15px">Creates a new future device</td>
|
|
315
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/api/v1/devices?{query}</td>
|
|
316
|
+
<td style="padding:15px">Yes</td>
|
|
317
|
+
</tr>
|
|
318
|
+
<tr>
|
|
319
|
+
<td style="padding:15px">deleteDevice(id, callback)</td>
|
|
320
|
+
<td style="padding:15px">Delete the device</td>
|
|
321
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/api/v1/devices/{pathv1}?{query}</td>
|
|
322
|
+
<td style="padding:15px">Yes</td>
|
|
323
|
+
</tr>
|
|
324
|
+
<tr>
|
|
325
|
+
<td style="padding:15px">lockDevice(id, callback)</td>
|
|
326
|
+
<td style="padding:15px">Lock a device for web service writes</td>
|
|
327
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/lockDevice?{query}</td>
|
|
328
|
+
<td style="padding:15px">Yes</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr>
|
|
331
|
+
<td style="padding:15px">deviceAttributeList(id, recursive, withValues, withLeaves, attributeDate, filter, callback)</td>
|
|
332
|
+
<td style="padding:15px">Gets a list of device attributes</td>
|
|
333
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/attributes/?{query}</td>
|
|
334
|
+
<td style="padding:15px">Yes</td>
|
|
335
|
+
</tr>
|
|
336
|
+
<tr>
|
|
337
|
+
<td style="padding:15px">modifyDeviceAttributes(id, reboot, body, callback)</td>
|
|
338
|
+
<td style="padding:15px">Creates an attribute update action which sets the attributes to the specified values and adds it to</td>
|
|
339
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/attributes/?{query}</td>
|
|
340
|
+
<td style="padding:15px">Yes</td>
|
|
341
|
+
</tr>
|
|
342
|
+
<tr>
|
|
343
|
+
<td style="padding:15px">createDeviceAttributes(id, reboot, body, callback)</td>
|
|
344
|
+
<td style="padding:15px">Creates an attribute create action which creates new objects under the 'parent' attribute and adds</td>
|
|
345
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/attributes/?{query}</td>
|
|
346
|
+
<td style="padding:15px">Yes</td>
|
|
347
|
+
</tr>
|
|
348
|
+
<tr>
|
|
349
|
+
<td style="padding:15px">removeDeviceAttributes(id, callback)</td>
|
|
350
|
+
<td style="padding:15px">Creates an attribute delete action which deletes the given objects and adds it to the device's pend</td>
|
|
351
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/attributes/?{query}</td>
|
|
352
|
+
<td style="padding:15px">Yes</td>
|
|
353
|
+
</tr>
|
|
354
|
+
<tr>
|
|
355
|
+
<td style="padding:15px">requestDeviceAttributeRefresh(id, body, callback)</td>
|
|
356
|
+
<td style="padding:15px">Creates an action which will cause the device to send values for the requested attributes</td>
|
|
357
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/attributes/sync?{query}</td>
|
|
358
|
+
<td style="padding:15px">Yes</td>
|
|
359
|
+
</tr>
|
|
360
|
+
<tr>
|
|
361
|
+
<td style="padding:15px">deviceNewActionList(id, since, callback)</td>
|
|
362
|
+
<td style="padding:15px">Retrieves a list of recent actions added to this device</td>
|
|
363
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/actions?{query}</td>
|
|
364
|
+
<td style="padding:15px">Yes</td>
|
|
365
|
+
</tr>
|
|
366
|
+
<tr>
|
|
367
|
+
<td style="padding:15px">queuedActionDetail(id, scriptRunId, callback)</td>
|
|
368
|
+
<td style="padding:15px">Retrieves the detail for a single action which has been added to a device</td>
|
|
369
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/actions/{pathv2}?{query}</td>
|
|
370
|
+
<td style="padding:15px">Yes</td>
|
|
371
|
+
</tr>
|
|
372
|
+
<tr>
|
|
373
|
+
<td style="padding:15px">modifyScriptIDAndParametersForQueuedAction(id, scriptRunId, body, callback)</td>
|
|
374
|
+
<td style="padding:15px">Updates the script ID and parameters for a single queued action</td>
|
|
375
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/actions/{pathv2}?{query}</td>
|
|
376
|
+
<td style="padding:15px">Yes</td>
|
|
377
|
+
</tr>
|
|
378
|
+
<tr>
|
|
379
|
+
<td style="padding:15px">queuedAction(id, scriptRunId, callback)</td>
|
|
380
|
+
<td style="padding:15px">Removes a single queued action. Only scripts created by the current user and are "SCHEDULED" can be</td>
|
|
381
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/actions/{pathv2}?{query}</td>
|
|
382
|
+
<td style="padding:15px">Yes</td>
|
|
383
|
+
</tr>
|
|
384
|
+
<tr>
|
|
385
|
+
<td style="padding:15px">triggerDeviceEvent(id, body, callback)</td>
|
|
386
|
+
<td style="padding:15px">Fires an event for the related device</td>
|
|
387
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/events?{query}</td>
|
|
388
|
+
<td style="padding:15px">Yes</td>
|
|
389
|
+
</tr>
|
|
390
|
+
<tr>
|
|
391
|
+
<td style="padding:15px">deviceLabels(id, callback)</td>
|
|
392
|
+
<td style="padding:15px">Gets the labels for a device</td>
|
|
393
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/labels?{query}</td>
|
|
394
|
+
<td style="padding:15px">Yes</td>
|
|
395
|
+
</tr>
|
|
396
|
+
<tr>
|
|
397
|
+
<td style="padding:15px">modifyDeviceLabels(id, body, callback)</td>
|
|
398
|
+
<td style="padding:15px">Sets all labels for a device</td>
|
|
399
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/labels?{query}</td>
|
|
400
|
+
<td style="padding:15px">Yes</td>
|
|
401
|
+
</tr>
|
|
402
|
+
<tr>
|
|
403
|
+
<td style="padding:15px">createDeviceLabels(id, body, callback)</td>
|
|
404
|
+
<td style="padding:15px">Adds the given labels for a device</td>
|
|
405
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/labels?{query}</td>
|
|
406
|
+
<td style="padding:15px">Yes</td>
|
|
407
|
+
</tr>
|
|
408
|
+
<tr>
|
|
409
|
+
<td style="padding:15px">deviceStatisticsSummary(id, callback)</td>
|
|
410
|
+
<td style="padding:15px">Returns a summary of miscellaneous statistics about a device</td>
|
|
411
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/activity?{query}</td>
|
|
412
|
+
<td style="padding:15px">Yes</td>
|
|
413
|
+
</tr>
|
|
414
|
+
<tr>
|
|
415
|
+
<td style="padding:15px">solicitStatus(id, callback)</td>
|
|
416
|
+
<td style="padding:15px">Gets the solicit status</td>
|
|
417
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/solicit?{query}</td>
|
|
418
|
+
<td style="padding:15px">Yes</td>
|
|
419
|
+
</tr>
|
|
420
|
+
<tr>
|
|
421
|
+
<td style="padding:15px">createDeviceUpdateQueue(id, body, callback)</td>
|
|
422
|
+
<td style="padding:15px">Queues devices to update their status</td>
|
|
423
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/solicit?{query}</td>
|
|
424
|
+
<td style="padding:15px">Yes</td>
|
|
425
|
+
</tr>
|
|
426
|
+
<tr>
|
|
427
|
+
<td style="padding:15px">deviceSessionTraceList(id, callback)</td>
|
|
428
|
+
<td style="padding:15px">Returns a summary of recent trace logs for the device</td>
|
|
429
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/trace?{query}</td>
|
|
430
|
+
<td style="padding:15px">Yes</td>
|
|
431
|
+
</tr>
|
|
432
|
+
<tr>
|
|
433
|
+
<td style="padding:15px">createDeviceTraceLog(id, body, callback)</td>
|
|
434
|
+
<td style="padding:15px">Begin a new trace log for the device</td>
|
|
435
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/trace?{query}</td>
|
|
436
|
+
<td style="padding:15px">Yes</td>
|
|
437
|
+
</tr>
|
|
438
|
+
<tr>
|
|
439
|
+
<td style="padding:15px">deviceTraceLevel(id, callback)</td>
|
|
440
|
+
<td style="padding:15px">Gets the logging level for the device</td>
|
|
441
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/trace/level?{query}</td>
|
|
442
|
+
<td style="padding:15px">Yes</td>
|
|
443
|
+
</tr>
|
|
444
|
+
<tr>
|
|
445
|
+
<td style="padding:15px">configureDeviceLoggingLevel(id, body, callback)</td>
|
|
446
|
+
<td style="padding:15px">Configure logging level for the device</td>
|
|
447
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/trace/level?{query}</td>
|
|
448
|
+
<td style="padding:15px">Yes</td>
|
|
449
|
+
</tr>
|
|
450
|
+
<tr>
|
|
451
|
+
<td style="padding:15px">deviceSessionTraceSummary(id, traceId, callback)</td>
|
|
452
|
+
<td style="padding:15px">Returns a summary of the session trace log for a device</td>
|
|
453
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/trace/level/{pathv2}?{query}</td>
|
|
454
|
+
<td style="padding:15px">Yes</td>
|
|
455
|
+
</tr>
|
|
456
|
+
<tr>
|
|
457
|
+
<td style="padding:15px">deviceSessionTraceDetail(id, traceId, callback)</td>
|
|
458
|
+
<td style="padding:15px">Retrieve the details of a single CPE session</td>
|
|
459
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/devices/{pathv1}/trace/level{pathv2}/log?{query}</td>
|
|
460
|
+
<td style="padding:15px">Yes</td>
|
|
461
|
+
</tr>
|
|
462
|
+
<tr>
|
|
463
|
+
<td style="padding:15px">accessDevicesOnActivationServer(first, count, q, callback)</td>
|
|
464
|
+
<td style="padding:15px">Gets devices known by the activation server</td>
|
|
465
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/activation/devices?{query}</td>
|
|
466
|
+
<td style="padding:15px">Yes</td>
|
|
467
|
+
</tr>
|
|
468
|
+
<tr>
|
|
469
|
+
<td style="padding:15px">aCSSubscriberList(callback)</td>
|
|
470
|
+
<td style="padding:15px">Retrieves a list of subscribers in the system</td>
|
|
471
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers?{query}</td>
|
|
472
|
+
<td style="padding:15px">Yes</td>
|
|
473
|
+
</tr>
|
|
474
|
+
<tr>
|
|
475
|
+
<td style="padding:15px">createNewACSSubscriberPOST(body, callback)</td>
|
|
476
|
+
<td style="padding:15px">Creates a new subscriber</td>
|
|
477
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/api/v2/subscribers?{query}</td>
|
|
478
|
+
<td style="padding:15px">Yes</td>
|
|
479
|
+
</tr>
|
|
480
|
+
<tr>
|
|
481
|
+
<td style="padding:15px">requestPasswordChange(body, callback)</td>
|
|
482
|
+
<td style="padding:15px">Requests an automated change of password with email notification</td>
|
|
483
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/resetPassword?{query}</td>
|
|
484
|
+
<td style="padding:15px">Yes</td>
|
|
485
|
+
</tr>
|
|
486
|
+
<tr>
|
|
487
|
+
<td style="padding:15px">statisticsForSubscribers(callback)</td>
|
|
488
|
+
<td style="padding:15px">Gets summary information for all active subscribers</td>
|
|
489
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/summary?{query}</td>
|
|
490
|
+
<td style="padding:15px">Yes</td>
|
|
491
|
+
</tr>
|
|
492
|
+
<tr>
|
|
493
|
+
<td style="padding:15px">statisticsForSpecificSubscriber(personId, callback)</td>
|
|
494
|
+
<td style="padding:15px">Retrieve a subscriber indicated by {personId}.</td>
|
|
495
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}?{query}</td>
|
|
496
|
+
<td style="padding:15px">Yes</td>
|
|
497
|
+
</tr>
|
|
498
|
+
<tr>
|
|
499
|
+
<td style="padding:15px">modifySubscriber(personId, body, callback)</td>
|
|
500
|
+
<td style="padding:15px">Update a subscriber</td>
|
|
501
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}?{query}</td>
|
|
502
|
+
<td style="padding:15px">Yes</td>
|
|
503
|
+
</tr>
|
|
504
|
+
<tr>
|
|
505
|
+
<td style="padding:15px">deleteSubscriber(personId, callback)</td>
|
|
506
|
+
<td style="padding:15px">Delete an existing subscriber</td>
|
|
507
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}?{query}</td>
|
|
508
|
+
<td style="padding:15px">Yes</td>
|
|
509
|
+
</tr>
|
|
510
|
+
<tr>
|
|
511
|
+
<td style="padding:15px">subscriberLabelSet(personId, callback)</td>
|
|
512
|
+
<td style="padding:15px">Retrieves the subscriber's set of labels</td>
|
|
513
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels?{query}</td>
|
|
514
|
+
<td style="padding:15px">Yes</td>
|
|
515
|
+
</tr>
|
|
516
|
+
<tr>
|
|
517
|
+
<td style="padding:15px">defineLabelsForSubscriber(personId, body, callback)</td>
|
|
518
|
+
<td style="padding:15px">Sets the labels for a subscriber</td>
|
|
519
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels?{query}</td>
|
|
520
|
+
<td style="padding:15px">Yes</td>
|
|
521
|
+
</tr>
|
|
522
|
+
<tr>
|
|
523
|
+
<td style="padding:15px">createSubscriberLabels(personId, body, callback)</td>
|
|
524
|
+
<td style="padding:15px">Adds the labels for a subscriber</td>
|
|
525
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels?{query}</td>
|
|
526
|
+
<td style="padding:15px">Yes</td>
|
|
527
|
+
</tr>
|
|
528
|
+
<tr>
|
|
529
|
+
<td style="padding:15px">subscriberManagementGroups(personId, cA, q, callback)</td>
|
|
530
|
+
<td style="padding:15px">Retrieves the list of management groups associated to the subscriber</td>
|
|
531
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups?{query}</td>
|
|
532
|
+
<td style="padding:15px">Yes</td>
|
|
533
|
+
</tr>
|
|
534
|
+
<tr>
|
|
535
|
+
<td style="padding:15px">createSubscriberManagementGroup(personId, body, callback)</td>
|
|
536
|
+
<td style="padding:15px">Creates a management group for the subscriber.</td>
|
|
537
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups?{query}</td>
|
|
538
|
+
<td style="padding:15px">Yes</td>
|
|
539
|
+
</tr>
|
|
540
|
+
<tr>
|
|
541
|
+
<td style="padding:15px">subscriberManagementGroupDetails(personId, managementGroupId, callback)</td>
|
|
542
|
+
<td style="padding:15px">Returns a management group for the subscriber</td>
|
|
543
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}?{query}</td>
|
|
544
|
+
<td style="padding:15px">Yes</td>
|
|
545
|
+
</tr>
|
|
546
|
+
<tr>
|
|
547
|
+
<td style="padding:15px">modifySubscriberManagementGroup(personId, managementGroupId, body, callback)</td>
|
|
548
|
+
<td style="padding:15px">Updates a management group for the subscriber</td>
|
|
549
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}?{query}</td>
|
|
550
|
+
<td style="padding:15px">Yes</td>
|
|
551
|
+
</tr>
|
|
552
|
+
<tr>
|
|
553
|
+
<td style="padding:15px">subscriberManagementGroup(personId, managementGroupId, callback)</td>
|
|
554
|
+
<td style="padding:15px">Deletes this management group</td>
|
|
555
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}?{query}</td>
|
|
556
|
+
<td style="padding:15px">Yes</td>
|
|
557
|
+
</tr>
|
|
558
|
+
<tr>
|
|
559
|
+
<td style="padding:15px">subscriptionsForManagementGroup(personId, managementGroupId, callback)</td>
|
|
560
|
+
<td style="padding:15px">Lists the subscriptions in the current management group</td>
|
|
561
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/subscriptions?{query}</td>
|
|
562
|
+
<td style="padding:15px">Yes</td>
|
|
563
|
+
</tr>
|
|
564
|
+
<tr>
|
|
565
|
+
<td style="padding:15px">addSubscriptionToManagementGroup(personId, managementGroupId, body, callback)</td>
|
|
566
|
+
<td style="padding:15px">Adds a subscription to the management group</td>
|
|
567
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/subscriptions?{query}</td>
|
|
568
|
+
<td style="padding:15px">Yes</td>
|
|
569
|
+
</tr>
|
|
570
|
+
<tr>
|
|
571
|
+
<td style="padding:15px">serviceSubscriptionDetails(personId, managementGroupId, packageName, callback)</td>
|
|
572
|
+
<td style="padding:15px">Retrieve information about a subscription. to a service with the specified {packageName}</td>
|
|
573
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/subscription/{pathv3}?{query}</td>
|
|
574
|
+
<td style="padding:15px">Yes</td>
|
|
575
|
+
</tr>
|
|
576
|
+
<tr>
|
|
577
|
+
<td style="padding:15px">subscriptionPackageStatus(personId, managementGroupId, packageName, body, callback)</td>
|
|
578
|
+
<td style="padding:15px">Updates the status of the given subscription package</td>
|
|
579
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/subscription/{pathv3}?{query}</td>
|
|
580
|
+
<td style="padding:15px">Yes</td>
|
|
581
|
+
</tr>
|
|
582
|
+
<tr>
|
|
583
|
+
<td style="padding:15px">subscriptionPackage(personId, managementGroupId, packageName, callback)</td>
|
|
584
|
+
<td style="padding:15px">Deletes the specified subscription</td>
|
|
585
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/subscription/{pathv3}?{query}</td>
|
|
586
|
+
<td style="padding:15px">Yes</td>
|
|
587
|
+
</tr>
|
|
588
|
+
<tr>
|
|
589
|
+
<td style="padding:15px">managementGroupDeviceSignature(personId, managementGroupId, callback)</td>
|
|
590
|
+
<td style="padding:15px">Returns the device signature of the management group</td>
|
|
591
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/deviceSignature?{query}</td>
|
|
592
|
+
<td style="padding:15px">Yes</td>
|
|
593
|
+
</tr>
|
|
594
|
+
<tr>
|
|
595
|
+
<td style="padding:15px">managementGroup(personId, managementGroupId, body, callback)</td>
|
|
596
|
+
<td style="padding:15px">Updates the properties of this management group</td>
|
|
597
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/labels/managementGroups/{pathv2}/deviceSignature?{query}</td>
|
|
598
|
+
<td style="padding:15px">Yes</td>
|
|
599
|
+
</tr>
|
|
600
|
+
<tr>
|
|
601
|
+
<td style="padding:15px">subscriberAttributeTree(personId, callback)</td>
|
|
602
|
+
<td style="padding:15px">Retrieves the subscriber's attribute tree</td>
|
|
603
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/attributes?{query}</td>
|
|
604
|
+
<td style="padding:15px">Yes</td>
|
|
605
|
+
</tr>
|
|
606
|
+
<tr>
|
|
607
|
+
<td style="padding:15px">subscriberAttribute(personId, body, callback)</td>
|
|
608
|
+
<td style="padding:15px">Updates the attributes for the given subscriber</td>
|
|
609
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/attributes?{query}</td>
|
|
610
|
+
<td style="padding:15px">Yes</td>
|
|
611
|
+
</tr>
|
|
612
|
+
<tr>
|
|
613
|
+
<td style="padding:15px">subscriberAttributes(personId, body, callback)</td>
|
|
614
|
+
<td style="padding:15px">Creates the attributes for the given subscriber</td>
|
|
615
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/attributes?{query}</td>
|
|
616
|
+
<td style="padding:15px">Yes</td>
|
|
617
|
+
</tr>
|
|
618
|
+
<tr>
|
|
619
|
+
<td style="padding:15px">deleteSubscriberAttributes(personId, name, callback)</td>
|
|
620
|
+
<td style="padding:15px">Removes a portion of the attribute tree for the given subscriber</td>
|
|
621
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/attributes?{query}</td>
|
|
622
|
+
<td style="padding:15px">Yes</td>
|
|
623
|
+
</tr>
|
|
624
|
+
<tr>
|
|
625
|
+
<td style="padding:15px">changePassword(personId, body, callback)</td>
|
|
626
|
+
<td style="padding:15px">Self-administered subscriber password within the control panel</td>
|
|
627
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/subscribers/{pathv1}/changePassword?{query}</td>
|
|
628
|
+
<td style="padding:15px">Yes</td>
|
|
629
|
+
</tr>
|
|
630
|
+
<tr>
|
|
631
|
+
<td style="padding:15px">createSubscriberLoginSessions(body, callback)</td>
|
|
632
|
+
<td style="padding:15px">Creates Subscriber Login Session</td>
|
|
633
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/control-panel/session?{query}</td>
|
|
634
|
+
<td style="padding:15px">Yes</td>
|
|
635
|
+
</tr>
|
|
636
|
+
<tr>
|
|
637
|
+
<td style="padding:15px">subscriberLoginSession(tokenId, body, callback)</td>
|
|
638
|
+
<td style="padding:15px">Updates a subscriber's login session</td>
|
|
639
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/control-panel/session/{pathv1}?{query}</td>
|
|
640
|
+
<td style="padding:15px">Yes</td>
|
|
641
|
+
</tr>
|
|
642
|
+
<tr>
|
|
643
|
+
<td style="padding:15px">deleteSubscriberLoginSession(tokenId, callback)</td>
|
|
644
|
+
<td style="padding:15px">Removes the session</td>
|
|
645
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/control-panel/session/{pathv1}?{query}</td>
|
|
646
|
+
<td style="padding:15px">Yes</td>
|
|
647
|
+
</tr>
|
|
648
|
+
<tr>
|
|
649
|
+
<td style="padding:15px">sessionExpirationStatus(callback)</td>
|
|
650
|
+
<td style="padding:15px">Gets the session expiration status</td>
|
|
651
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/control-panel/session/?{query}</td>
|
|
652
|
+
<td style="padding:15px">Yes</td>
|
|
653
|
+
</tr>
|
|
654
|
+
<tr>
|
|
655
|
+
<td style="padding:15px">aCSUserListGET(callback)</td>
|
|
656
|
+
<td style="padding:15px">Lists the set of ACS users</td>
|
|
657
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users?{query}</td>
|
|
658
|
+
<td style="padding:15px">Yes</td>
|
|
659
|
+
</tr>
|
|
660
|
+
<tr>
|
|
661
|
+
<td style="padding:15px">modifyACSUserList(body, callback)</td>
|
|
662
|
+
<td style="padding:15px">Add a user to the ACS</td>
|
|
663
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users?{query}</td>
|
|
664
|
+
<td style="padding:15px">Yes</td>
|
|
665
|
+
</tr>
|
|
666
|
+
<tr>
|
|
667
|
+
<td style="padding:15px">userDetails(login, callback)</td>
|
|
668
|
+
<td style="padding:15px">Gets user details for the given login name</td>
|
|
669
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}?{query}</td>
|
|
670
|
+
<td style="padding:15px">Yes</td>
|
|
671
|
+
</tr>
|
|
672
|
+
<tr>
|
|
673
|
+
<td style="padding:15px">modifyUserDetails(login, body, callback)</td>
|
|
674
|
+
<td style="padding:15px">Change the user's details</td>
|
|
675
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}?{query}</td>
|
|
676
|
+
<td style="padding:15px">Yes</td>
|
|
677
|
+
</tr>
|
|
678
|
+
<tr>
|
|
679
|
+
<td style="padding:15px">deleteUser(login, callback)</td>
|
|
680
|
+
<td style="padding:15px">Removes a user</td>
|
|
681
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}?{query}</td>
|
|
682
|
+
<td style="padding:15px">Yes</td>
|
|
683
|
+
</tr>
|
|
684
|
+
<tr>
|
|
685
|
+
<td style="padding:15px">userNotificationsForPast10Minutes(login, callback)</td>
|
|
686
|
+
<td style="padding:15px">Gets the current set of notifications occurred in the last 10 minutes</td>
|
|
687
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/notifications?{query}</td>
|
|
688
|
+
<td style="padding:15px">Yes</td>
|
|
689
|
+
</tr>
|
|
690
|
+
<tr>
|
|
691
|
+
<td style="padding:15px">createUserNotification(login, body, callback)</td>
|
|
692
|
+
<td style="padding:15px">Adds a user notification</td>
|
|
693
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/notifications?{query}</td>
|
|
694
|
+
<td style="padding:15px">Yes</td>
|
|
695
|
+
</tr>
|
|
696
|
+
<tr>
|
|
697
|
+
<td style="padding:15px">modifyUserPreferences(login, body, callback)</td>
|
|
698
|
+
<td style="padding:15px">Updates the user's preferences</td>
|
|
699
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/preferences?{query}</td>
|
|
700
|
+
<td style="padding:15px">Yes</td>
|
|
701
|
+
</tr>
|
|
702
|
+
<tr>
|
|
703
|
+
<td style="padding:15px">getUserRoles(login, callback)</td>
|
|
704
|
+
<td style="padding:15px">Lists the user's set of roles</td>
|
|
705
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/roles?{query}</td>
|
|
706
|
+
<td style="padding:15px">Yes</td>
|
|
707
|
+
</tr>
|
|
708
|
+
<tr>
|
|
709
|
+
<td style="padding:15px">createUserRoles(login, body, callback)</td>
|
|
710
|
+
<td style="padding:15px">Updates user's roles</td>
|
|
711
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/roles?{query}</td>
|
|
712
|
+
<td style="padding:15px">Yes</td>
|
|
713
|
+
</tr>
|
|
714
|
+
<tr>
|
|
715
|
+
<td style="padding:15px">getUserLabels(login, callback)</td>
|
|
716
|
+
<td style="padding:15px">Gets the labels for a user</td>
|
|
717
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/labels?{query}</td>
|
|
718
|
+
<td style="padding:15px">Yes</td>
|
|
719
|
+
</tr>
|
|
720
|
+
<tr>
|
|
721
|
+
<td style="padding:15px">createUserLabels(login, body, callback)</td>
|
|
722
|
+
<td style="padding:15px">Updates the labels for a user</td>
|
|
723
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/users/{pathv1}/labels?{query}</td>
|
|
724
|
+
<td style="padding:15px">Yes</td>
|
|
725
|
+
</tr>
|
|
726
|
+
<tr>
|
|
727
|
+
<td style="padding:15px">getMetaDataForSubscribers(filter, callback)</td>
|
|
728
|
+
<td style="padding:15px">Gets a tree representing the subscriber attribute schema (metadata)</td>
|
|
729
|
+
<td style="padding:15px">{base_path}/{version}/prime-home/portal/schema/device/subscriber?{query}</td>
|
|
730
|
+
<td style="padding:15px">Yes</td>
|
|
731
|
+
</tr>
|
|
168
732
|
</table>
|
|
169
733
|
<br>
|
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,20 @@
|
|
|
1
1
|
|
|
2
|
+
## 0.3.1 [02-28-2024]
|
|
3
|
+
|
|
4
|
+
* Changes made at 2024.02.28_11:23AM
|
|
5
|
+
|
|
6
|
+
See merge request itentialopensource/adapters/controller-orchestrator/adapter-adtran_mosaic_devicemanager!3
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 0.3.0 [12-28-2023]
|
|
11
|
+
|
|
12
|
+
* Adapter Engine has been updated and the changes are being migrated to the adapter
|
|
13
|
+
|
|
14
|
+
See merge request itentialopensource/adapters/controller-orchestrator/adapter-adtran_mosaic_devicemanager!2
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
2
18
|
## 0.2.0 [05-21-2022]
|
|
3
19
|
|
|
4
20
|
* Migration to the latest Adapter Foundation
|