AlertQuery
Query for alerts by various criteria. Composition of filtering criteria controlled via the compositeOperator property. For Pagination see PageInfo For sorting see AlertField and SortOrder enumerations. If a sort field is not specified but pagination is requested the Alerts will be sorted by the alertId field.
Properties
Filter to return only Active alerts, if true, the query will exclude Suspended and Cancelled Alerts
Filter based on the Alert Control State
Possible values are: OPEN , ASSIGNED , SUSPENDED , SUPPRESSED
Filter based on Alert Criticality
Possible values are: UNKNOWN , NONE , INFORMATION , WARNING , IMMEDIATE , CRITICAL , AUTO
Filter based on the Alert definition id
Filter based on Alert identifiers
Filter based on the Alert Impact
Filter based on Alert name using ‘contains’ logic
Filter based on the Alert Status. If looking for only active alerts combined with other filter criteria then use the activeOnly property instead.
Possible values are: NEW , ACTIVE , UPDATED , CANCELED
Indicates the composition of the filtering criteria. Either all of the filtering criteria apply together (AND operation) or any of the filtering criteria could be applied (OR operation) Defaults to AND. Note: backend only supports AND currently
Possible values are: AND , OR
Indicates whether need to report alert owner’s name in addition to owner’s id
Filter based on alert group id
Condition that should be used for grouping
Possible values are: GROUP_BY_ALERT_DEFINITION , GROUP_BY_RESOURCE_KIND , GROUP_BY_CRITICALITY , GROUP_BY_TIME , GROUP_BY_SCOPE
True to include alerts generated by child resources
Return alarms associated with resources matching query criteria
Filter based on resource kind using ‘contains’ logic
Filter based on user id
Filter based on user name using ‘contains’ logic
JSON Example
{
"activeOnly": false,
"alertControlState": [
"OPEN"
],
"alertCriticality": [
"UNKNOWN"
],
"alertDefinitionId": [
"string"
],
"alertId": [
"string"
],
"alertImpact": [
"string"
],
"alertName": "string",
"alertStatus": [
"NEW"
],
"alertTypeSubtype": [
{
"subtypeIds": [
0
],
"typeId": 0
}
],
"cancelTimeRange": {
"endTime": 0,
"startTime": 0
},
"compositeOperator": "AND",
"extractOwnerName": false,
"groupId": "string",
"groupingCondition": "GROUP_BY_ALERT_DEFINITION",
"includeChildrenResources": false,
"resource-query": {
"adapterInstanceId": [
"string"
],
"adapterKind": [
"string"
],
"collectorId": [
0
],
"collectorName": [
"string"
],
"credentialId": [
"string"
],
"includeRelated": "PARENT",
"maintenanceScheduleId": [
"string"
],
"name": [
"string"
],
"parentId": [
"string"
],
"propertyConditions": {
"conditions": [
{
"doubleValue": 0,
"key": "string",
"operator": "EQ",
"stringValue": "string"
}
],
"conjunctionOperator": "AND"
},
"propertyName": "string",
"propertyValue": "string",
"recentlyAdded": 0,
"regex": [
"string"
],
"resourceHealth": [
"GREEN"
],
"resourceId": [
"string"
],
"resourceKind": [
"string"
],
"resourceState": [
"STOPPED"
],
"resourceStatus": [
"NONE"
],
"resourceTag": [
{
"category": "string",
"name": "string"
}
],
"statConditions": {
"conditions": [
{
"doubleValue": 0,
"key": "string",
"operator": "EQ",
"stringValue": "string"
}
],
"conjunctionOperator": "AND"
},
"statKey": "string",
"statKeyInclusive": false,
"statKeyLowerBound": 0,
"statKeyUpperBound": 0
},
"resourceKind": "string",
"startTimeRange": {
"endTime": 0,
"startTime": 0
},
"updateTimeRange": {
"endTime": 0,
"startTime": 0
},
"userId": "string",
"userName": "string"
}
Property Of
AlertNotesQuery
Parameter To
Delete Canceled Alerts
Query Alert Groups
Query Alert
