Represents a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence); it could be a syslog, SNMP trap, or any other such type. The term "normalized" denotes a single format abstracted over all types of reported events, regardless of source and structure.
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/Events
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Response Parameters
category
EventAlarmCategoryEnum
|
Specifies the major category for the Alarm/Event.
Categories are major functionality areas for events. For example, the wireless network management application categorizes events by the type of network element or entity that can emit them (access point, wireless LAN controller, port). A different application can introduce a different set of categories.
Binding the list of categories for a particular implementation is represented as a "Lookup" datatype for the values (as opposed to an immutable enumeration type).
|
condition
EventTypeEnum
|
Specifies a type of occurrence/event within a category.
Different applications can introduce different sets of types. Binding the list of types for a particular implementation is represented as a "Lookup" enumeration datatype for the values (as opposed to an immutable enumeration type).
|
correlated
Long
|
The alarm ID correlated for this event.
|
description
String
|
Contains the Event/Alarm description as free text.
|
deviceName
String
|
Represents the entity for which the event is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this event occured.
|
eventFoundAt
Date
|
Reflects the time when the Event was found.
|
eventId
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
source
String
|
Represents the entity for which the event/alarm is reported. This is not necessarily the reporting entity; in many cases, the notification is sent by an entity reporting an occurrence on another entity.
Note that this is an opaque reference type that MIGHT be a reference to a known entity (that is, an instance in the model), but it might also be a reference to an entity that is not represented in the system.
|
timeStamp
Date
|
Specifies the time the event occurred. If this time is not available (because the raw notification did not carry this information), the timestamp specifies the time this record was created.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v1/data/Events/15
<?xml version="1.0" ?>
<queryResponse type="Events" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Events/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="eventsDTO" type="Events" url="https://localhost/webacs/api/v1/data/Events/15">
<eventsDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<correlated>15</correlated>
<description>String value</description>
<deviceName>String value</deviceName>
<deviceTimestamp>2018-12-21T12:09:25.802+07:00</deviceTimestamp>
<eventFoundAt>2018-12-21T12:09:25.803+07:00</eventFoundAt>
<eventId>2</eventId>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2018-12-21T12:09:25.803+07:00</timeStamp>
</eventsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/Events/15.json
{
"queryResponse" : {
"@type" : "Events",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Events\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "eventsDTO",
"@type" : "Events",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Events\/15",
"eventsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"correlated" : 15,
"description" : "String value",
"deviceName" : "String value",
"deviceTimestamp" : "2018-12-21T12 : 09 : 25.802+07 : 00",
"eventFoundAt" : "2018-12-21T12 : 09 : 25.803+07 : 00",
"eventId" : 2,
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : "2018-12-21T12 : 09 : 25.803+07 : 00"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/Events
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
category
EventAlarmCategoryEnum
|
Specifies the major category for the Alarm/Event.
Categories are major functionality areas for events. For example, the wireless network management application categorizes events by the type of network element or entity that can emit them (access point, wireless LAN controller, port). A different application can introduce a different set of categories.
Binding the list of categories for a particular implementation is represented as a "Lookup" datatype for the values (as opposed to an immutable enumeration type).
|
condition
EventTypeEnum
|
Specifies a type of occurrence/event within a category.
Different applications can introduce different sets of types. Binding the list of types for a particular implementation is represented as a "Lookup" enumeration datatype for the values (as opposed to an immutable enumeration type).
|
correlated
Long
|
The alarm ID correlated for this event.
|
description
String
|
Contains the Event/Alarm description as free text.
|
deviceName
String
|
Represents the entity for which the event is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this event occured.
|
eventFoundAt
Date
|
Reflects the time when the Event was found.
|
eventId
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
source
String
|
Represents the entity for which the event/alarm is reported. This is not necessarily the reporting entity; in many cases, the notification is sent by an entity reporting an occurrence on another entity.
Note that this is an opaque reference type that MIGHT be a reference to a known entity (that is, an instance in the model), but it might also be a reference to an entity that is not represented in the system.
|
timeStamp
Date
|
Specifies the time the event occurred. If this time is not available (because the raw notification did not carry this information), the timestamp specifies the time this record was created.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v2/data/Events/15
<?xml version="1.0" ?>
<queryResponse type="Events" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/Events/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="eventsDTO" type="Events" url="https://localhost/webacs/api/v2/data/Events/15">
<eventsDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<correlated>15</correlated>
<description>String value</description>
<deviceName>String value</deviceName>
<deviceTimestamp>2018-12-21T12:09:25.814+07:00</deviceTimestamp>
<eventFoundAt>2018-12-21T12:09:25.814+07:00</eventFoundAt>
<eventId>2</eventId>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2018-12-21T12:09:25.814+07:00</timeStamp>
</eventsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/Events/15.json
{
"queryResponse" : {
"@type" : "Events",
"@requestUrl" : "https://localhost/webacs/api/v2/data/Events/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "eventsDTO",
"@type" : "Events",
"@url" : "https://localhost/webacs/api/v2/data/Events/15",
"eventsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"correlated" : 15,
"description" : "String value",
"deviceName" : "String value",
"deviceTimestamp" : 1545368965814,
"eventFoundAt" : 1545368965814,
"eventId" : 2,
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : 1545368965814
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/Events
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
category
EventAlarmCategoryEnum
|
Specifies the major category for the Alarm/Event.
Categories are major functionality areas for events. For example, the wireless network management application categorizes events by the type of network element or entity that can emit them (access point, wireless LAN controller, port). A different application can introduce a different set of categories.
Binding the list of categories for a particular implementation is represented as a "Lookup" datatype for the values (as opposed to an immutable enumeration type).
|
condition
EventTypeEnum
|
Specifies a type of occurrence/event within a category.
Different applications can introduce different sets of types. Binding the list of types for a particular implementation is represented as a "Lookup" enumeration datatype for the values (as opposed to an immutable enumeration type).
|
correlated
Long
|
The alarm ID correlated for this event.
|
description
String
|
Contains the Event/Alarm description as free text.
|
deviceName
String
|
Represents the entity for which the event is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this event occured.
|
eventFoundAt
Date
|
Reflects the time when the Event was found.
|
eventId
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
source
String
|
Represents the entity for which the event/alarm is reported. This is not necessarily the reporting entity; in many cases, the notification is sent by an entity reporting an occurrence on another entity.
Note that this is an opaque reference type that MIGHT be a reference to a known entity (that is, an instance in the model), but it might also be a reference to an entity that is not represented in the system.
|
timeStamp
Date
|
Specifies the time the event occurred. If this time is not available (because the raw notification did not carry this information), the timestamp specifies the time this record was created.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v3/data/Events/15
<?xml version="1.0" ?>
<queryResponse type="Events" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/Events/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="eventsDTO" type="Events" url="https://localhost/webacs/api/v3/data/Events/15">
<eventsDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<correlated>15</correlated>
<description>String value</description>
<deviceName>String value</deviceName>
<deviceTimestamp>2018-12-21T12:09:25.826+07:00</deviceTimestamp>
<eventFoundAt>2018-12-21T12:09:25.826+07:00</eventFoundAt>
<eventId>2</eventId>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2018-12-21T12:09:25.826+07:00</timeStamp>
</eventsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/Events/15.json
{
"queryResponse" : {
"@type" : "Events",
"@requestUrl" : "https://localhost/webacs/api/v3/data/Events/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "eventsDTO",
"@type" : "Events",
"@url" : "https://localhost/webacs/api/v3/data/Events/15",
"eventsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"correlated" : 15,
"description" : "String value",
"deviceName" : "String value",
"deviceTimestamp" : "2018-12-21T05:09:25.826Z",
"eventFoundAt" : "2018-12-21T05:09:25.826Z",
"eventId" : 2,
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : "2018-12-21T05:09:25.826Z"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/Events
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
category
EventAlarmCategoryEnum
|
Specifies the major category for the Alarm/Event.
Categories are major functionality areas for events. For example, the wireless network management application categorizes events by the type of network element or entity that can emit them (access point, wireless LAN controller, port). A different application can introduce a different set of categories.
Binding the list of categories for a particular implementation is represented as a "Lookup" datatype for the values (as opposed to an immutable enumeration type).
|
condition
EventTypeEnum
|
Specifies a type of occurrence/event within a category.
Different applications can introduce different sets of types. Binding the list of types for a particular implementation is represented as a "Lookup" enumeration datatype for the values (as opposed to an immutable enumeration type).
|
correlated
Long
|
The alarm ID correlated for this event.
|
description
String
|
Contains the Event/Alarm description as free text.
|
deviceName
String
|
Represents the entity for which the event is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this event occured.
|
eventFoundAt
Date
|
Reflects the time when the Event was found.
|
eventId
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
source
String
|
Represents the entity for which the event/alarm is reported. This is not necessarily the reporting entity; in many cases, the notification is sent by an entity reporting an occurrence on another entity.
Note that this is an opaque reference type that MIGHT be a reference to a known entity (that is, an instance in the model), but it might also be a reference to an entity that is not represented in the system.
|
timeStamp
Date
|
Specifies the time the event occurred. If this time is not available (because the raw notification did not carry this information), the timestamp specifies the time this record was created.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v4/data/Events/15
<?xml version="1.0" ?>
<queryResponse type="Events" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/Events/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="eventsDTO" type="Events" url="https://localhost/webacs/api/v4/data/Events/15">
<eventsDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<correlated>15</correlated>
<description>String value</description>
<deviceName>String value</deviceName>
<deviceTimestamp>2018-12-21T12:09:25.834+07:00</deviceTimestamp>
<eventFoundAt>2018-12-21T12:09:25.834+07:00</eventFoundAt>
<eventId>2</eventId>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2018-12-21T12:09:25.834+07:00</timeStamp>
</eventsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/Events/15.json
{
"queryResponse" : {
"@type" : "Events",
"@requestUrl" : "https://localhost/webacs/api/v4/data/Events/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "eventsDTO",
"@type" : "Events",
"@url" : "https://localhost/webacs/api/v4/data/Events/15",
"eventsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"correlated" : 15,
"description" : "String value",
"deviceName" : "String value",
"deviceTimestamp" : "2018-12-21T05:09:25.834Z",
"eventFoundAt" : "2018-12-21T05:09:25.834Z",
"eventId" : 2,
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : "2018-12-21T05:09:25.834Z"
}
} ]
}
}