You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

<work in progress>

Overview

Device Manager, as the name suggests, is an application to manage different devices by fetching the device details, adding devices, adding device groups, managing device reservations etc.

Please note: All the non-mandatory request fields are marked as “optional”.

Tags

Tag NameDesscription
Device GroupAPIs which handle requests for device group.
Device CategoryAPIs which handle requests for device category.
Device FeatureAPIs which handle requests for device feature.
DeviceAPIs which handle requests for device details.
Device ModelAPIs which handle requests for device models.
Head EndAPIs which handle requests for head end.
Device ManagementAPI for Device Management.
UserAPIs which handle requests for user management.

Paths

Device

 APIs which handle requests for device details.

POST /device/add (Add new Device Details)

This API adds a device to the Device Manager database. Devices to be used in the Automatics System should be configured in Device Manager. These devices are provided to Automatics Orchestration during test execution.

Before adding a device, the user must  add Head End (/headEnd/add), Device Group (/deviceGroup/add), Device Feature (/deviceFeature/add) and Device Model(/deviceModel/add) to Device Manager. These values will be provided as the input to the device details fields request.

Responses

Code

Description

Links

200

OK

Content

No Links

201

Created

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404

Not Found

No Links

GET /device/all (Returns all the Device Details)

This API lists all devices configured in the Device Manager application.

Responses

CodeDescription

Links

200

OK

Content

application/json/

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404

Not Found

No Links

POST /device/delete (Delete existing Device Details)

This API deletes the device from Device Manager application. The input given to the REST API is mac address and it deletes the device with given mac address.

Responses

Code

Description

Links

200

OK

Content

No Links

201

Created

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404

Not Found

No Links

GET /device/getConnectedHeadEnd (Get Device Head End Using MAC Address)

This API gets name of the head end system to which the device is connected. The input to the REST API  is the device mac address.

Parameters

TypeNameDescriptionSchema
query

mac

required

macstring

Responses

Code

Description

Links

200

OK

Content

application/json/

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404Not Found

No Links

GET /device/getDeviceDetailsFromEcmMacAddress (Get Device Details Using MAC Address and ECM MAC Type)

This API gets details of the device with given ecm mac address from Device Manager application. Input to the REST API is device ecm mac address.


  • No labels