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 NameDescription
Device GroupAPIs which handle requests for device group.
Device CategoryAPIs which handle requests for device category.
Device FeatureAPIs which handle requests for device feature.
DeviceAPIs which handle requests for device details.
Device ModelAPIs which handle requests for device models.
Head EndAPIs which handle requests for head end.
Device ManagementAPI for Device Management.
UserAPIs which handle requests for user management.
ConfigurationAPIS which handle requests for Configuration management
Health CheckAPIS which handle requests for Health Check

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

TypeNameDescriptionSchema
Body

deviceDetails Request

deviceDetailsRequestDeviceDetailsRequest

Responses

Code

Description

Links

200

OK

StatusResponse

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

CodeDescription

Links

200

OK

Content

application/json/

DeviceDetailsList

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

TypeNameDescriptionSchema
Body

updateDeviceDetails Request

updateDeviceDetailsRequestUpdateDeviceDetailsRequest


Responses

Code

Description

Links

200

OK

StatusResponse

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

TypeNameDescriptionSchema
Body

request required

requestDeviceDetailsDelete 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

TypeNameDescriptionSchema
query

mac

required

macstring

Responses

Code

Description

Links

200

OK

Content

application/json/

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404Not 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

Typeapplication/jsonNameDescriptionSchema
query

mac

required

macstring

Responses

Code    

Description

Links

200

OK

Content

application/json/

DeviceDetailsResponse

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

TypeNameDescription

Schema

query

mac

required

mac

string

Responses

Code

Description

Links

200

OK

Content

application/json/

DeviceDetailsResponse

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

TypeNameDescription

Schema

Body

poolRequest required

poolRequest

DevicePoolRequest

Responses

CodeDescription

Links

200

OK

Content

application/json/

DeviceDetailsList

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

TypeNameDescriptionSchema
query

mac

required

macstring

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

TypeNameDescriptionSchema
query

mac

required

macstring

Responses

Code

Description

Links

200

OK

Content

application/json/

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404Not 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

TypeNameDescriptionSchema
query

macType

required

macTypestring
query
macstring

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

TypeNameDescriptionSchema
Body

request required

requestDeviceRequest

Responses

Code

Description

Links

200

OK

Content

application/json/

StatusResponse

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

TypeNameDescriptionSchema
Body

request

required

requestDeviceRequest

Responses

Code

Description

Links

200

OK

Content

application/json/

StatusResponse

201

Created

No Links

401

Unauthorized

No Links

403

Forbidden

No Links

404

Not Found

No Links

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

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

Parameters

TypeNameDescriptionSchema
Body

request

required

requestGetSSHRequest

Responses

Code

Description

Links

200

OK

Content

application/json/

GetSSHResponse


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

TypeNameDescriptionSchema
Body

deviceCategory

required

deviceCategoryDeviceCategoryRequest

Responses

CodeDescriptionLinks
200

OK

Content

application/json/

StatusResponse

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

TypeNameDescriptionSchema
Body

deviceCategory

required

deviceCategoryDeviceCategoryRequest

Responses

Code

Description

Links

200

OK

application/json

Content

StatusResponse

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

TypeNameDescriptionSchema
Body

deviceFeature Request

required

deviceFeatureRequestFeatureRequest

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

CodeDescription

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

TypeNameDescriptionSchema
Body

deviceFeature Request

required

deviceFeatureRequest

FeatureDeleteRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

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

TypeNameDescriptionSchema
Body

deviceGroup

required

deviceGroup

DeviceGroupRequest

Responses

Code     Description

Links

200

OK

Content

application/json

StatusResponse

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

TypeNameDescriptionSchema
Body

deviceGroup

required

deviceGroup

DeviceGroupRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse 

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

TypeNameDescriptionSchema
Body

deviceRequest

required

deviceRequest

DeviceRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

DeviceAllocationResponse

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

TypeNameDescriptionSchema
Body

deviceRequest

required

deviceRequest

DeviceRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

AutomaticsStatusResponse

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

TypeNameDescriptionSchema
Body

deviceRequest

required

deviceRequest

DeviceRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

AutomaticsStatusResponse

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

TypeNameDescriptionSchema
Body

deviceUpdate DurationRequest

required

deviceUpdateDurationRequest

DeviceUpdateDurationRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

AutomaticsStatusResponse

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

TypeNameDescriptionSchema
Body

deviceAccountRequest required

deviceAccountRequest

DeviceAccountRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

DeviceAccountDetails

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

TypeNameDescriptionSchema
Body

deviceRequest required

deviceRequest

GetDeviceDetailsRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

GetDeviceDetailsResponse

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

TypeNameDescriptionSchema
Body

macList

required

macList

MacList

Responses

CodeDescription

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

TypeNameDescriptionSchema
Body

devicePropsRequest required

devicePropsRequest

DevicePropsRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

DevicePropsResponse

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

TypeNameDescriptionSchema
Body

deviceDetails

required

deviceDetails

ValidateDeviceRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

QueryDeviceResponse

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

TypeNameDescriptionSchema
Body

deviceDetails

required

deviceDetails

ValidateDeviceRequest

Responses

CodeDescription

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

TypeNameDescriptionSchema
Body

deviceModelRequest required

deviceModelRequest

DeviceModelRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

StatusResponse

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

CodeDescription

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

TypeNameDescriptionSchema
Body

deviceModelRequest required

deviceModelRequest

DeviceModelRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

StatusResponse

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

TypeNameDescriptionSchema
Body

headEnd

required

headEnd

HeadEndRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

StatusResponse

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

CodeDescription

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

TypeNameDescriptionSchema
Body

headEnd

required

headEnd

HeadEndRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

StatusResponse

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.

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

This API is used to add user details

Parameters

TypeNameDescriptionSchema
Body

userDetailsRequest

required

UserDetails

UserDetailsRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Responses

CodeDescription

Links

200

OK

Content

application/json/

<UserDetails array >

401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

POST /users/delete (Delete an existing User)

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

Parameters

TypeNameDescriptionSchema
Body

request

required

request

UserRequest

Responses

CodeDescription

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

TypeNameDescriptionSchema
Body

details

required

details

DeleteUserRequest

Responses

CodeDescription

Links

200

OK

Content

application/json/

UserDetails

401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

Configuration

These APIs handles requests for Configuartion management.

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

API can be called to fetch master config details

Responses

Code

Description

Links

200

OK

Content

application/json

ConfigDetails

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

POST/config (API to save config details)

API can be called to update / save configuration

Parameters

Type

Name

Description

Schema

String

configName

required

 Provide the configuration name defined 

configName

String

configValue

required

value need to be defined that need to be assigned to the config nameconfigValue
String

userId

required

Provide the userIduserId

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

String

configName

required

Provide config name which value need to be fetched

ConfigName

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

Health Check

API’s which handles requests for health check

POST /healthCheck  (Schedule Devices for health check)

Schedule Device Health check

Parameters

Type

Name

Description

Schema

Body

healthCheckRequest

required

 healthCheckRequest

HealthCheckRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

API to Cancel Scheduled health check execution

Parameters

Type

Name

Description

Schema

String

cancelType

required

 cancelType

cancelType

String

executionDetailsId

required

 executionDetailsId

executionDetailsId

String

userId

required

 userId

userId

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

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

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

Parameters

Type

Name

Description

Schema

String

deviceDetailsIdsList

required

 list of device ids that need to be added to the scheduled exeution

deviceDetailsIdsList

String

executionDetailsId

required

 Execution details ID

executionDetailsId

String

type

required

 Occurance type

type

String

user

required

User ID

user

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 /healthCheck/details (API to fetch list of Execution scheduled)

API to fetch List of Execution scheduled

Parameters

Type

Name

Description

Schema

Body

executionDetails

required

 executionDetails

executionDetails

Responses

Code

Description

Links

200

OK

Content

application/json

List<ExecutionDetailsRequest>

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

body

getExecutionDetailsRequest

required

 getExecutionDetailsRequest

GetExecutionDetailsRequest

Responses

Code

Description

Links

200

OK

Content

application/json

ExecutionDetails

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

body

getExecutionDetailsRequest

required

 getExecutionDetailsRequest

GetExecutionDetailsRequest

Responses

Code

Description

Links

200

OK

Content

application/json

ExecutionDetails

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

Power Manager

These APIs handles requests for Power manager management.

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

This API is used to add power manager details

Parameters

Type

Name

Description

Schema

Body

powerManagerRequest

required

 powerManagerRequest

PowerManagerDetails

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

Gets all power manager details configured in Device Manager application.

Responses

Code

Description

Links

200

OK

Content

application/json/

<PowerManagerDetails array>

401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

Body

request

required

request

PowerManagerDeleteRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

POST /powerManager/update (Update an existing PowerManager)

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

Parameters

Type

Name

Description

Schema

Body

powerManagerUpdateRequest

required

PowerManagerUpdateRequest

PowerManagerUpdateRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

Power Device

API which handles power device mapping.

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

This API is used to add device mapping

Parameters

Type

Name

Description

Schema

Body

powerDeviceDetails

required

powerDeviceDetails

PowerDeviceDO

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

Gets all device mappings  configured in Device Manager application.

Responses

Code

Description

Links

200

OK

Content

application/json/

<PowerDeviceDO array >

401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

Body

request

required

request

PowerDeviceDeleteRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

Body

request

required

request

PowerDeviceUpdateRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

Power Operation

These APIs handles requests for power operations.

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

This API is used to add power operation

Parameters

Type

Name

Description

Schema

Body

PowerOperationRequest

required

PowerOperationRequest

PowerOperationDO

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

Gets all power operations configured in Device Manager application.

Responses

Code

Description

Links

200

OK

Content

application/json/

<PowerOperationDO array >

401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

Body

request

required

request

PowerOperationDeleteRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

Body

request

required

request

PowerOperationUpdateRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

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

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

Parameters

Type

Name

Description

Schema

Body

request

required

request

UserRequest

Responses

Code

Description

Links

200

OK

Content

application/json

StatusResponse

201

Created

No Links
401

Unauthorized

No Links
403

Forbidden

No Links
404

Not Found

No Links

Components

Schemas

AutomaticsStatusResponse

Properties 

application/json

NameDescription

Schema

errorMsg required

Message returned from the API based on the result after processing the request

string

mac optional

MAC address of the devicestring

status optional

Status after processing the API request it will either be SUCCESS or FAILURE

enum (SUCCESS,FAILURE)

CoreDeviceDetails

Properties

NameDescription

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 devicestring

estbMacAddress

optional

Mac Address of the devicestring

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 Addressstring  

hardwareRevision optional

Indicates the hardware revision of the devicestring 

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 devicestring

hostIp6Address

optional

Indicates the IPv6 address of the devicestring

hostMacAddress

optional

Mac Address of the devicestring

id

optional

ID of the device details stored in "Device Details" table of Device Managerstring

manufacturer

optional

Indicates the Manufacturer of the devicestring

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 devicestring

settopGroupName optional

Indicates the Top Group Namestring

slotName

optional

Slot Namestring

slotNumber

optional

Slot Numberstring

status

optional

Status of the devicestring

unitAddress

optional

unit Address of the devicestring

wanMacAddress

optional

WAN MAC address of the devicestring

DeviceAccountDetails

Properties

NameDescription

Schema

accountNumber

optional

Account number string

address

optional

Address

string

devices

optional

Device Available to an account

< CoreDeviceDetails > array

homeAccountGroup optional

Home Account Groupstring

id

optional

Account IDstring

name

optional

Account Namestring

phoneNumber

optional

Account Phone Numberstring

DeviceAccountRequest

Properties

NameDescription

Schema

accountNumber

required

Account Number

string

DeviceAllocationResponse

Properties

NameDescription

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 changedstring

start

optional

This field indicates the start of the device allocationstring

userName

optional

User who initiated device status changestring

DeviceCategory

Properties

NameDescription

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

NameDescription

Schema

deviceCategoryId optional

Id of the Device Category

integer (int32)

deviceCategory Name required   

Name of the Device Category

string

DeviceDetails

Properties

NameDescription

Schema

accountId

optional

Id of the account to which the device belongs

string

createdBy

optional

User who added device to the device managerstring

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 applicationstring (date-time)

deviceCategory

optional

Device category details 

DeviceCategory

deviceDetailsId

optional

Id of a particular device in device manager

integer (int32)

deviceFeatures 

optional

Features of the device

< DeviceFeatures >array 

deviceGroup

optional

Device GroupDeviceGroup

deviceModel

optional

Model details of the device

DeviceModel

deviceRackDtls

optional

Details of device Rack

string

deviceStatus

optional

Current Status of the device whether it is AVAILABLE, LOCKED etcstring

ecmIpAddress

optional

ECM IP address of devicestring

ecmMacAddress

optional

ECM MAC Address of devicestring

firmwareVersion

optional

Current firmware version of the devicestring

gatewayMacAddress optional

MAC address of the devicestring

headEnd

optional

Details of HEAD END of the device

HeadEnd

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

NameDescription

Schema

accountId

optional

Id of the account to which the device belongs

string

createdBy

optional

User who added device to the device managerstring

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

mtaIpAddress

optional

MTA IP Address of the device string

mtaMacAddress

optional

MTA MAC Address of the device string

serialNumber

optional

Serial Number of the device string

hardwareVersion

optional

Hardware Version details of the devicestring

deviceRackDtls

optional

Model details of the devicestring

deviceStatus

optional

Details of device Rackstring

ecmIpAddress

optional

Current Status of the device whether it is AVAILABLE, LOCKED etcstring

ecmMacAddress

optional

ECM IP address of devicestring

featureNames

optional

ECM MAC Address of device< string > array 

firmwareVersion

optional

Current firmware version of the devicestring

gatewayMacAddress optional

MAC address of the devicestring

headEndName

optional

Details of HEAD END of the devicestring

ipAddress

optional

IP Address of the devicestring

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 devicestring

phoneNumber

optional

Phone Numberstring

serviceAccId

optional

Service Account Id of the devicestring

slotNumber

optional

Slot Numberstring

statusRemarks

optional

Remarks for the current device statusstring

updatedDate

optional

Date at which the device details are updated

string (date-time)

updatedUser

optional

User who updated the device detailsstring

DeviceDetailsDeleteRequest

Properties

NameDescription

Schema

macAddress

optional

Mac address of the device which needs to be deleted from device manager application

string

DeviceDetailsList

Properties

NameDescription

Schema

device

optional

Details of all the devices grouped in to a List

<DeviceDetailsDO> array

DeviceDetailsRequest

Properties

NameDescription

Schema

accountId

required

Id of the account to which the device belongs

string

createdBy

optional

User who added device to the device managerstring

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 devicestring

gatewayMacAddress optional

MAC address of the devicestring

headEndName

optional

Details of HEAD END of the devicestring

ipAddress

required

IP Address of the devicestring

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 devicestring

phoneNumber

optional

Phone Numberstring

serviceAccId

optional

Service Account IDstring

slotNumber

optional

Slot Numberstring

mtaIpAddress

optional

MTA IP Address of the device string

mtaMacAddress

optional

MTA MAC Address of the device string

serialNumber

optional

Serial Number of the device string

hardwareVersion

optional

Hardware Version details of the devicestring

statusRemarks

optional

Remarks for the current device statusstring

updatedDate

optional

Date at which the device details are updated

string (date-time)

updatedUser

optional

User who updated the device detailsstring

DeviceDetailsResponse

Properties

NameDescription

Schema

device

optional

Details of device.

DeviceDetailsDO

DeviceFeatures

Properties

NameDescription

Schema

deviceDetails

optional

Indicates the details of the device 

DeviceDetails

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

NameDescription

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

NameDescription

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

NameDescription

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

UserDetails

DeviceInformation

Properties

NameDescription

Schema

ecmIp

optional

ECM IP address of the device

string

ecmMac

optional

ECM MAC address of the devicestring

estbIp

optional

ESTB IP address of the devicestring

estbMac

optional

ESTB MAC address of the devicestring

DeviceModel

Properties

NameDescription

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

NameDescription

Schema

deviceModelId

optional

Id of the device model in device manager application

integer (int32)

deviceModelName required

Name of the device model

string

DevicePoolRequest

Properties

NameDescription

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

NameDescription

Schema

deviceProps

required

Indicates the List of properties of a particular device

<string > array 

mac

required

MAC address of the device

string

DevicePropsResponse

Properties

NameDescription

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

GetSSHRequest

Properties

NameDescription

Schema

ipAddress

required

ipaddress of the device

string

GetSSHResponse

Properties

NameDescription

Schema

sshUserName optional

SSH Connection Username

string

sshPassword optional

SSH Connection Password

string

sshAuthType optional

Authentication type of SSH connection

string

sshPrivateKeyLocation

optional

Privatekeylocation where key for SSH connection is specified

string

sshPortNumber

optional

Port to which SSH Connection is specified

string

DeviceRequest

Properties

NameDescription

Schema

mac

required

MAC address of the device

string

DeviceUpdateDurationRequest

Properties

NameDescription

Schema

lockDurationInMins required

Indicates Lock duration of device in minutes

integer (int32)

mac

required

MAC Address of the device

string

Feature

Properties

NameDescription

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

NameDescription

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

NameDescription

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

NameDescription

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

NameDescription

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

NameDescription

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

NameDescription

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

NameDescription

Schema

macList

optional

List of device MAC address

< string > array

QueryDeviceResponse

Properties

NameDescription

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

NameDescription

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

NameDescriptionNameDescription

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

NameDescription

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

NameDescription

Schema

accountId

optional

Id of the account to which the device belongs

string

createdBy

optional

User who added device to the device managerstring

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 devicestring

gatewayMacAddress optional

MAC address of the devicestring

headEndName

optional

Details of HEAD END of the devicestring

currentMacAddress

optional

MAC address of the device which is currently configured in device manager applicationstring

currentIpAddress

optional

IP address of the device which is currently configured in device manager applicationstring

ipAddress

optional

IP Address of the devicestring

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 devicestring

phoneNumber

optional

Phone Numberstring

serviceAccId

optional

Service Account IDstring

slotNumber

optional

Slot Numberstring

statusRemarks

optional

Remarks for the current device statusstring

updatedDate

optional

Date at which the device details are updated

string (date-time)

updatedUser

optional

User who updated the device detailsstring

UserRequest

Properties

NameDescription

Schema

userIdEnter Unique User Id of user need to be deleted String

UserDetailsRequest

Properties

NameDescription

Schema

emailId(optional)email id of user String
isAdminUser(optional)IsAdminUser is set to "Y" if user is admin or set to "N" String
password(optional)passwordString
userId(required)Unique user id for each userString
userName(required)Enter username for the required user detailsString

PowerManagerDetails 

Properties

NameDescription

Schema

groupDetails(optional)GroupDetails of power manager Object
outletCount(required)Total number of outlet available for power manager String
outletStartIndex(required)Outlet Start Index of power managerString
powerManagerName(required)Unique power manager nameString
powerManagerUrl(required)Power Manager UrlString
supportedOperations(optional)

Power Manager Supported Operations

EX: ON,OFF,POWER_STATUS,POWER_CYCLE

String

PowerManagerDeleteRequest 

Properties

NameDescriptionschema
powerManagerName(required)power manager nameString

PowerManagerUpdateRequest 

Properties

NameDescription

Schema

currentPowerManagerName(required)Current power manager name that need to be updatedString
groupDetails(optional)GroupDetails of power manager Object
outletCount(optional)Total number of outlet available for power manager String
outletStartIndex(optional)Outlet Start Index of power managerString
powerManagerName(optional)Unique power manager nameString
powerManagerUrl(optional)Power Manager UrlString
supportedOperations(optional)

Power Manager Supported Operations

EX: ON,OFF,POWER_STATUS,POWER_CYCLE

String

PowerDeviceDO 

Properties

NameDescription

Schema

groupName(required)Group nameString
macAddress(required)Device mac addressString
powerManagerName(required)Power Manager Name device need to be mappedString
slotNumber(required)Slot Number Integer

PowerDeviceDeleteRequest 

Properties

NameDescription

Schema

macAddressdevice mac addressString

PowerDeviceUpdateRequest 

Properties

NameDescription

Schema

currentMacAddressCurrent device mac address that need to be updatedString
groupName(required)Group name String
macAddress(required)Device mac addressString
powerManagerName(required)Power Manager Name device need to be mappedString
slotNumber(required)Slot Number Integer

PowerOperationDO 

Properties

NameDescription

Schema

extraProperties(optional)Extra properties String
powerManagerName(required)Power Manager NameString
powerOperation(required)Power OperationString
requestType(required)

Request Type

Ex: PUT , GET , POST ,DELETE

String
urlTemplate(required)Url template String
repsonseBodyTemplate(optional)Response Body TemplateString
requestBodyTemplate(optional)Request Body TemplateString
responseCode(optional)Response Code String

PowerOperationUpdateRequest 

Properties

NameDescription

Schema

currentPowerManagerName(required)Cuurent Power Manager NameString
currentPowerOperation(required)

Current Power Operation

String
requestType(optional)

Request Type

Ex: PUT , GET , POST ,DELETE

String
urlTemplate(optional)Url TemplateString
repsonseBodyTemplate(optional)Response Body TemplateString
requestBodyTemplate(optional)Request Body TemplateString
responseCode(optional)Response Code String

PowerOpeartionDeleteRequest 

Properties

NameDescription

Schema

powerManagerName(required)Power Manager NameString
powerOperation(required)Power OperationString
  • No labels