RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
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”.
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.
SwaggerUI Usage
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.
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. |
Paths
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceDetails Request | deviceDetailsRequest | DeviceDetailsRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK | |
| 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/ | |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
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
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | updateDeviceDetails Request | updateDeviceDetailsRequest | UpdateDeviceDetailsRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK | |
| 201 | Created | 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request | DeviceDetailsDelete Request |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK | 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 application/json/ | |
| 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 application/json/ | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | poolRequest required | poolRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json/ | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request | DeviceRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json/ | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request | DeviceRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json/ | |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceCategory required | deviceCategory | DeviceCategoryRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json/ | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceCategory required | deviceCategory | DeviceCategoryRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK application/json Content | |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceFeature Request required | deviceFeatureRequest | FeatureRequest |
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 /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 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceFeature Request required | deviceFeatureRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceGroup required | deviceGroup |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceGroup required | deviceGroup |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
Device Management
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
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceRequest required | deviceRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceRequest required | deviceRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceRequest required | deviceRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceUpdate DurationRequest required | deviceUpdateDurationRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceAccountRequest required | deviceAccountRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceRequest required | deviceRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | macList required | macList |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | <DeviceInformation > array |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
POST /deviceManagement/getDeviceProps (API to fetch Device Properties)
This API will return all the properties of the device as per the MAC Address and properties present in the request.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | devicePropsRequest required | devicePropsRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceDetails required | deviceDetails |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceDetails required | deviceDetails |
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 |
Device Model
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
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceModelRequest required | deviceModelRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | deviceModelRequest required | deviceModelRequest |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
Head End
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
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | headEnd required | headEnd |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 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
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | headEnd required | headEnd |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | OK Content application/json | |
| 201 | Created | No Links |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
Users
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/ | <UserDetails array > |
| 401 | Unauthorized | No Links |
| 403 | Forbidden | No Links |
| 404 | Not Found | No Links |
Components
Schemas
AutomaticsStatusResponse
Properties
application/json
| Name | Description | Schema |
|---|---|---|
errorMsg required | Message returned from the API based on the result after processing the request | string |
mac optional | MAC address of the device | string |
status optional | Status after processing the API request it will either be SUCCESS or FAILURE | enum (SUCCESS,FAILURE) |
CoreDeviceDetails
Properties
| Name | Description | Schema |
|---|---|---|
clientIpAddress optional | IP Address of Device | string |
components optional | Indicates the List of Components of the device | < string > array |
deviceType optional | Type of device | string |
ecmMacAddress optional | ECM Mac address of device | string |
estbMacAddress optional | Mac Address of the device | string |
extraProperties optional | Extra properties required for the device | object |
features optional | Indicates the list of features of the device | < string > array |
gatewayMac optional | Gateway MAC Address | string |
hardwareRevision optional | Indicates the hardware revision of the device | string |
headend optional | Indicates the name of Head End of the device | |
homeAccountGroupName optional | Indicates the Name of Home Account Group | |
homeAccountName optional | Home Account Name | string |
homeAccountNumber optional | Home Account Number | string |
hostIp4Address optional | Indicates the IPv4 address of the device | string |
hostIp6Address optional | Indicates the IPv6 address of the device | string |
hostMacAddress optional | Mac Address of the device | string |
id optional | ID of the device details stored in "Device Details" table of Device Manager | string |
manufacturer optional | Indicates the Manufacturer of the device | string |
model optional | Indicates the model of the device | string |
name optional | Indicates the name of the device | string |
rackGroups optional | Rack groups | < string > array |
rackId optional | ID of the Rack | string |
rackName optional | Name of the Rack | string |
rackServerHost optional | RACK Server IP Address | string |
rackServerPort optional | Rack Server port | integer (int32) |
remoteType optional | Remote Type | string |
serialNumber optional | Serial Number of the device | string |
settopGroupName optional | Indicates the Top Group Name | string |
slotName optional | Slot Name | string |
slotNumber optional | Slot Number | string |
status optional | Status of the device | string |
unitAddress optional | unit Address of the device | string |
wanMacAddress optional | WAN MAC address of the device | string |
DeviceAccountDetails
Properties
| Name | Description | Schema |
|---|---|---|
accountNumber optional | Account number | string |
address optional | Address | string |
devices optional | Device Available to an account | < CoreDeviceDetails > array |
homeAccountGroup optional | Home Account Group | string |
id optional | Account ID | string |
name optional | Account Name | string |
phoneNumber optional | Account Phone Number | string |
DeviceAccountRequest
Properties
| Name | Description | Schema |
|---|---|---|
accountNumber required | Account Number | string |
DeviceAllocationResponse
Properties
| Name | Description | Schema |
|---|---|---|
allocationId optional | Device Allocation Id | string |
allocationStatus optional | Allocation status of device, which shows whether a device is allocated for execution or not Eg: LOCKED, IN_USE, AVAILABLE etc. | enum (AVAILABLE, LOCKED) |
end optional | This field indicates the end of device allocation | string |
lastModifiedDate optional | Date at which last device allocation status got changed | string |
start optional | This field indicates the start of the device allocation | string |
userName optional | User who initiated device status change | string |
DeviceCategory
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which a particular device category was created | string (date-time) |
deviceCategoryId optional | ID of the particular device category in Device Manager application | integer (int32) |
deviceCategoryName optional | Name of the device category in Device Manager | string |
deviceDetails optional | Details of the devices which comes under a particular device category | < DeviceDetails > array |
DeviceCategoryRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceCategoryId optional | Id of the Device Category | integer (int32) |
| deviceCategory Name required | Name of the Device Category | string |
DeviceDetails
Properties
| Name | Description | Schema |
|---|---|---|
accountId optional | Id of the account to which the device belongs | string |
createdBy optional | User who added device to the device manager | string |
createdDate optional | Date at which the device is created in Device Manager application | string (date-time) |
deletedDate optional | Date at which the device is deleted in Device Manager application | string (date-time) |
deviceCategory optional | Device category details | |
deviceDetailsId optional | Id of a particular device in device manager | integer (int32) |
deviceFeatures optional | Features of the device | < DeviceFeatures >array |
deviceGroup optional | Device Group | DeviceGroup |
deviceModel optional | Model details of the device | |
deviceRackDtls optional | Details of device Rack | string |
deviceStatus optional | Current Status of the device whether it is AVAILABLE, LOCKED etc | string |
ecmIpAddress optional | ECM IP address of device | string |
ecmMacAddress optional | ECM MAC Address of device | string |
firmwareVersion optional | Current firmware version of the device | string |
gatewayMacAddress optional | MAC address of the device | string |
headEnd optional | Details of HEAD END of the device | |
ipAddress optional | IP Address of the device | string |
isExcludedFromPool optional | This field indicated whether the device is excluded from the pool. Valid Values of this field will be Y or N | string |
isIpv6 optional | This field indicates whether the device has IPv6 address. Valid Values of this filed will be Y or N | string |
macAddress optional | MAC address of the device | string |
phoneNumber optional | Phone Number | string |
serviceAccId optional | Service Account Id of the device | string |
slotNumber optional | Slot Number | string |
statusRemarks optional | Remarks for the current device status | string |
updatedDate optional | Date at which the device details are updated | string (date-time) |
updatedUser optional | User who updated the device details | string |
DeviceDetailsDO
Properties
| Name | Description | Schema |
|---|---|---|
accountId optional | Id of the account to which the device belongs | string |
createdBy optional | User who added device to the device manager | string |
createdDate optional | Date at which the device is created in Device Manager application | string (date-time) |
deletedDate optional | Date at which the device is deleted in Device Manager application | string (date-time) |
deviceCategory Name optional | Device category details | string |
deviceDetailsId optional | Id of a particular device in device manager | integer (int32) |
deviceGroupName optional | Features of the device | string |
deviceModelName optional | Device Group | string |
deviceRackDtls optional | Model details of the device | string |
deviceStatus optional | Details of device Rack | string |
ecmIpAddress optional | Current Status of the device whether it is AVAILABLE, LOCKED etc | string |
ecmMacAddress optional | ECM IP address of device | string |
featureNames optional | ECM MAC Address of device | < string > array |
firmwareVersion optional | Current firmware version of the device | string |
gatewayMacAddress optional | MAC address of the device | string |
headEndName optional | Details of HEAD END of the device | string |
ipAddress optional | IP Address of the device | string |
isExcludedFromPool optional | This field indicates whether the device is excluded from the pool or not. Valid Values of this filed will be Y or N | string |
isIpv6 optional | This field indicates whether the device has IPv6 address. Valid Values of this files will be Y or N | string |
macAddress optional | MAC address of the device | string |
phoneNumber optional | Phone Number | string |
serviceAccId optional | Service Account Id of the device | string |
slotNumber optional | Slot Number | string |
statusRemarks optional | Remarks for the current device status | string |
updatedDate optional | Date at which the device details are updated | string (date-time) |
updatedUser optional | User who updated the device details | string |
DeviceDetailsDeleteRequest
Properties
| Name | Description | Schema |
|---|---|---|
macAddress optional | Mac address of the device which needs to be deleted from device manager application | string |
DeviceDetailsList
Properties
| Name | Description | Schema |
|---|---|---|
device optional | Details of all the devices grouped in to a List | <DeviceDetailsDO> array |
DeviceDetailsRequest
Properties
| Name | Description | Schema |
|---|---|---|
accountId required | Id of the account to which the device belongs | string |
createdBy optional | User who added device to the device manager | string |
createdDate optional | Date at which the device is created in Device Manager application | string (date-time) |
deletedDate optional | Date at which the device is deleted in Device Manager application | string (date-time) |
deviceCategoryName required | Device category details | string |
deviceGroupName optional | Device Group details | string |
deviceId optional | Id of a particular device in device manager | integer (int32) |
deviceModelName required | Model details of the device | string |
deviceRackDtls optional | Details of device Rack | string |
deviceStatus optional | Current Status of the device whether it is AVAILABLE, LOCKED etc | string |
ecmIpAddress optional | ECM IP address of device | string |
ecmMacAddress optional | ECM MAC Address of device | string |
featureNames optional | ECM MAC Address of device | < string > array |
firmwareVersion optional | Current firmware version of the device | string |
gatewayMacAddress optional | MAC address of the device | string |
headEndName optional | Details of HEAD END of the device | string |
ipAddress required | IP Address of the device | string |
ipType required | This field indicates the Type of IP address. Eg:- IPV4,IPV6 | enum(IPV4,IPV6) |
isExcludedFromPool optional | This field indicates whether device is excluded from the pool or not. Valid Values of this filed will be Y or N | string |
macAddress required | MAC address of the device | string |
phoneNumber optional | Phone Number | string |
serviceAccId optional | Service Account ID | string |
slotNumber optional | Slot Number | string |
statusRemarks optional | Remarks for the current device status | string |
updatedDate optional | Date at which the device details are updated | string (date-time) |
updatedUser optional | User who updated the device details | string |
DeviceFeatures
Properties
| Name | Description | Schema |
|---|---|---|
deviceDetails optional | Indicates the details of the device | |
deviceFeatureId optional | Indicates the Id of the feature available in a particular device | integer (int32) |
feature optional | This field indicates the features of a device | Feature |
DeviceGroup
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which the device group is created in Device Manager application | string (date-time) |
deviceDetails optional | List of devices present in the corresponding device group | < DeviceDetails > array |
deviceGroupId optional | Id of the Device group in Device manager application | integer (int32) |
deviceGroupName optional | Name of the device Group | string |
deviceGroupRights optional | Indicates the group rights of the device which is available to the user | < DeviceGroupRights > array |
DeviceGroupRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceGroupId optional | Id of device group in device manager application | integer (int32) |
deviceGroupName required | Name of the device group in device manager application | string |
DeviceGroupRights
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which the device group is created in Device Manager application | string (date-time) |
createdUser optional | User who added device group to the device manager | string |
deviceGroup optional | Device group | DeviceGroup |
deviceGroupRightsId optional | Id of Device Group Rights in device manager application | integer (int32) |
updatedDate optional | Date at which the corresponding Device group rights were updated | string (date-time) |
updatedUser optional | User who updated the corresponding device group rights | string |
userDetails optional | User Details |
DeviceInformation
Properties
| Name | Description | Schema |
|---|---|---|
ecmIp optional | ECM IP address of the device | string |
ecmMac optional | ECM MAC address of the device | string |
estbIp optional | ESTB IP address of the device | string |
estbMac optional | ESTB MAC address of the device | string |
DeviceModel
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which the device group is created in Device Manager application | string (date-time) |
deviceDetails optional | Details of the device corresponding to the device model | <DeviceDetails> array |
deviceModelId optional | Id of the device model in device manager application | integer (int32) |
deviceModelName optional | Name of the device model | string |
DeviceModelRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceModelId optional | Id of the device model in device manager application | integer (int32) |
deviceModelName required | Name of the device model | string |
DevicePoolRequest
Properties
| Name | Description | Schema |
|---|---|---|
considerExcluded optional | This field represents whether the device is Excluded or not from device pool | boolean |
deviceGroupName optional | Name of the device group | string |
deviceModelName optional | Name of the device model | string |
deviceStatus optional | Status of the device | string |
featureName optional | Name of the feature which the device has | string |
headEndName optional | Head end name of the device | string |
ipType optional | Indicates the Type of IP address of the device. Eg:- IPV4,IPV6 | enum(IPV4,IPV6) |
skipDeviceGroup optional | This field represents whether to skip the corresponding device group or not. | boolean |
DevicePropsRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceProps required | Indicates the List of properties of a particular device | <string > array |
mac required | MAC address of the device | string |
DevicePropsResponse
Properties
| Name | Description | Schema |
|---|---|---|
ECM_IP_ADDRESS optional | ECM IP address of the device | string |
ESTB_IP_ADDRESS optional | ESTB IP address of the device | string |
FIRMWARE_VERSION optional | Firmware version of the device | string |
HEAD_END optional | Head end of the device | string |
mac optional | MAC address of the device | string |
DeviceRequest
Properties
| Name | Description | Schema |
|---|---|---|
mac required | MAC address of the device | string |
DeviceUpdateDurationRequest
Properties
| Name | Description | Schema |
|---|---|---|
lockDurationInMins required | Indicates Lock duration of device in minutes | integer (int32) |
mac required | MAC Address of the device | string |
Feature
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which the feature was added to the device manager application | string (date-time) |
deviceFeatures optional | List of features of the device | < DeviceFeatures> array |
featureId optional | Id of the feature in device manager application | integer (int32) |
featureName optional | Name of the feature in device manager application | string |
isSpecial optional | This field indicates whether it is special feature of the device or not. Eg:- "Y,"N" | string |
FeatureDeleteRequest
Properties
| Name | Description | Schema |
|---|---|---|
featureId optional | Id of the feature in device manager application | integer (int32) |
featureName optional | Name of the feature in device manager application | string |
FeatureRequest
Properties
| Name | Description | Schema |
|---|---|---|
featureId optional | Id of the feature in device manager application | integer (int32) |
featureName required | Name of the feature in device manager application | string |
specialFeature required | This field represents the special feature of the device | string |
GetDeviceDetailsRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceCount optional | No of devices available | integer (int32) |
deviceGroup optional | Indicated the device group the corresponding device belongs to | string |
deviceStatus optional | Status of the device | string |
deviceType optional | Indicates the type of device | string |
excludeSpecialFeatures optional | Indicates list of excluded special features of device | < string > array |
featureType optional | Indicated the feature type | string |
headEnd optional | Head end of the device | string |
ipType optional | Indicates the Type of IP of the device. Eg:- IPV4,IPV6 | enum(IPV4,IPV6) |
mac optional | MAC address of the device | string |
GetDeviceDetailsResponse
Properties
| Name | Description | Schema |
|---|---|---|
devices optional | Details of devices in device manager application | < CoreDeviceDetails > array |
errorMsg optional | Message returned from the API based on the result after processing the request | string |
remarks optional | remarks are returned based on the result after processing the request | string |
HeadEnd
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which the HeadEnd was added to the device manager application | string (date-time) |
deviceDetails optional | Details of devices in device manager application | <DeviceDetails> array |
headEndId optional | Id of Head End available in the device manager application | integer (int32) |
headEndName optional | Name of Head End available in the device manager application | string |
HeadEndRequest
Properties
| Name | Description | Schema |
|---|---|---|
headEndId optional | Id of Head End available in the device manager application | integer (int32) |
headEndName optional | Name of Head End available in the device manager application | string |
MacList
Properties
| Name | Description | Schema |
|---|---|---|
macList optional | List of device MAC address | < string > array |
QueryDeviceResponse
Properties
| Name | Description | Schema |
|---|---|---|
devices optional | List of devices as per the query request | < string > array |
errorMsg optional | Message returned from the API based on the result after processing the request | string |
status optional | Status after processing the API request it will either be SUCCESS or FAILURE | enum (SUCCESS,FAILURE) |
StatusResponse
Properties
| Name | Description | Schema |
|---|---|---|
errorMsg optional | Message returned from the API based on the result after processing the request | string |
status optional | Status after processing the API request it will either be SUCCESS or FAILURE | enum (SUCCESS,FAILURE) |
UserDetails
Properties
| Name | Description | Schema |
|---|---|---|
deviceGroupRights optional | Indicates the group rights of the device which is available to the user | <DeviceGroupRights> array |
emailId optional | Email id of the user | string |
isAdminUser optional | This field represents whether the user is Admin or not | string |
password optional | Password of the User for device manager application | string |
updatedDate optional | Date at which the user details are last updated | string (date-time) |
userDetailsId optional | Id of the user whom updated the user details at last | integer (int32) |
userId optional | Id of the user in device manager application | string |
userName optional | User name of user in device manager application | string |
ValidateDeviceRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceFeature Type optional | Feature of the device | string |
deviceGroup optional | Group of the device | string |
deviceHeadEnd optional | Head End of the device | string |
deviceStatus optional | Status of the device | string |
deviceType optional | Type of the device | string |
includeReservedDevice optional | Check whether the device is reserved | string |
mac optional | MAC address of the device | string |
UpdateDeviceDetailsRequest
Properties
| Name | Description | Schema |
|---|---|---|
accountId optional | Id of the account to which the device belongs | string |
createdBy optional | User who added device to the device manager | string |
createdDate optional | Date at which the device is created in Device Manager application | string (date-time) |
deletedDate optional | Date at which the device is deleted in Device Manager application | string (date-time) |
deviceCategoryName optional | Device category details | string |
deviceGroupName optional | Device Group details | string |
deviceId optional | Id of a particular device in device manager | integer (int32) |
deviceModelName required | Model details of the device | string |
deviceRackDtls optional | Details of device Rack | string |
deviceStatus optional | Current Status of the device whether it is AVAILABLE, LOCKED etc | string |
ecmIpAddress optional | ECM IP address of device | string |
ecmMacAddress optional | ECM MAC Address of device | string |
featureNames optional | ECM MAC Address of device | < string > array |
firmwareVersion optional | Current firmware version of the device | string |
gatewayMacAddress optional | MAC address of the device | string |
headEndName optional | Details of HEAD END of the device | string |
currentMacAddress optional | MAC address of the device which is currently configured in device manager application | string |
currentIpAddress optional | IP address of the device which is currently configured in device manager application | string |
ipAddress optional | IP Address of the device | string |
ipType optional | This field indicates the Type of IP address. Eg:- IPV4,IPV6 | enum(IPV4,IPV6) |
isExcludedFromPool optional | This field indicates whether device is excluded from the pool or not. Valid Values of this filed will be Y or N | string |
macAddress optional | MAC address of the device | string |
phoneNumber optional | Phone Number | string |
serviceAccId optional | Service Account ID | string |
slotNumber optional | Slot Number | string |
statusRemarks optional | Remarks for the current device status | string |
updatedDate optional | Date at which the device details are updated | string (date-time) |
updatedUser optional | User who updated the device details | string |
Overview
Community Forums
Content Tools
Tasks