RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Page History
| 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 |
| Background Color | ||
|---|---|---|
| ||
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/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 |
| Background Color | ||
|---|---|---|
| ||
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 |
| Background Color | ||
|---|---|---|
| ||
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 |
| Background Color | ||
|---|---|---|
| ||
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 |
| Background Color | ||
|---|---|---|
| ||
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 | deviceAccountRequestrequired | 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 | devicePropsRequestrequired | 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 |
| Background Color | ||
|---|---|---|
| ||
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 | deviceModelRequestrequired | 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 |
| Background Color | ||
|---|---|---|
| ||
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 |
| Background Color | ||
|---|---|---|
| ||
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 |
| Background Color | ||
|---|---|---|
| ||
Components |
| Background Color | ||
|---|---|---|
| ||
Schemas |
AutomaticsStatusResponseAnchor AutomaticsStatusResponse AutomaticsStatusResponse
Properties
application/json
| Name | Description | Schema |
|---|---|---|
errorMsg optional 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) |
CoreDeviceDetailsAnchor CoreDeviceDetails CoreDeviceDetails
Properties
| Name | Description | Schema |
|---|---|---|
clientIpAddress optional | IP Address of Device | string |
components optional | < string > array | |
deviceType optional | Type of device | string |
ecmMacAddress optional | ECM Mac address of device | string |
estbMacAddress optional | Mac Address of the device | string |
extraPropertieextraProperties optional | Extra properties required for the device | object |
features optional | < string > array | |
gatewayMac optional | Gateway MAC Address | string string string |
hardwareRevision optional | Indicates the hardware revision of the device | string string string |
headend optional | Indicates the name of Head End of the device | |
homeAccountGroupName optional | ||
homeAccountName optional | string | |
homeAccountNumber optional | string | |
hostIp4Address optional | Indicates the IPv4 address of the device | string |
hostIp6Addressoptional 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 | < string > array | |
rackId optional | string | |
rackName optional | Name of the Rack | string |
rackServerHost optional | RACK Server IP Address | string |
rackServerPort optional | Rack Server port | integer (int32) |
remoteType optional | string | |
serialNumber optional | Serial Number of the device | string |
settopGroupName optional | string | |
slotName optional | string | |
slotNumber optional | string | |
status optional | string | |
unitAddress optional | string | |
wanMacAddress optional | string |
DeviceAccountDetailsAnchor DeviceAccountDetails 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 | string | |
id optional | Account ID | string |
name optional | Account Name | string |
phoneNumber optional | Account Phone Number | string |
DeviceAccountRequestAnchor DeviceAccountRequest DeviceAccountRequest
Properties
| Name | Description | Schema |
|---|---|---|
accountNumber required | Account Number | string |
DeviceAllocationResponseAnchor DeviceAllocationResponse 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 excecution or not Eg: LOCKED, IN_USE, AVAILABLE etc. | enum (AVAILABLE, LOCKED) |
end optional | string | |
lastModifiedDate optional | Date at which last device allocation status got changed | string |
start optional | string | |
userName optional | User who initiated device status change | string |
DeviceCategoryAnchor DeviceCategorySchema DeviceCategorySchema
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | Date at which a particular device category was created | string (date-time) |
deviceCategoryId optionaloptional | 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 |
DeviceCategoryRequestAnchor DeviceCategoryRequest DeviceCategoryRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceCategoryId optional | Id of the Device Category | integer (int32) |
| deviceCategory Name required | Name of the Device Category | string |
DeviceDetailsAnchor DeviceDetails DeviceDetails
Properties
| Name | Description | Schema |
|---|---|---|
accountId optional | string | |
createdBy optional | string | |
createdDate optional | string (date-time) | |
deletedDate optional | string (date-time) | |
deviceCategory optional | ||
deviceDetailsId optional | integer (int32) | |
deviceFeatures optional | < DeviceFeatures >array | |
deviceGroup optional | DeviceGroup | |
deviceModel optional | ||
deviceRackDtls optional | string | |
deviceStatus optional | string | |
ecmIpAddress optional | string | |
ecmMacAddress optional | string | |
firmwareVersion optional | string | |
gatewayMacAddress optional | string | |
headEnd optional | ||
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 |
DeviceDetailsDOAnchor DeviceDetailsDO 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 |
DeviceDetailsDeleteRequestAnchor DeviceDetailsDeleteRequest DeviceDetailsDeleteRequest
Properties
| Name | Description | Schema |
|---|---|---|
macAddress optional | Mac address of the device which needs to be deleted from device manager application | string |
DeviceDetailsListAnchor DeviceDetailsList DeviceDetailsList
Properties
| Name | Description | Schema |
|---|---|---|
device optional | Details of all the devices grouped in to a List | <DeviceDetailsDO> array |
DeviceDetailsRequestAnchor DeviceDetailsRequest 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 |
DeviceDetailsResponseAnchor DeviceDetailsResponse DeviceDetailsResponse
Properties
| Name | Description | Schema |
|---|---|---|
device optional | Details of device. |
DeviceFeaturesAnchor DeviceFeaturesSchema DeviceFeaturesSchema
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 |
DeviceGroupAnchor DeviceGroupSchema DeviceGroupSchema
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceDetails optional | < DeviceDetails > array | |
deviceGroupId optional | integer (int32) | |
deviceGroupName optional | string | |
deviceGroupRights optional | < DeviceGroupRights > array |
DeviceGroupRequestAnchor DeviceGroupRequest DeviceGroupRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceGroupId optional | integer (int32) | |
deviceGroupName required | string |
DeviceGroupRightsAnchor DeviceGroupRights DeviceGroupRights
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
createdUser optional | string | |
deviceGroup optional | ||
deviceGroupRightsId optional | integer (int32) | |
updatedDate optional | string (date-time) | |
updatedUser optional | string | |
userDetails optional |
DeviceInformationAnchor DeviceInformation DeviceInformation
Properties
| Name | Description | Schema |
|---|---|---|
ecmIp optional | string | |
ecmMac optional | string | |
estbIp optional | string | |
estbMac optional | string |
DeviceModelAnchor DeviceModelSchema DeviceModelSchema
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceDetails optional | <DeviceDetails> array | |
deviceModelId optional | integer (int32) | |
deviceModelName optional | string |
DeviceModelRequestAnchor DeviceModelRequest DeviceModelRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceModelId optional | integer (int32) | |
deviceModelName required | string |
DevicePoolRequestAnchor DevicePoolRequest 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 |
DevicePropsRequestAnchor DevicePropsRequest DevicePropsRequest
Properties
| Name | Description | Schema |
|---|---|---|
deviceProps required | <string > array | |
mac required | string |
DevicePropsResponseAnchor DevicePropsResponse 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 |
DeviceRequestAnchor DeviceRequest DeviceRequest
Properties
| Name | Description | Schema |
|---|---|---|
mac required | string |
DeviceUpdateDurationRequestAnchor DeviceUpdateDurationRequest DeviceUpdateDurationRequest
Properties
| Name | Description | Schema |
|---|---|---|
lockDurationInMins required | integer (int32) | |
mac required | string |
FeatureAnchor Feature Feature
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceFeatures optional | < DeviceFeatures> array | |
featureId optional | integer (int32) | |
featureName optional | string | |
isSpecial optional | string |
FeatureDeleteRequestAnchor FeatureDeleteRequest FeatureDeleteRequest
Properties
| Name | Description | Schema |
|---|---|---|
featureId optional | integer (int32) | |
featureName optional | string |
FeatureRequestAnchor FeatureRequest FeatureRequest
Properties
| Name | Description | Schema |
|---|---|---|
featureId optional | integer (int32) | |
featureName required | string | |
specialFeature required | string |
GetDeviceDetailsRequestAnchor GetDeviceDetailsRequest 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 |
GetDeviceDetailsResponseAnchor GetDeviceDetailsResponse GetDeviceDetailsResponse
Properties
| Name | Description | Schema |
|---|---|---|
devices optional | < CoreDeviceDetails > array | |
errorMsg optional | string | |
remarks optional | string |
HeadEndAnchor HeadEnd HeadEnd
Properties
| Name | Description | Schema |
|---|---|---|
createdDate optional | string (date-time) | |
deviceDetails optional | <DeviceDetails> array | |
headEndId optional | integer (int32) | |
headEndName optional | string |
HeadEndRequestAnchor HeadEndRequest HeadEndRequest
Properties
| Name | Description | Schema |
|---|---|---|
headEndId optional | integer (int32) | |
headEndName optional | string |
MacListAnchor MacList MacList
Properties
| Name | Description | Schema |
|---|---|---|
macList optional | < string > array |
QueryDeviceResponseAnchor QueryDeviceResponse QueryDeviceResponse
Properties
| Name | Description | Schema |
|---|---|---|
devices optional | < string > array | |
errorMsg optional | string | |
status optional | enum (SUCCESS,FAILURE) |
StatusResponseAnchor StatusResponse StatusResponse
Properties
| Name | Description | Schema |
|---|---|---|
errorMsg optional | string | |
status optional | enum (SUCCESS,FAILURE) |
UserDetailsAnchor UserDetails 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 |
ValidateDeviceRequestAnchor ValidateDeviceRequest 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