DCE web services API

    Data Center Expert version 8.1.0 introduced the public DCE REST API. Instructions are available at https://<server_address>/isxg/rest   DCE 8.1.0 release notes     The Data Center Expert web services API is vendor-neutral, scalable monitoring software that collects, organizes, and distributes critical alerts, surveillance video, and key information. It provides a unified view of complex physical infrastructure environments from anywhere on the network. Manage your APC devices from a single system by forwarding SNMP traps (events) to your preferred enterprise management system.   Device Access, Authentication and Permissions Data Center Expert web services supports basic authentication over HTTP or HTTPS (SSL). User credentials (username/password) must be provided for every web service method invocation; the concept of a single-login-session is not supported. The credentials used must belong to a valid Data Center Expert user account configured on the Data Center Expert server being queried. The permissions configured on the Data Center Expert server for the user account can affect the contents of web service query responses. Responses to web service queries will only contain references to devices and other entities that the user account has been granted permission to access.   Localization and Internationalization Most of the methods specified in the Data Center Expert web service interface accept a locale parameter which may affect the representation of data returned by those methods. In all instances, a locale is specified as a string in the format “xx-YY” where xx represents a two letter language identifier (in compliance with ISO-639 language codes) and YY represents a two letter country identifier (in compliance with ISO-3166 country codes). Note: If no locale (null) or an unsupported locale is specified in a method call, the current server locale configuration is assumed.   If a specified locale has a language code that matches the language code of a supported locale, even though the country codes may not match, the supported locale will be used.   Supported locales in Data Center Expert US English (en-US) Japanese (ja-JP) Korean (ko-KR) Simplified Chinese (zh-CN) Russian (ru-RU) Brazilian Portuguese (pt-BR) French (fr-FR) Spanish (es-ES) Italian (it-IT) German (de-DE)   Web Service Description Language Files Web services often employ one or more Web Service Description Language (WSDL) files to describe, in a standardized format, the methods of a web service interface and the data passed to and from those methods.   WSDL files can be used by client application developers to generate “stub” code for invoking the methods of a particular web service. There are a large number of publicly available WSDL-to-code generators. WSDL files can also be used at run-time to format data sent to, or validate received from, a web service method.   Data Center Expert server provides access to separate WSDL files.   Sensor Service Methods ISXCentralAlarmsService_v2_0 Device Groups Service Methods ISXCentralDeviceGroupService_v2_0 Device Service Methods ISXCentralDeviceService_v2_0 Alarms Service Methods ISXCentralSensorService_v2_0   The Data Center Expert server publishes WSDL files at this URL: http://<server>/integration/services/<WSDL>?wsdl   This URL returns dynamically generated WSDL files, guaranteeing the files reflect the version of the Data Center Expert software currently installed on the server. Access to this URL requires authentication credentials of a valid Data Center Expert user. Note the “?” in the URL. Note: The dynamically generated WSDL contains references to the server from which it was obtained. In the static WSDL, server references are replaced with the string “SERVER_REPLACE_ME”.

Sensor Service WSDL A sensor represents any measurable value or state within a device or probe. It is easy to confuse the terms sensors and probes. In the Data Center Expert domain, a probe is a physical entity for measuring an aspect of the physical environment, while a sensor is a conceptual entity which simply references any device or probe value or state. Sensors themselves have an associated state value. This value indicates whether the sensor is connected or not (for sensors associated with probes) and whether there is an alarm condition associated with the value of the sensor. Alarms are generally triggered when a sensor’s value exceeds a threshold defined by the user on the device or on Data Center Expert. Sensors are organized by a pre-defined set of sensor types. Most devices support a DEVICE_STATUS sensor. Some devices will support multiple instances of a particular sensor type such as the BREAKER_CURRENT sensor on a PDU. When a device does have multiple instances of a sensor, each instance will be identified by a sequential index number. Some devices consist of modules or sub-systems and sometimes these modules have multiple instances of a certain type of sensor. In these cases, the sensor instances are double-indexed; once for the module instance and once for the sensor instance. When referencing a NetBotz probe sensor, the sensor index often represents the port that the probe is plugged into. The following methods are available through the Sensor web service. initializeSensorService This optional method serves two purposes. First, it allows the sensor web service to be customized using a string of parameter values (NYI). Secondly, it provides a mechanism for isolating the 2-3 second set up time required for the first (and only the first) invocation of the sensor service; otherwise, a client has to endure that set up time during the processing of that first sensor service request. Returns true if successful. Service: ISXCentralSensorService Parameter Type Description initialParameters  String Ignored getSensorByID Returns an ISXCSensor object that represents a sensor being monitored by the Data Center Expert server and is identified by the specified ID.  Service: ISXCentralSensorService Parameter Type Description ISXCElementID  String The unique identifier of a sensor being monitored by the 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 Data Center Expert server. getSensorsByIDs Returns a list of ISXCSensor objects that represent sensors being monitored by the Data Center Expert server and are identified by the specified IDs.  Service: ISXCentralSensorService Parameter Type Description ISXCElementID list  String A list of unique identifiers of sensors being monitored by the 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 Data Center Expert server. getSensorsByType Returns a list of ISXCSensor objects that represent sensors being monitored by the Data Center Expert server and are of the specified type.  Service: ISXCentralSensorService Parameter Type Description sensorType ISXCSensorType The specific type of the sensors to return. 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. getSensorsForDevice  Returns a list of ISXCSensor objects that represent sensors connected to the DCE-server-monitored device that is identified by the specified ID.  Service: ISXCentralSensorService Parameter Type Description ISXCElementID  String The unique ID of the device to return sensors for. sensorType (optional) ISXCSensorType The sensor type to filter the results on. 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. getDeviceForSensor Returns an ISXCDevice object that represents the DCE-server-monitored device that the sensor with the specified ID is connected to. Service: ISXCentralSensorService Parameter Type Description  ISXCElementID  String The unique ID of the sensor to return the device for. 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. getSensorData Returns an ISXCSensorData object that represents the current value data for the sensor with the specified ID. Service: ISXCentralSensorService Parameter Type Description  ISXCElementID  String The unique ID of the sensor to return the data for. 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.   For the getMultiple<X> methods, it is important to realize that specifying large sensor ID lists or “wide” date ranges can cause excessive CPU and/or memory utilization resulting in overall performance degradation. To prevent this, specify as few sensors and/or as narrow a date range as is reasonable for your application. getMultipleSensorData Returns a list of ISXCSensorDataSet objects that represent the current value data for a list of sensors with the specified IDs. Recommended when querying for data for 4 or more sensors. For 3 or less sensors, it may be more efficient to use the getSensorData method. Service: ISXCentralSensorService Parameter Type Description  ISXCElementID list String The unique IDs of the sensors to return the data for. 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. getMultiplePeakSensorData Returns a list of ISXCSensorDataSet objects that represent the peak value data for a list of sensors with the specified IDs. Recommended when querying for data for 4 or more sensors. For 3 or less sensors, it may be more efficient to use the getSensorDataRange method. Service: ISXCentralSensorService Parameter Type Description  ISXCElementID list String The unique IDs of the sensors to return the data for. startDateTime (optional) xsd:datetime The start date-time of the range to return data for, or null to return data from start of recorded data. endDateTime (optional) xsd:datetime The end date-time of the range to return data for, or null to return data until the end of recorded data. 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. getMultipleAverageSensorData Returns a list of ISXCSensorDataSet objects that represent the average value data for a list of sensors with the specified IDs. Recommended when querying for data for 4 or more sensors. For 3 or less sensors, it may be more efficient to use the getAverageSensorData method. Service: ISXCentralSensorService Parameter Type Description  ISXCElementID list String The unique IDs of the sensors to return the data for. startDateTime (optional) xsd:datetime The start date-time of the range to return data for, or null to return data from start of recorded data. endDateTime (optional) xsd:datetime The end date-time of the range to return data for, or null to return data until the end of recorded data. 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. getHistoricalSensorData Returns a list of ISXCSensorData objects that represent the recorded value data for a sensor with the specified ID.  Service: ISXCentralSensorService Parameter Type Description  ISXCElementID String The unique ID of the sensor to return the data for. startDateTime (optional) xsd:datetime The start date-time of the range to return data for, or null to return data from start of recorded data. endDateTime (optional) xsd:datetime The end date-time of the range to return data for, or null to return data until the end of recorded data. 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. maxDataPoints (optional) integer The max number of data points to return in the request. Value cannot exceed 1000. Note: ISXCSensorData objects contain timestamps corresponding to when the sensor data was captured. Since these timestamps can be used to determine/enforce sample order, there is no guarantee of any order in the returned list of samples. getAverageSensorData Returns an ISXCSensorData object that represents the average value of recorded data for a sensor with the specified ID.  Service: ISXCentralSensorService Parameter Type Description  ISXCElementID String The unique ID of the sensor to return the data for. startDateTime (optional) xsd:datetime The start date-time of the range to return data for, or null to return data from start of recorded data. endDateTime (optional) xsd:datetime The end date-time of the range to return data for, or null to return data until the end of recorded data. 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.   getAverageSensorRange Returns the ISXCSensorData objects that represent the highest and lowest values of recorded data for a sensor with the specified ID.  Service: ISXCentralSensorService Parameter Type Description  ISXCElementID String The unique ID of the sensor to return the data for. startDateTime (optional) xsd:datetime The start date-time of the range to return data for, or null to return data from start of recorded data. endDateTime (optional) xsd:datetime The end date-time of the range to return data for, or null to return data until the end of recorded data. 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. Note: Normally ISXCSensorData objects contain timestamps corresponding to when the sensor data was captured. In the case of min/max sensor data, the timestamps are set to the user-specified EndDateTime. Because each min/max value could appear multiple times within a given date range, it is not possible to ascribe a specific collection date to either of the two returned min/max values. getSensorEnumerations Returns a list of localized strings that correspond to possible values for a sensor that returns an enumeration index as its current data value and is identified by the specified ID.  Service: ISXCentralSensorService Parameter Type Description  ISXCElementID String The unique ID of the sensor to return the enumerations for. 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. Note: For sensors with enumerated value-types, the enumerated value definitions can vary from device model to device model. For example, an enumerated value of “0” for BATTERY_STATUS may mean “OK” on one UPS but may represent “Unknown” on another. Data Center Expert strives to normalize these values so they are consistent across devices. The number of supported devices makes this difficult to guarantee. Verify sensor enumerations for all device models your application supports.

Device Service SDL The Data Center Expert Device web service exposes information about devices being monitored by a 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 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 Data Center Expert server.  Service: ISXCentralDeviceService Parameter Type Description locale (optional) String The unique identifier of a device being monitored by the Data Center Expert server. getDeviceByID Returns an ISXCDevice object that represents a device being monitored by the Data Center Expert server, identified by the specified ID.  Service: ISXCentralDeviceService Parameter Type Description ISXCElementID String The unique identifier of a device being monitored by the 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 Data Center Expert. getDeviceByIPAddress Returns an ISXCDevice object that represents a device being monitored by the Data Center Expert server, identified by the specified IP address.  Service: ISXCentralDeviceService Parameter Type Description ipAddress String The IP address of a device being monitored by the 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 Data Center Expert. getDeviceByHostName Returns an ISXCDevice object that represents a device being monitored by the Data Center Expert server, identified by the specified host name.  Service: ISXCentralDeviceService Parameter Type Description hostName String The host name of a device being monitored by the 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 Data Center Expert. getDevicesByType Returns a list of ISXCDevice objects that represent devices being monitored by the Data Center Expert server and are of the specified device type.  Service: ISXCentralDeviceService Parameter Type Description deviceType ISXCDeviceType One of the valid device type identifiers for devices that can be monitored by the 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 Data Center Expert. getDevicesBySerialNumber Returns a list of ISXCDevice objects that represent devices being monitored by the Data Center Expert server and have the specified serial number.  Service: ISXCentralDeviceService Parameter Type Description serialNumber String The serial number of one of the devices being monitored by the 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 Data Center Expert. getDevicesByModelNumber Returns a list of ISXCDevice objects that represent devices being monitored by the Data Center Expert server and have the specified model number.This method is currently not functional, so will return no devices. Service: ISXCentralDeviceService Parameter Type Description modelNumber String The model number of one or more of the devices being monitored by the 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 Data Center Expert. getDevicesByModelName Returns a list of ISXCDevice objects that represent devices being monitored by the Data Center Expert server and have the specified model name.  Service: ISXCentralDeviceService Parameter Type Description modelName String The model name of one or more of the devices being monitored by the 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 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 Parameter Type Description ISXCElementID String The unique identifier of a device being monitored by the 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 Data Center Expert. getParentDevice Returns an ISXCDevice object that represents a device managing the device with the specified ID.  Service: ISXCentralDeviceService Parameter Type Description ISXCElementID String The unique identifier of a device being monitored by the 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 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 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. getControllableDevicesByControlType Returns a list of ISXCDevice objects that represent devices being monitored by the Data Center Expert server and have controls of the specified type. Service: ISXCentralDeviceService Parameter Type Description controlTypeID String 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 Data Center Expert. getDeviceControlsForDevice Returns a list of ISXCDeviceControl objects representing the device controls, of the specified type, supplied by this device. Service: ISXCentralDeviceService Parameter Type Description ISXCElementIDForDevice String Specifies the unique identifier of a device being monitored by the Data Center Expert server. controlTypeID String 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 Data Center Expert. setDeviceControlByID Set the value of a device control. Note: This method does not supply a response. Service: ISXCentralDeviceService Parameter Type Description ISXCElementIDForDevice String The unique identifier of a device being monitored by the Data Center Expert server. controlTypeID String 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 Data Center Expert.

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.

Alarms Service WSDL Alarms are conditions within the data center infrastructure that require attention. The textual contents of Data Center Expert alarms are localized to a user specified locale when they are retrieved from the server. If no locale is specified, the server default locale is assumed. All alarms contain a reference to the device that is experiencing the alarm condition. If an alarm is associated with a specific device sensor, a reference to that sensor may also be included in the alarm. Sensor-related alarms are usually generated when a user-defined threshold for the sensor value is violated. Sensor thresholds can be defined either directly on the device or in the Data Center Expert server.  An alarm is either active, meaning the condition that triggered the alarm still exists, or resolved, meaning the trigger condition no longer exists. The following sections describe the methods of the Alarms service. getAllActiveAlarms Returns a list of ISXCAlarm objects that represent all alarms that are currently unresolved in the Data Center Expert server.  Service: ISXCentralAlarmsService 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. getAlarmByID Returns an ISXCAlarm object that represents an alarm (active or resolved) in the Data Center Expert server and is identified by the specified ID.  Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier of an alarm that was created in the 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 Data Center Expert server. getActiveAlarmsForDevice Returns a list of ISXCAlarm objects that represent active alarms associated with an DCE-server-monitored device which is identified by the specified ID.  Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier of a device that is being monitored by the Data Center Expert server. excludeSensors (optional) boolean When set to true, alarms associated with sensors will be filtered from the result set, and only alarms that are directly associated with the device will be returned. 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. getActiveAlarmsForSensor Returns a list of ISXCAlarm objects that represent active alarms associated with an DCE-server-monitored sensor which is identified by the specified ID.  Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier of a sensor that is being monitored by the 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 Data Center Expert server. getActiveAlarmsForSeverity Returns a list of ISXCAlarm objects that represent active alarms which have a severity that matches the specified severity level. Service: ISXCentralAlarmsService Parameter Type Description severity ISXCAlarmSeverity The severity to filter the resulting alarms on.  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. getAlarmsHistory Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame. Service: ISXCentralAlarmsService Parameter Type Description startDate xsd:datetime The start date-time of the range to return data for.  endDate xsd:datetime The end date-time of the range to return data for.  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. getAlarmsHistoryForDevice Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame and associated with the specific device. Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier for an DCE-server-monitored device.  startDate xsd:datetime The start date-time of the range to return data for.  endDate xsd:datetime The end date-time of the range to return data for.  excludeSensors (optional) boolean When set to true, alarms associated with sensors are excluded from the results, and only alarms directly associated with the specified device are returned. 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. getAlarmsHistoryForSensnor Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame and associated with the specific sensor. Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier for an DCE-server-monitored sensor.  startDate xsd:datetime The start date-time of the range to return data for.  endDate xsd:datetime The end date-time of the range to return data for.  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. getAlarmsHistoryForSeverity Returns a list of ISXCAlarm objects that represent alarms that were active during the specified time frame and were of the specified severity. Service: ISXCentralAlarmsService Parameter Type Description severity ISXCAlarmSeverity The alarm severity to filter the results on.  startDate xsd:datetime The start date-time of the range to return data for.  endDate xsd:datetime The end date-time of the range to return data for.  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. getAlarmsDeltaHistory Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame. Service: ISXCentralAlarmsService Parameter Type Description secondsInPast integer The number of seconds to go back (relative to “now”) and evaluate alarm data for. 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. getAlarmsDeltaHistoryForDevice Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame and were associated with the specified device. Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier for an DCE-server-monitored device.   secondsInPast integer The number of seconds to go back (relative to “now”) and evaluate alarm data for. excludeSensors (optional) boolean When set to true, alarms associated with sensors are excluded from the results, and only alarms directly associated with the specified device are returned. 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. getAlarmsDeltaHistoryForSensor Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame and were associated with the specified sensor. Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier for an DCE-server-monitored sensor.   secondsInPast integer The number of seconds to go back (relative to “now”) and evaluate alarm data for. 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. getAlarmsDeltaHistoryForSeverity Returns a list of ISXCAlarm objects that represent alarms that had a change of status during the specified time frame and were of the specified severity. Service: ISXCentralAlarmsService Parameter Type Description ISXCElementID String The unique identifier for an DCE-server-monitored sensor.   secondsInPast integer The number of seconds to go back (relative to “now”) and evaluate alarm data for. 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. setAcknowledgmentForAlarm Allows the user to comment an alarm, set the alarm as hidden, and to suppress notifications of this alarm. Service: ISXCentralAlarmsService Parameter Type Description alarmID String The unique identifier for an alarm. comment (optional) String The comment the user wants to add to the alarm acknowledgment history.  isAlarmHidden  boolean Indicates if the alarm should be hidden in the DCE clients.  isAlarmAlertSuppressed boolean Indicates if the alarm notifications (alerts) should be suppressed. getAcknowledgmentForAlarm Allows the user retrieve the acknowledgments status: is alarm hidden, are alarm notifications suppressed. Service: ISXCentralAlarmsService Parameter Type Description alarmID String The unique identifier for an alarm. getAcknowledgmentHistoryForAlarm Allows the user to retrieve the acknowledgment history for an alarm. Service: ISXCentralAlarmsService Parameter Type Description alarmID String The unique identifier for an alarm. deleteAcknowledgmentByID Allows the user to delete alarm acknowledgment comments. Service: ISXCentralAlarmsService Parameter Type Description  acknowledgmentID int The unique identifier for an alarm acknowledgment. alarmID String The unique identifier for an alarm.