Device Groups Service Methods

[EcoStruxureIT]

Device Group Service WSDL

Device Group services allow 3^rd-party applications to obtain information relating to the user-defined conceptual grouping of devices within the Data Center Expert model.

Note: The following web service methods return only device groups the caller has access to, as determined by the user account credentials specified with each method invocation. If a call normally returns a reference to the “All Devices” root device group, but the caller does not have access to this group, a virtual “All My Devices” root group is returned as a substitute to maintain the hierarchical nature of the device groups.

The following sections describe the methods of the Device Groups service.

getAllDeviceGroups

Returns a list of ISXCDeviceGroup objects representing all device groups that exist in the Data Center Expert server. 

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getDeviceGroupByID

Returns a list of ISXCDeviceGroup objects representing all device groups that exist in the Data Center Expert server. 

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier for the device group being requested.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getRootDeviceGroup

Returns an ISXCDeviceGroup object representing the root device group from which all other device groups are descended. 

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getDevicesForGroupID

Returns a list of ISXCDevice objects representing the devices contained in the device group that is identified by the specified ID. 

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier for the device group being requested.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getUniqueDeviceGroupForDevice

Returns a list of ISXCDeviceGroup objects representing the device groups that the device identified by the specified ID was directly assigned to.

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier for the device group being requested.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getDeviceGroupsForDevice

Returns a list of ISXCDeviceGroup objects representing the device groups that the device identified by the specified ID is contained in.

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier for the device group being requested.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getChildDeviceGroups

Returns a list of ISXCDeviceGroup objects representing the device groups that are contained in the device group identified by the specified ID. 

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier for the device group being requested.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.

getParentDeviceGroup

Returns an ISXCDeviceGroup object representing the device group that contains the device group identified by the specified ID. 

Service: ISXCentralDeviceGroupsService

Parameter	Type	Description
ISXCElementID	String	The unique identifier for the device group being requested.
locale (optional)	String	Specifies the locale results are translated into before being returned. The default value is the locale configured in the Data Center Expert server.