Query Alert Using POST
Data returned includes a Collection of Alert Notes. Example: POST /api/alerts/query
Page number from which data needs to be displayed (0-based)
Expected number of entries per page
The alertQuery criteria
{
"activeOnly": false,
"alertControlState": [
"string"
],
"alertCriticality": [
"string"
],
"alertDefinitionId": [
"string"
],
"alertId": [
"string"
],
"alertImpact": [
"string"
],
"alertName": "string",
"alertStatus": [
"string"
],
"alertTypeSubtype": [
{
"subtypeIds": [
0
],
"typeId": 0
}
],
"cancelTimeRange": {
"endTime": 0,
"startTime": 0
},
"compositeOperator": "string",
"extractOwnerName": false,
"groupId": "string",
"groupingCondition": "string",
"includeChildrenResources": false,
"resource-query": {
"adapterInstanceId": [
"string"
],
"adapterKind": [
"string"
],
"collectorId": [
0
],
"collectorName": [
"string"
],
"credentialId": [
"string"
],
"includeRelated": "string",
"maintenanceScheduleId": [
"string"
],
"name": [
"string"
],
"parentId": [
"string"
],
"propertyConditions": {
"conditions": [
{
"doubleValue": "number",
"key": "string",
"operator": "string",
"stringValue": "string"
}
],
"conjunctionOperator": "string"
},
"propertyName": "string",
"propertyValue": "string",
"recentlyAdded": 0,
"regex": [
"string"
],
"resourceHealth": [
"string"
],
"resourceId": [
"string"
],
"resourceKind": [
"string"
],
"resourceState": [
"string"
],
"resourceStatus": [
"string"
],
"resourceTag": [
{
"category": "string",
"name": "string"
}
],
"statConditions": {
"conditions": [
{
"doubleValue": "number",
"key": "string",
"operator": "string",
"stringValue": "string"
}
],
"conjunctionOperator": "string"
},
"statKey": "string",
"statKeyInclusive": false,
"statKeyLowerBound": "number",
"statKeyUpperBound": "number"
},
"resourceKind": "string",
"startTimeRange": {
"endTime": 0,
"startTime": 0
},
"updateTimeRange": {
"endTime": 0,
"startTime": 0
},
"userId": "string",
"userName": "string"
}
Filter to return only Active alerts, if true, the query will exclude Suspended and Cancelled Alerts
Filter based on the Alert Control State
Filter based on Alert Criticality
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.
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
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
True to include alerts generated by child resources
Object used to lookup resources with various filtering criteria
Filter based on resource kind using 'contains' logic
Filter based on user id
Filter based on user name using 'contains' logic
The Collection of Alerts matching the specified Query Spec (Collection can be empty)
{
"alerts": [
{
"alertDefinitionId": "string",
"alertDefinitionName": "string",
"alertId": "string",
"alertImpact": "string",
"alertLevel": "string",
"cancelTimeUTC": 0,
"controlState": "string",
"extension": {
"anyObjects": [
{}
]
},
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"ownerId": "string",
"ownerName": "string",
"resourceId": "string",
"startTimeUTC": 0,
"statKey": "string",
"status": "string",
"subType": "string",
"suspendUntilTimeUTC": 0,
"type": "string",
"updateTimeUTC": 0
}
],
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"pageInfo": {
"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "string",
"totalCount": 0
}
}
Error occurred while retrieving the Alerts