AlarmFilter

AlarmFilter
AlarmFilter

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

This structure may be used only with operations rendered under /sms.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "alarmStatus": "string",
    "alarmType": "string",
    "entityType": "string",
    "entityId": [
        {
            "_typeName": "string"
        }
    ],
    "pageMarker": "string"
}
string
alarmStatus
Optional

The status of the alarm to search for.

Should be one of SmsAlarmStatusEnum. If not specified, all status values should be considered.

string
alarmType
Optional

The status of the alarm to search for.

Should be one of AlarmTypeEnum. If not specified, all alarm types should be considered.

string
entityType
Optional

The entityType of interest, VASA provider should return all active alarms of this type when entityId is not set.

See SmsEntityTypeEnum.

array of Any
entityId
Optional

The identifiers of the entities of interest.

If set, all entities must be of the same SmsEntityTypeEnum and it should be set in entityType. VASA provider can skip listing the missing entities.

string
pageMarker
Optional

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.

Property Of