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”.
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 Content | |
| 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/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 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 | |
| 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 | |
| 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 | |
| 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 | 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.
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 optional | string | |
mac optional | string | |
status optional | enum (SUCCESS,FAILURE) |
CoreDeviceDetails
Properties
| Name | Description | Schema |
|---|---|---|
clientIpAddress optional | string | |
components optional | < string > array | |
deviceType optional | string | |
ecmMacAddress optional | string | |
estbMacAddress optional | string | |
extraPropertie optional | object | |
features optional | < string > array | |
gatewayMac optional | string string | |
hardwareRevision optional | string string | |
headend optional | ||
homeAccountGroupName optional | ||
homeAccountName optional | string | |
homeAccountNumber optional | string | |
hostIp4Address optional | string | |
hostIp6Address optional | string | |
hostMacAddress optional | string | |
id optional | string | |
manufacturer optional | string | |
model optional | string | |
name optional | string | |
rackGroups optional | < string > array | |
rackId optional | string | |
rackName optional | string | |
rackServerHost optional | string | |
rackServerPort optional | integer (int32) | |
remoteType optional | string | |
serialNumber optional | string | |
settopGroupName optional | string | |
slotName optional | string | |
slotNumber optional | string | |
status optional | string | |
unitAddress optional | string | |
wanMacAddress optional | string |
DeviceAccountDetails
Properties
| Name | Description | Schema |
|---|---|---|
accountNumber optional | string | |
address optional | string | |
devices optional | < CoreDeviceDetails > array | |
homeAccountGroup optional | string | |
id optional | string | |
name optional | string | |
phoneNumber optional | string |
DeviceAccountRequest
Properties
| Name | Description | Schema |
|---|---|---|
accountNumber required | string |
DeviceAllocationResponse
Properties
| Name | Description | Schema |
|---|---|---|
allocationId optional | string | |
allocationStatus optional | enum (AVAILABLE, LOCKED) | |
end optional | string | |
lastModifiedDate optional | string | |
start optional | string | |
userName optional | string |
DeviceCategory
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceCategoryId optional | integer (int32) | |
deviceCategoryName optional | string | |
deviceDetails optional | < 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 | string | |
createdBy optional | string | |
createdDate optional | string (date-time) | |
deletedDate optional | string (date-time) | |
deviceCategory optional | DeviceCategory | |
deviceDetailsId optional | integer (int32) | |
deviceFeatures optional | < DeviceFeatures >array | |
deviceGroup optional | DeviceGroup | |
deviceModel optional | DeviceModel | |
deviceRackDtls optional | string | |
deviceStatus optional | string | |
ecmIpAddress optional | string | |
ecmMacAddress optional | string | |
firmwareVersion optional | string | |
gatewayMacAddress optional | string | |
headEnd optional | HeadEnd | |
ipAddress optional | string | |
isExcludedFromPool optional | string | |
isIpv6 optional | string | |
macAddress optional | string | |
phoneNumber optional | string | |
serviceAccId optional | string | |
slotNumber optional | string | |
statusRemarks optional | string | |
updatedDate optional | string (date-time) | |
updatedUser optional | string |
DeviceDetailsDO
Properties
| Name | Description | Schema |
|---|---|---|
accountId optional | string | |
createdBy optional | string | |
createdDate optional | string (date-time) | |
deletedDate optional | string (date-time) | |
deviceCategory Name optional | string | |
deviceDetailsId optional | integer (int32) | |
deviceGroupName optional | string | |
deviceModelName optional | string | |
deviceRackDtls optional | string | |
deviceStatus optional | string | |
ecmIpAddress optional | string | |
ecmMacAddress optional | string | |
featureNames optional | < string > array | |
firmwareVersion optional | string | |
gatewayMacAddress optional | string | |
headEndName optional | string | |
ipAddress optional | string | |
isExcludedFromPool optional | string | |
isIpv6 optional | string | |
macAddress optional | string | |
phoneNumber optional | string | |
serviceAccId optional | string | |
slotNumber optional | string | |
statusRemarks optional | string | |
updatedDate optional | string (date-time) | |
updatedUser optional | string |
DeviceDetailsDeleteRequest
Properties
| Name | Description | Schema |
|---|---|---|
macAddress optional | string |
DeviceDetailsList
Properties
| Name | Description | Schema |
|---|---|---|
device optional | < DeviceDetailsDO > array |
DeviceDetailsRequest
Properties
| Name | Description | Schema |
|---|---|---|
accountId required | string | |
createdBy optional | string | |
createdDate optional | string (date-time) | |
deletedDate optional | string (date-time) | |
deviceCategoryName required | string | |
deviceGroupName optional | string | |
deviceId optional | integer (int32) | |
deviceModelName required | string | |
deviceRackDtls optional | string | |
deviceStatus optional | string | |
ecmIpAddress optional | string | |
ecmMacAddress optional | string | |
featureNames optional | < string > array | |
firmwareVersion optional | string | |
gatewayMacAddress optional | string | |
headEndName optional | string | |
ipAddress required | string | |
ipType required | string | |
isExcludedFromPool optional | string | |
macAddress required | string | |
phoneNumber optional | string | |
serviceAccId optional | string | |
slotNumber optional | string | |
statusRemarks optional | string | |
updatedDate optional | string (date-time) | |
updatedUser optional | string |
DeviceDetailsResponse
Properties
| Name | Description | Schema |
|---|---|---|
device optional | DeviceDetailsDO |
DeviceFeatures
Properties
| Name | Description | Schema |
|---|---|---|
deviceDetails optional | DeviceDetails | |
deviceFeatureId optional | integer (int32) | |
feature optional | Feature |
DeviceGroup
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceDetails optional | < DeviceDetails > array | |
deviceGroupId optional | integer (int32) | |
deviceGroupName optional | string | |
deviceGroupRights optional | < DeviceGroupRights > array |
DeviceGroupRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceGroupId optional | integer (int32) | |
deviceGroupName required | string |
DeviceGroupRights
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
createdUser optional | string | |
deviceGroup optional | DeviceGroup | |
deviceGroupRightsId optional | integer (int32) | |
updatedDate optional | string (date-time) | |
updatedUser optional | string | |
userDetails optional | UserDetails |
DeviceInformation
Properties
| Name | Description | Schema |
|---|---|---|
ecmIp optional | string | |
ecmMac optional | string | |
estbIp optional | string | |
estbMac optional | string |
DeviceModel
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceDetails optional | < DeviceDetails > array | |
deviceModelId optional | integer (int32) | |
deviceModelName optional | string |
DeviceModelRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceModelId optional | integer (int32) | |
deviceModelName required | string |
DevicePoolRequest
Properties
| Name | Description | Schema |
|---|---|---|
considerExcluded optional | boolean | |
deviceGroupName optional | string | |
deviceModelName optional | string | |
deviceStatus optional | string | |
featureName optional | string | |
headEndName optional | string | |
ipType optional | string | |
skipDeviceGroup optional | boolean |
DevicePropsRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceProps required | <string > array | |
mac required | string |
DevicePropsResponse
Properties
| Name | Description | Schema |
|---|---|---|
ECM_IP_ADDRESS optional | string | |
ESTB_IP_ADDRESS optional | string | |
FIRMWARE_VERSION optional | string | |
HEAD_END optional | string | |
mac optional | string |
DeviceRequest
Properties
| Name | Description | Schema |
|---|---|---|
mac required | string |
DeviceUpdateDurationRequest
Properties
| Name | Description | Schema |
|---|---|---|
lockDurationInMins required | integer (int32) | |
mac required | string |
Feature
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceFeatures optional | < DeviceFeatures> array | |
featureId optional | integer (int32) | |
featureName optional | string | |
isSpecial optional | string |
FeatureDeleteRequest
Properties
| Name | Description | Schema |
|---|---|---|
featureId optional | integer (int32) | |
featureName optional | string |
FeatureRequest
Properties
| Name | Description | Schema |
|---|---|---|
featureId optional | integer (int32) | |
featureName required | string | |
specialFeature required | string |
GetDeviceDetailsRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceCount optional | integer (int32) | |
deviceGroup optional | string | |
deviceStatus optional | string | |
deviceType optional | string | |
excludeSpecialFeatures optional | < string > array | |
featureType optional | string | |
headEnd optional | string | |
ipType optional | string | |
mac optional | string |
GetDeviceDetailsResponse
Properties
| Name | Description | Schema |
|---|---|---|
devices optional | < CoreDeviceDetails > array | |
errorMsg optional | string | |
remarks optional | string |
HeadEnd
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceDetails optional | < DeviceDetails > array | |
headEndId optional | integer (int32) | |
headEndName optional | string |
HeadEndRequest
Properties
| Name | Description | Schema |
|---|---|---|
headEndId optional | integer (int32) | |
headEndName optional | string |
MacList
Properties
| Name | Description | Schema |
|---|---|---|
macList optional | < string > array |
QueryDeviceResponse
Properties
| Name | Description | Schema |
|---|---|---|
devices optional | < string > array | |
errorMsg optional | string | |
status optional | enum (SUCCESS,FAILURE) |
StatusResponse
Properties
| Name | Description | Schema |
|---|---|---|
errorMsg optional | string | |
status optional | enum (SUCCESS,FAILURE) |
UserDetails
Properties
| Name | Description | Schema |
|---|---|---|
deviceGroupRights optional | < DeviceGroupRights > array | |
emailId optional | string | |
isAdminUser optional | string | |
password optional | string | |
updatedDate optional | string (date-time) | |
userDetailsId optional | integer (int32) | |
userId optional | string | |
userName optional | string |
ValidateDeviceRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceFeature Type optional | string | |
deviceGroup optional | string | |
deviceHeadEnd optional | string | |
deviceStatus optional | string | |
deviceType optional | string | |
includeReservedDevice optional | string | |
mac optional | string |
Overview
Community Forums
Content Tools
Tasks