<work in progress>

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”.

Device

These APIs 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

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

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

Responses

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

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

Responses

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.

Parameters

Responses

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

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

Parameters

Responses

POST /device/getDevicesFromPool (Get Device Details from Pool)

This API gets the list of devices that matches the given search criteria and gateway mac address of the device. The input to the REST API  is device mac address. The search criteria include device status, feature name, device group name, head end name, ip type, consider devices excluded from pool and skip device group application/json fields.

Responses

GET /device/getEcmMacAddress (Get Device ECM MAC Address)

This API gets ecm mac address of the device. The input to the REST API is device mac address.

Parameters

Responses

GET /device/getGatewayMacAddress (Get Device Gateway MAC Address)

This API gets gateway mac address of the device. The input to the REST API is device mac address. This will return the mac address of the gateway device to which the given client device is connected.

Parameters

Responses

GET /device/getIpAddress (Get Device IP Address)

This API G=gets IP address of the device. The input to the REST API  is device mac address and mac type.

Mac type refers to the type of mac address. The expected values are ‘DEVICE’ and ‘ECM’.

‘DEVICE’ refers to mac address of the device.

‘ECM’ refers to ecm mac address of the device.

Parameters

Responses

POST /device/putDeviceToInUsePool (Add Device to Pool)

This API updates the device status to IN_USE. This refers that the device is being in use for test execution in Automatics. Devices with status IN_USE will not be considered for other test executions. This facilitates  exclusive access to devices during testing.

Responses

POST /device/removeDeviceFromInUsePool (Remove Device from Pool)

This API updates the device status to GOOD. After test execution, Automatics will update the status of the device to ‘GOOD’. This means  that the device is available for the next test execution.

Responses

Device Category

These APIs handle requests for device category.

POST /deviceCategory/add (Add a new Device Category)

This API is used to add a new Device Category to the Device Manager application. Valid values are RDKV, RDKV, and RDKC.

Responses

GET /deviceCategory/all (Returns all the Device Categories)

This API returns all the Device Category details configured in the Device Manager application.

Responses

POST /deviceCategory/delete (Delete an existing Device Category)

This API is used to delete an existing Device Category from the Device Manager application.

Responses

Device Features

These APIs handle requests for device features.

POST /deviceFeature/add (Add a new Device Features)

This API adds device features to the system. The field ‘specialFeature’ specifies whether the given feature is  a special device feature. Valid values are ‘Y’ and ‘N’. ‘Y’ refers to special feature and ‘N’ refers to not-a-special feature. This field has no impact on fetching device data currently; however, this is added as part of future enhancement to the Device Manager application.

Responses

GET /deviceFeature/all (Returns all the Device Features)

This API returns all the device features available in the Device Manager application.

Responses

POST /deviceFeature/delete (Delete an existing Device Feature)

This API is used to delete an existing device feature from the Device Manager application.

Responses

Device Group

POST /deviceGroup/add (Add a new Device Group)

This API adds a device group to the Device Manager application. This is done for logical grouping and managing access to the devices. Admin must first configure these groups in Automatics Orchestration and then must map the device groups to the users. This will allow users to execute tests only from mapped device groups.

Responses