Device Manager, 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”.

Swagger UI is integrated to Device Manager application and it could be used to visualize all the APIs in this application and Swagger UI can be used to invoke all the APIs in this application.

Device Manager documentation and tryout feature can used by going to the URL : “{protocol}://{host:port}/DeviceManager/swagger-ui.html.

Swagger UI can be used to visualize and invoke all the API in this application.Follow below steps to invoke API in this application.

• Navigate to {protocol}://{host:port}/DeviceManager/swagger-ui.html.
• List of API in this application will be listed as shown below.

• Click on the required API need to executed (Ex:- deviceModel→POST/deviceModel/add).

• Click on Try it out option to execute API by providing valid input parameters if it is required and click on execute option to run API on this application as shown below.

• API responses are received and displayed as shown below.

List of APIs defined in the application and type of responses received for each API are available at Paths.

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.

Parameters

Responses

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

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

Responses

POST /device/update (Update an existing Device Details)

This API update the 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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

Responses

POST/device/sshDetailsByIpAddress(Get ssh details by ipaddress)

This API gets sshconnection details  of the device by ipaddress . The input to the  API is device ip address. This will return the ssh connection details like sshUserName,sshPassword,sshPrivateKeyLocation,sshAuthType and sshPortnumber

Parameters

Responses

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.

Parameters

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.

Parameters

Responses

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.

Parameters

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.

Parameters

Responses

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.

Parameters

Responses

GET /deviceGroup/all (Returns all the Device Groups)

This API returns all the Device Group details in the Device Manager application.

Responses

POST /deviceGroup/delete (Delete an existing Device Group)

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

Parameters

Responses

These APIs handle requests for device management.

POST /deviceManagement/device/allocationStatus (API to fetch device allocation status)

This API can be used to fetch device allocation status from the Device Manager application.

Parameters

Responses

POST /deviceManagement/device/lock (API to Lock a particular device)

This API can be invoked by passing the MAC address of the device to lock the corresponding device

Parameters

Responses

POST /deviceManagement/device/releases (API to get Device Account details)

This API can be used to fetch device account details from the application

Parameters

Responses

POST /deviceManagement/device/updateAllocationDuration (API to update Device lock duration)

This API can be used to update Device lock duration

Parameters

Responses

POST /deviceManagement/getAccountDetails (API to get Device Account details)

This API can be used to fetch Device Account Details from the application.

Parameters

Responses

POST /deviceManagement/getDeviceDetails (API to get device details)

This API can be used to fetch Device Details from the application.

Parameters

Responses

POST /deviceManagement/getDeviceInfo (API to fetch the details of the given device)

This API will fetch the details of the given device from the application.

Parameters

Responses

This API will return all the properties of the device as per the MAC Address and properties present in the request.

Parameters

Responses

POST /deviceManagement/queryDevices (API to query a particular device)

This API will query and return the device list from the application

Parameters

Responses

POST /deviceManagement/validateDevice (API to validate the device)

This API will validate the device based on the given details.

Parameters

Responses

These APIs which handles requests for device models.

POST /deviceModel/add (Add a new Device Model)

This API can be used to add a new device model to the application

Parameters

Responses

GET /deviceModel/all (Returns all the Device Models)

This API returns all the Device Model configured in the application

Responses

POST /deviceModel/delete (Delete an existing Device Model)

This API can be used to delete an existing Device Model from the application.

Parameters

Responses

These APIs handles requests for Head end.

POST /headEnd/add (Add a new Device Head End)

Adds head end system name to which devices are connected.

Parameters

Responses

GET /headEnd/all (Returns all the Device Head Ends)

This API returns all the Device Head Ends configured in the application

Responses

POST /headEnd/delete (Delete an existing Device Head End)

This API can be used to delete an existing Device Head End from the application

Parameters

Responses

These APIs handles requests for user management.

POST /users/add (Add a new User Details)

This API is used to add user details

Parameters

Responses

GET /users/all (Returns all the User Details)

Gets all users configured in Device Manager application. This support is added for future enhancement.

Responses

POST /users/delete (Delete an existing User)

This API can be used to delete user from device manager application.

Parameters

Responses

POST /users/getUserDetailsFromUserId (Get User Details of an existing User using userId )

This API can be used to existing user details using UserId.

Parameters

Responses

These APIs handles requests for Configuartion management.

GET /config (Get all master config details available on the DB)

API can be called to fetch master config details

Responses

POST/config (API to save config details)

API can be called to update / save configuration

Parameters

Responses

POST/config/getConfigValue (API to get config detail by config name)

API can be called to fetch details saved for the provided config name

Parameters

Responses

API’s which handles requests for health check

POST /healthCheck  (Schedule Devices for health check)

Schedule Device Health check

Parameters

Responses

DELETE /healthCheck/{cancelType}/{executionDetailsId}/{userId} (Cancel scheduled execution)

API to Cancel Scheduled health check execution

Parameters

Responses

POST /healthCheck/addDevice (API to add new devices to scheduled execution)

This API can be called to add devices to the scheduled execution

Parameters

Responses

GET /healthCheck/details (API to fetch list of Execution scheduled)

API to fetch List of Execution scheduled

Parameters

Responses

GET /healthCheck/execDetails (API to get execution details)

This API can be used to fetch the execution details from the application

Parameters

Responses

GET /healthCheck/getDeviceDetailsByExecDtlsId (API to fetch device details for the scheduled execution)

This API can be used to fetch the execution details from the application

Parameters

Responses

These APIs handles requests for Power manager management.

POST /powerManager/add (Add a new Power Manager Details)

This API is used to add power manager details

Parameters

Responses

GET /powerManager/all (Returns all the Power ManagerDetails)

Gets all power manager details configured in Device Manager application.

Responses

POST /powerManager/delete (Delete an existing Power Manager)

This API can be used to delete power manager from device manager application.

Parameters

Responses

POST /powerManager/update (Update an existing PowerManager)

This API can be used to delete user from device manager application.

Parameters

Responses

API which handles power device mapping.

POST /powerDevice/add (Add a new Device Mapping)

This API is used to add device mapping

Parameters

Responses

GET /powerDevice/all (Returns all the device mappings)

Gets all device mappings  configured in Device Manager application.

Responses

POST /powerDevice/delete (Delete an existing device mapping)

This API can be used to delete device mapping from device manager application.

Parameters

Responses

POST /powerDevice/delete (Update an existing device mapping details)

This API can be used to update device mapping details from device manager application.

Parameters

Responses

These APIs handles requests for power operations.

POST /powerOperation/add (Add a new Power Operation Details)

This API is used to add power operation

Parameters

Responses

GET /powerOperation/all (Returns all the PowerOperation Details)

Gets all power operations configured in Device Manager application.

Responses

POST /powerOperation/delete (Delete an existing Power Operation)

This API can be used to delete power manager from device manager application.

Parameters

Responses

POST /powerOperation/getDetails (GetDetails of existing power operation)

This API will returns Power Operation Details for given device and operation type

Parameters

Responses

POST /powerOperation/update (Update an existing Power Operation)

This API can be used to update power manager from device manager application.

Parameters

Responses

AutomaticsStatusResponse

Properties 

application/json

CoreDeviceDetails

Properties

DeviceAccountDetails

Properties

DeviceAccountRequest

Properties

DeviceAllocationResponse

Properties

DeviceCategory

Properties

DeviceCategoryRequest

Properties

DeviceDetails

Properties

DeviceDetailsDO

Properties

DeviceDetailsDeleteRequest

Properties

DeviceDetailsList

Properties

DeviceDetailsRequest

Properties