# Data Object - AlarmFilter(sms.provider.AlarmFilter)

Parameter to
  QueryActiveAlarm
Extends
  DynamicData
Since
  SMS API 6.5

## Data Object Description

This spec contains information needed for queryActiveAlarm API to filter the result.

Properties

Name | Type | Description
--- | --- | ---
alarmStatus* | xsd:string | The status of the alarm to search for. Should be one of SmsAlarmStatus. If not specified, all status values should be considered.
alarmType* | xsd:string | The status of the alarm to search for. Should be one of AlarmType. If not specified, all alarm types should be considered.
entityId* | xsd:anyType[] | The identifiers of the entities of interest. If set, all entities must be of the same SmsEntityType and it should be set in entityType. VASA provider can skip listing the missing entities.
entityType* | xsd:string | The entityType of interest, VASA provider should return all active alarms of this type when entityId is not set. See SmsEntityType.
pageMarker* | xsd:string | The page marker used for query pagination. This is an opaque string that will be set based on the value returned by the VASA provider - see pageMarker. For initial request this should be set to null, indicating request for the first page.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AlarmFilter"> <complexContent> <extension base="sms:DynamicData"> <sequence> <element name="alarmStatus" type="xsd:string" minOccurs="0"/> <element name="alarmType" type="xsd:string" minOccurs="0"/> <element name="entityType" type="xsd:string" minOccurs="0"/> <element name="entityId" type="xsd:anyType" minOccurs="0" maxOccurs="unbounded"/> <element name="pageMarker" type="xsd:string" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>