Device Service WSDL

The StruxureWare Data Center Expert Device web service exposes information about devices being monitored by a StruxureWare Data Center Expert server, and some device control functionality. Third-party applications can also access this monitored device data.  Device control is supplied for select devices.

Once an application has obtained device data through the Devices web service, it can use other StruxureWare Data Center Expert web services to get alarm, device group, and sensor information about the devices.

The following methods are available through the Device web service. These methods only return information about devices the caller has permission to access.

getAllDevices

Returns a list of ISXCDevice objects that represent devices being monitored by the StruxureWare Data Center Expert server. 

Service: ISXCentralDeviceService

ParameterTypeDescription
locale (optional)StringThe unique identifier of a device being monitored by the StruxureWare Data Center Expert server.

getDeviceByID

Returns an ISXCDevice object that represents a device being monitored by the StruxureWare Data Center Expert server, identified by the specified ID. 

Service: ISXCentralDeviceService

ParameterTypeDescription
ISXCElementIDStringThe unique identifier of a device being monitored by the StruxureWare Data Center Expert server.
locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDeviceByIPAddress

Returns an ISXCDevice object that represents a device being monitored by the StruxureWare Data Center Expert server, identified by the specified IP address. 

Service: ISXCentralDeviceService

ParameterTypeDescription
ipAddressString

The IP address of a device being monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDeviceByHostName

Returns an ISXCDevice object that represents a device being monitored by the StruxureWare Data Center Expert server, identified by the specified host name. 

Service: ISXCentralDeviceService

ParameterTypeDescription
hostNameString

The host name of a device being monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDevicesByType

Returns a list of ISXCDevice objects that represent devices being monitored by the StruxureWare Data Center Expert server and are of the specified device type. 

Service: ISXCentralDeviceService

ParameterTypeDescription
deviceTypeISXCDeviceType

One of the valid device type identifiers for devices that can be monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDevicesBySerialNumber

Returns a list of ISXCDevice objects that represent devices being monitored by the StruxureWare Data Center Expert server and have the specified serial number. 

Service: ISXCentralDeviceService

ParameterTypeDescription
serialNumberString

The serial number of one of the devices being monitored by the StruxureWare Data Center Expert server.

For NetBotz devices, the “virtual” parent device inherits the serial number of the child enclosure device, hence the need to return a list of devices.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDevicesByModelNumber

Returns a list of ISXCDevice objects that represent devices being monitored by the StruxureWare Data Center Expert server and have the specified model number. This method is currently not functional, so will return no devices.

Service: ISXCentralDeviceService

ParameterTypeDescription
modelNumberString

The model number of one or more of the devices being monitored by the StruxureWare Data Center Expert server.

For NetBotz devices, the “virtual” parent device inherits the serial number of the child enclosure device, hence the need to return a list of devices.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDevicesByModelName

Returns a list of ISXCDevice objects that represent devices being monitored by the StruxureWare Data Center Expert server and have the specified model name. 

Service: ISXCentralDeviceService

ParameterTypeDescription
modelNameString

The model name of one or more of the devices being monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getChildDevices

Returns a list of ISXCDevice objects that represent any devices being managed by the device with the specified ID. 

Service: ISXCentralDeviceService

ParameterTypeDescription
ISXCElementIDString

The unique identifier of a device being monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getParentDevice

Returns an ISXCDevice object that represents a device managing the device with the specified ID. 

Service: ISXCentralDeviceService

ParameterTypeDescription
ISXCElementIDString

The unique identifier of a device being monitored by the StruxureWare Data Center Expert server.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDeviceControlTypes

Returns a list of ISXCDeviceControlType objects that represent a grouping of a particular type of device control (example: Outlet Control).

Service: ISXCentralDeviceService

ParameterTypeDescription
locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getControllableDevicesByControlType

Returns a list of ISXCDevice objects that represent devices being monitored by the StruxureWare Data Center Expert server and have controls of the specified type.

Service: ISXCentralDeviceService

ParameterTypeDescription
controlTypeIDString

Specifies the control type ID used to identify a control type.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

getDeviceControlsForDevice

Returns a list of ISXCDeviceControl objects representing the device controls, of the specified type, supplied by this device.

Service: ISXCentralDeviceService

ParameterTypeDescription
ISXCElementIDForDeviceString

Specifies the unique identifier of a device being monitored by the StruxureWare Data Center Expert server.

controlTypeIDString

Specifies the control type ID used to identify a control type.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

setDeviceControlByID

Set the value of a device control. Note: This method does not supply a response.

Service: ISXCentralDeviceService

ParameterTypeDescription
ISXCElementIDForDeviceString

The unique identifier of a device being monitored by the StruxureWare Data Center Expert server.

controlTypeIDString

Specifies the control type ID used to identify a control type.

locale (optional)String

Specifies the locale results are translated into before being returned. The default value is the locale configured in the StruxureWare Data Center Expert.

 

 

 


 

Skip to end of metadata
Go to start of metadata
  • No labels
RELATED COMMUNITY QUESTIONS
WAS THIS ARTICLE HELPFUL?