Alert Service

Owned by Mario Mann
Last updated: Oct 06, 2017 by Marius Oehler

Overview

ServiceDescription
Get all alertsThis service returns information of all existing alerts
Get all open alertsThis service returns information of all open alerts
Get all closed alertsThis service returns information of all closed alerts
Get alertThis service returns a one alert 

1. Get all alerts

Path:/rest/alerts
Example URI:/rest/alerts
Example output:
[{
	"id": "e1a8ea66-b292-445e-8e70-4298ba0d3f9f",
	"alertingDefinition": {
		"id": "a024830a-a980-4493-82c8-d11a62913b15",
		"name": "Sync. Loading SLA",
		"description": null,
		"createdDate": 1507272286739,
		"updatedDate": 1507272452893,
		"importDate": null,
		"threshold": 100.0,
		"field": "duration",
		"thresholdType": "UPPER_THRESHOLD",
		"measurement": "businessTransactions",
		"tags": {
			"businessTxName": "Sync. Loading",
			"applicationName": "Demo Application"
		},
		"notificationEmailAddresses": ["alert@example.org"]
	},
	"startTimestamp": 1507272605248,
	"stopTimestamp": -1,
	"closingReason": null,
	"open": true
}]

 

2. Get all open alerts

Path:/rest/alerts/open
Example URI:/rest/alerts/open
Example output:
[{
	"id": "e1a8ea66-b292-445e-8e70-4298ba0d3f9f",
	"alertingDefinition": {
		"id": "a024830a-a980-4493-82c8-d11a62913b15",
		"name": "Sync. Loading SLA",
		"description": null,
		"createdDate": 1507272286739,
		"updatedDate": 1507272452893,
		"importDate": null,
		"threshold": 100.0,
		"field": "duration",
		"thresholdType": "UPPER_THRESHOLD",
		"measurement": "businessTransactions",
		"tags": {
			"businessTxName": "Sync. Loading",
			"applicationName": "Demo Application"
		},
		"notificationEmailAddresses": ["alert@example.org"]
	},
	"startTimestamp": 1507272605248,
	"stopTimestamp": -1,
	"closingReason": null,
	"open": true
}]

3. Get all closed alerts

Path:/rest/alerts/closed
Example URI:/rest/alerts/closed
Example output:
[{
	"id": "e1a8ea66-b292-445e-8e70-4298ba0d3f9f",
	"alertingDefinition": {
		"id": "a024830a-a980-4493-82c8-d11a62913b15",
		"name": "Sync. Loading SLA",
		"description": null,
		"createdDate": 1507272286739,
		"updatedDate": 1507273537281,
		"importDate": null,
		"threshold": 1000.0,
		"field": "duration",
		"thresholdType": "UPPER_THRESHOLD",
		"measurement": "businessTransactions",
		"tags": {
			"businessTxName": "Sync. Loading",
			"applicationName": "Demo Application"
		},
		"notificationEmailAddresses": ["alert@example.org"]
	},
	"startTimestamp": 1507272605248,
	"stopTimestamp": 1507273745290,
	"closingReason": "ALERT_RESOLVED",
	"open": false
}]

4. Get alert

Path:/rest/alerts/{alertId}
Parameters:
  1. alertId (String value, required) - Id of the alert to get.
Example URI:/rest/alerts/e1a8ea66-b292-445e-8e70-4298ba0d3f9f
Example output:
{
	"id": "e1a8ea66-b292-445e-8e70-4298ba0d3f9f",
	"alertingDefinition": {
		"id": "a024830a-a980-4493-82c8-d11a62913b15",
		"name": "Sync. Loading SLA",
		"description": null,
		"createdDate": 1507272286739,
		"updatedDate": 1507272452893,
		"importDate": null,
		"threshold": 100.0,
		"field": "duration",
		"thresholdType": "UPPER_THRESHOLD",
		"measurement": "businessTransactions",
		"tags": {
			"businessTxName": "Sync. Loading",
			"applicationName": "Demo Application"
		},
		"notificationEmailAddresses": ["alert@example.org"]
	},
	"startTimestamp": 1507272605248,
	"stopTimestamp": -1,
	"closingReason": null,
	"open": true
}