Alert Management API
{ urn:com.soa.alert.admin } AlertService
The API used to report and manage alerts.
POST/alertsAdd Alert
Adds/reports an alert. An alert is defined by its type, a code, and a source. The alert's type is a numeric value, 0 is for a basic alert, 1 is for a service alert, and 3 is for an SLA alert. The alert code identifies a particular event or condition that has been detected. The source of the alert is the entity the alert is about. There are several types of alert sources which are identified with a numeric value.
- unknown
- service
- operation
- contract
- organization
- endpoint
- container
Each type of source may have a different type of identifier or key used in the source property. The sourceName property provides a functional area that can be used to group or categorize the alerts. An alert may also be tied to a transaction, or action performed in the system. The most common transaction to be associated with alerts is an operation invocation.
The following example illustrates adding a service alert:
Request:
POST /rest/alerts HTTP/1.1
Content-Type: application/json
{
"alertType" : "1",
"alertCode" : "1000000",
"description" : "Problem executing custom policy.",
"generatedAt" : "2015-05-01T16:21:18",
"source" : {
"sourceType" : "1",
"source" : "uddi:f996a248-f061-11e4-924f-f8246128b60a",
"sourceName" : "General"
}
"transaction" : {
"OperationInvocation" : {
"operationName" : "op1",
"operationKey" : "uddi:f996a248-f061-11e4-924f-f8246128b61b",
"serviceName" : "Service1",
"serviceKey"uddi:f996a248-f061-11e4-924f-f8246128b60a",
"contractName" : "Anonymous Access",
"contractKey" : "uddi:f996a248-f061-11e4-924f-f8246128b53c",
"organizationKey" : "uddi:f996a248-f061-11e4-924f-f8246127d45a
}
}
}
Response:
HTTP/1.1 200 OK
{
"id" : "1010",
"alertType" : "1",
"alertCode" : "1000000",
"alertCodeInfo" : {
"severity" : "2",
"description" : "Policy enforcement failure",
"componentName" : "Policy Handler Framework",
"subsystemName" : "General",
"sendEmailEnabled" : "true",
"snmpTrapEnabled" : "false"
}
"description" : "Problem executing custom policy.",
"generatedAt" : "2015-05-01T16:21:18"
"source" : {
"sourceType" : "1",
"source" : "uddi:f996a248-f061-11e4-924f-f8246128b60a",
"sourceName" : "General\
}
"transaction" : {
"OperationInvocation" : {
"operationName" : "op1",
"operationKey" : "uddi:f996a248-f061-11e4-924f-f8246128b61b",
"serviceName" : "Service1",
"serviceKey"uddi:f996a248-f061-11e4-924f-f8246128b60a",
"contractName" : "Anonymous Access",
"contractKey" : "uddi:f996a248-f061-11e4-924f-f8246128b53c",
"organizationKey" : "uddi:f996a248-f061-11e4-924f-f8246127d45a
}
}
"workflow" : {
"state" : "UNOBSERVED
"receivedAt" : "2015-05-01T16:21:18",
}
"alertDispatchStatus" : {
"dispatched" : "false"
}
}
Note the id property is not provided in the request but is provided in the response message. The id can then be used when performing workflow actions. Additional information about the alert derived from the alert code specified is added by the system. Of note the severity of the alert is dictated by the alert code. The severity is a numeric value and may be one of the following:
- CRITICAL
- MAJOR
- MINOR
- NORMAL
- CLEAR
The workflow is also auto-generated and provided in the response where it indicates the initial state and when the system received the record. And finally a dispatch status may be added if the alert code requires any sort of dispatch.
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
body
entity
The alert to add.
alert
alert {
AlerstDispatchStatus {
EmailStatus {
SnmpStatus {
CommandStatus {
alertWorkflow {
alertComment {
alertCodeInfo {
alertSlaInfo {
alertSource {
alertTransaction {
alertDispatchStatus( AlerstDispatchStatus )
alertType( int, required )
alertCode( int, required )
workflow( alertWorkflow )
alertCodeInfo( alertCodeInfo )
generatedAt( dateTime )
containerKey( string )
description( string )
alertSlaInfo( alertSlaInfo )
id( string )
source( alertSource )
transaction( alertTransaction )
}
AlerstDispatchStatus {
emailStatus( EmailStatus )
snmpStatus( SnmpStatus )
dispatched( boolean, required )
commandStatus( CommandStatus )
}
EmailStatus {
executionDate( dateTime )
executed( boolean, required )
}
SnmpStatus {
executionDate( dateTime )
executed( boolean, required )
}
CommandStatus {
executionDate( dateTime )
executed( boolean, required )
}
alertWorkflow {
observedBy( string )
resolvedAt( dateTime )
observedAt( dateTime )
Comments( Collection of alertComment )
resolvedBy( string )
state( AlertState )
receivedAt( dateTime )
}
alertComment {
createdDts( dateTime )
commentId( long, required )
comment( string )
userName( string )
}
alertCodeInfo {
severity( int, required )
additionalInfo( string )
description( string )
componentName( string )
ScriptCommand( string )
subsystemName( string )
sendEmailEnabled( boolean, required )
snmpTrapEnabled( boolean, required )
}
alertSlaInfo {
ruleValueInterval( string )
policyKey( string )
ruleOperator( string )
policyName( string )
ruleMetricName( string )
ruleKey( string )
ruleValue( long, required )
ruleValueUnit( string )
startTime( dateTime )
endTime( dateTime )
attachmentPointType( string )
attachmentPointKey( string )
measuredValue( double, required )
}
alertSource {
sourceType( int, required )
source( string )
sourceName( string )
}
alertTransaction {
any( anyType )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
alert
alert {
AlerstDispatchStatus {
EmailStatus {
SnmpStatus {
CommandStatus {
alertWorkflow {
alertComment {
alertCodeInfo {
alertSlaInfo {
alertSource {
alertTransaction {
alertDispatchStatus( AlerstDispatchStatus )
alertType( int )
alertCode( int )
workflow( alertWorkflow )
alertCodeInfo( alertCodeInfo )
generatedAt( dateTime )
containerKey( string )
description( string )
alertSlaInfo( alertSlaInfo )
id( string )
source( alertSource )
transaction( alertTransaction )
}
AlerstDispatchStatus {
emailStatus( EmailStatus )
snmpStatus( SnmpStatus )
dispatched( boolean )
commandStatus( CommandStatus )
}
EmailStatus {
executionDate( dateTime )
executed( boolean )
}
SnmpStatus {
executionDate( dateTime )
executed( boolean )
}
CommandStatus {
executionDate( dateTime )
executed( boolean )
}
alertWorkflow {
observedBy( string )
resolvedAt( dateTime )
observedAt( dateTime )
Comments( Collection of alertComment )
resolvedBy( string )
state( AlertState )
receivedAt( dateTime )
}
alertComment {
createdDts( dateTime )
commentId( long )
comment( string )
userName( string )
}
alertCodeInfo {
severity( int )
additionalInfo( string )
description( string )
componentName( string )
ScriptCommand( string )
subsystemName( string )
sendEmailEnabled( boolean )
snmpTrapEnabled( boolean )
}
alertSlaInfo {
ruleValueInterval( string )
policyKey( string )
ruleOperator( string )
policyName( string )
ruleMetricName( string )
ruleKey( string )
ruleValue( long )
ruleValueUnit( string )
startTime( dateTime )
endTime( dateTime )
attachmentPointType( string )
attachmentPointKey( string )
measuredValue( double )
}
alertSource {
sourceType( int )
source( string )
sourceName( string )
}
alertTransaction {
any( anyType )
}
GET/alertsGet Alerts
Retrieves the alerts meeting the given criteria. The following usage example illustrates a query for all UNOBSERVED alerts reported against service with the key uddi:f996a248-f061-11e4-924f-f8246128b60a with a severity of MAJOR or CRITICAL that were generated between 2015-05-01T16:21:17 and now. It also illustrates paging by asking for records starting from position 50 and to only return 50 records.
Request:
GET /rest/alerts?state=UNOBSERVED&source=uddi:f996a248-f061-11e4-924f-f8246128b60a&severity=1&severity=2&from=2015-05-01T16:21:17&start=50&count=50 HTTP/1.1
Response:
HTTP/1.1 200 OK
{
"totalCount" : "50",
"records" : [
{
"id" : "1010",
"alertType" : "1",
"alertCode" : "1000000",
"alertCodeInfo" : {
"severity" : "2",
"description" : "Policy enforcement failure",
"componentName" : "Policy Handler Framework",
"subsystemName" : "General",
"sendEmailEnabled" : "true",
"snmpTrapEnabled" : "false"
}
"description" : "Problem executing custom policy.",
"generatedAt" : "2015-05-01T16:21:18"
"source" : {
"sourceType" : "1",
"source" : "uddi:f996a248-f061-11e4-924f-f8246128b60a",
"sourceName" : "General\
}
"transaction" : {
"OperationInvocation" : {
"operationName" : "op1",
"operationKey" : "uddi:f996a248-f061-11e4-924f-f8246128b61b",
"serviceName" : "Service1",
"serviceKey"uddi:f996a248-f061-11e4-924f-f8246128b60a",
"contractName" : "Anonymous Access",
"contractKey" : "uddi:f996a248-f061-11e4-924f-f8246128b53c",
"organizationKey" : "uddi:f996a248-f061-11e4-924f-f8246127d45a
}
}
"workflow" : {
"state" : "UNOBSERVED
"receivedAt" : "2015-05-01T16:21:18",
}
"alertDispatchStatus" : {
"dispatched" : "false"
}
},
... not shown for brevity ...
],
"listIncomplete" : "true"
}
The listIncomplete field in the response indicates there are more records beyond the 50 that match the given criteria.
Parameters
Name
Type
Description
Model
code
query
Alert code to filter on.
string
source
query
Source of the alerts to filter on.
string
org
query
Organization key to filter on.
string
from
query
Date at which only alerts generated after will be returned. ISO-8601 format
string
to
query
Date at which only alerts generated before will be returned. ISO-8601 format
string
severity
query
Severities of the alerts to filter on.
string
state
query
States of the alerts to filter on.
string
actor
query
Indicates only alerts that the user with the given username performed a workflow action on should be returned.
string
start
query
To page the results this integer indicates the first alert from the full result set to return as the first item of the page.
integer
count
query
To page the results this integer indicates the number of items thatshould be returned in the page.
integer
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
alertList
alertList {
alert {
AlerstDispatchStatus {
EmailStatus {
SnmpStatus {
CommandStatus {
alertWorkflow {
alertComment {
alertCodeInfo {
alertSlaInfo {
alertSource {
alertTransaction {
listIncomplete( boolean )
Alerts( Collection of alert )
totalCount( int )
}
alert {
alertDispatchStatus( AlerstDispatchStatus )
alertType( int )
alertCode( int )
workflow( alertWorkflow )
alertCodeInfo( alertCodeInfo )
generatedAt( dateTime )
containerKey( string )
description( string )
alertSlaInfo( alertSlaInfo )
id( string )
source( alertSource )
transaction( alertTransaction )
}
AlerstDispatchStatus {
emailStatus( EmailStatus )
snmpStatus( SnmpStatus )
dispatched( boolean )
commandStatus( CommandStatus )
}
EmailStatus {
executionDate( dateTime )
executed( boolean )
}
SnmpStatus {
executionDate( dateTime )
executed( boolean )
}
CommandStatus {
executionDate( dateTime )
executed( boolean )
}
alertWorkflow {
observedBy( string )
resolvedAt( dateTime )
observedAt( dateTime )
Comments( Collection of alertComment )
resolvedBy( string )
state( AlertState )
receivedAt( dateTime )
}
alertComment {
createdDts( dateTime )
commentId( long )
comment( string )
userName( string )
}
alertCodeInfo {
severity( int )
additionalInfo( string )
description( string )
componentName( string )
ScriptCommand( string )
subsystemName( string )
sendEmailEnabled( boolean )
snmpTrapEnabled( boolean )
}
alertSlaInfo {
ruleValueInterval( string )
policyKey( string )
ruleOperator( string )
policyName( string )
ruleMetricName( string )
ruleKey( string )
ruleValue( long )
ruleValueUnit( string )
startTime( dateTime )
endTime( dateTime )
attachmentPointType( string )
attachmentPointKey( string )
measuredValue( double )
}
alertSource {
sourceType( int )
source( string )
sourceName( string )
}
alertTransaction {
any( anyType )
}
DELETE/alerts/{id}Delete Alert
Parameters
Name
Type
Description
Model
id
path
ID of the alert to delete.
string
GET/alertcodes/{code}Get Alert Code Details
Parameters
Name
Type
Description
Model
code
path
Alert code.
integer
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
alertCode
alertCode {
severity( int )
userAlert( boolean )
alertCode( int )
logAlert( boolean )
description( string )
commandId( int )
sendEmail( boolean )
additionalInfo( string )
scriptName( string )
componentName( string )
subsystemName( string )
EmailDests( Collection of int )
sendSNMPTrap( boolean )
}
PUT/alerts/{id}/workflowPerform Workflow Action
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
id
path
ID of the alert to perform the action on.
string
body
entity
The action to perform.
alertWorkflowAction
alertWorkflowAction {
action( action )
comment( string )
userName( string )
}
POST/alerts/{id}/commentsAdd Comment
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
id
path
ID of the alert to comment on.
string
body
entity
Comment being made. Includes the text of the commentas well as the user who made the comment and when it was made.
alertComment
alertComment {
createdDts( dateTime )
commentId( long, required )
comment( string )
userName( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
alertComment
alertComment {
createdDts( dateTime )
commentId( long )
comment( string )
userName( string )
}