RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
<work in progress>
Table of Contents | ||
---|---|---|
|
Background Color | ||
---|---|---|
| ||
Overview |
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”.
Background Color | ||
---|---|---|
| ||
Tags |
Tag Name | Desscription |
---|---|
Device Group | APIs which handle requests for device group. |
Device Category | APIs which handle requests for device category. |
Device Feature | APIs which handle requests for device feature. |
Device | APIs which handle requests for device details. |
Device Model | APIs which handle requests for device models. |
Head End | APIs which handle requests for head end. |
Device Management | API for Device Management. |
User | APIs which handle requests for user management. |
Background Color | ||
---|---|---|
| ||
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.
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
Code | Description | 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
Type | Name | Description | Schema |
---|---|---|---|
query | mac required | mac | string |
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not 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.
Parameters
Type | application/jsonName | Description | Schema |
---|---|---|---|
query | mac required | mac | string |
Responses
Code | Description | Links |
---|---|---|
200 | OK Content | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Type | Name | Description | Schema |
---|---|---|---|
query | mac required | mac | string |
Responses
Code | Description | Links |
---|---|---|
200 | OK Content | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Type | Name | Description | Schema |
---|---|---|---|
query | mac required | mac | string |
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Type | Name | Description | Schema |
---|---|---|---|
query | mac required | mac | string |
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Type | Name | Description | Schema |
---|---|---|---|
query | macType required | macType | string |
query | mac | string |
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
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 /deviceCategory/all (Returns all the Device Categories)
This API returns all the Device Category details configured in the Device Manager application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceCategory/delete (Delete an existing Device Category)
This API is used to delete an existing Device Category from the Device Manager application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
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 /deviceFeature/all (Returns all the Device Features)
This API returns all the device features available in the Device Manager application.
Responses
Code | Description | Links |
---|---|---|
200 | OK application/json Content application/json / | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceFeature/delete (Delete an existing Device Feature)
This API is used to delete an existing device feature from the Device Manager application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
GET /deviceGroup/all (Returns all the Device Groups)
This API returns all the Device Group details in the Device Manager application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceGroup/delete (Delete an existing Device Group)
This API is used to delete an existing Device Group from the Device Manager application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceManagement/device/releases (API to get Device Account details)
This API can be used to fetch device account details from the application
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceManagement/device/updateAllocationDuration (API to update Device lock duration)
This API can be used to update Device lock duration
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceManagement/getAccountDetails (API to get Device Account details)
This API can be used to fetch Device Account Details from the application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceManagement/getDeviceDetails (API to get device details)
This API can be used to fetch Device Details from the application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
This API will return all the properties of the device as per the MAC Address and properties present in the request.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceManagement/queryDevices (API to query a particular device)
This API will query and return the device list from the application
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceManagement/validateDevice (API to validate the device)
This API will validate the device based on the given details.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
GET /deviceModel/all (Returns all the Device Models)
This API returns all the Device Model configured in the application
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /deviceModel/delete (Delete an existing Device Model)
This API can be used to delete an existing Device Model from the application.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
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.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
GET /headEnd/all (Returns all the Device Head Ends)
This API returns all the Device Head Ends configured in the application
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
POST /headEnd/delete (Delete an existing Device Head End)
This API can be used to delete an existing Device Head End from the application
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json | No Links |
201 | Created | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |
These APIs handles requests for user management.
GET /users/all (Returns all the User Details)
Gets all users configured in Device Manager application. This support is added for future enhancement.
Responses
Code | Description | Links |
---|---|---|
200 | OK Content application/json/ | No Links |
401 | Unauthorized | No Links |
403 | Forbidden | No Links |
404 | Not Found | No Links |