Get Meta Events
get
/api/event/MetaEvents/
Gets the meta-events that match the specified parameters. If no parameters are specified, all meta-events are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of meta-events that match the specified parameters.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The list of meta-events that match the specified parameters.
Show Source
Nested Schema : eventMetaEventsRead
Type:
Show Source
object
-
Ack: integer
Indicates if the event has been flagged as acknowledged. Events will be displayed differently based on Ack. - 0 -> N0 - 1 -> YesExample:
0
-
Action: string
Action is an indication for a non-human entity that caused a change to be made.Example:
$ACTION
-
Actor: string
Actor is an indication of the entity that caused the change to be made.Example:
$ACTOR
-
Count: integer
The number of times this Event has happened (deduplicated)Example:
1
-
Department: string
Customer.rules will set this to Unknown if not previously set.Example:
-
Description: string
Description of Meta EventExample:
Default Service Event
-
Details: string
Details of the event (a JSON text)Example:
{}
-
DeviceType: string
Device Type is used as a general category for the event. Customer.rules will set this to Unknown if not previously set.Example:
Service
-
DstIP: string
Example:
-
DstPort: string
Example:
-
EscalationFlag: integer
If an event should be escalated or not. ??? 0 = no ??? 1 = should be escalated ??? 2 = has been escalatedExample:
-
EscId: integer
Example:
-
EventCategory: string
Event Category - 1 -> Resolution - 2 -> Problem - 3 -> DiscreteExample:
$STATE
-
EventKey: string
Event KeyExample:
Service_$SERVICENAME
-
EventType: string
Event type.Example:
Event SLM
-
ExpireTime: integer
Time at which the event expired (Number of seconds after LastChanged for this Event to become eligible-to-be-deleted, which is done by the mechanization DeleteExpired)Example:
3600
-
FirstReported: string
Timestamp when event was first reportedExample:
$TIMESTAMP
-
IPAddress: string
Example:
$IPADDRESS
-
LastChanged: string
Timestamp when event was last changedExample:
$TIMESTAMP
-
LastReported: string
Timestamp when event was last reportedExample:
$TIMESTAMP
-
Location: string
Name, Address, or something similar associated with the Event. Event Analytics will use this if it is set.Example:
-
MetaEventID: integer
Meta Event ID specified for individual CRUD operations for Assure1.EventMetaEventsExample:
1
-
MetaEventName: string
Meta Event NameExample:
Default Service Event
-
Method: string
Protocol of how the event was received/retrieved. The binary will set a default value (Trapd, Syslogd, for example), but can be update in rules, if needed.Example:
EventSLM
-
Node: string
The name of the device where the event happened (usually the DNS name of the device associated with the event)Example:
$SERVICENAME
-
OrigSeverity: string
The original severity when the event was first created.Example:
$SEVERITY
-
Score: string
If a Priority value is set on a device, this field can be set to the event Severity * Priority to increase the number. Event Filters can be configured to show the hi-score Events first, or other processing may utilize this value.Example:
-
Service: string
The SLM applications will set this to the name of the SLM Service if a violation is detected.Example:
$SERVICENAME
-
ServiceImpact: string
Flag to indicate a provided service has been impacted. Allowed values: - 0 = Not service impacting - 1 = Service impactingExample:
$SERVICEIMPACT
-
Severity: string
Must be a value between 0 - 5. The event will change colors in the Event List based on the severity. Allowed Values: - 0 => Normal - 1 => Unknown - 2 => Info - 3 => Minor - 4 => Major - 5 => CriticalExample:
$SEVERITY
-
SrcIP: string
Example:
-
SrcPort: string
Example:
-
SubDeviceType: string
Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.Example:
Event Service
-
SubMethod: string
Usually set in rules to the specific processing that was done on the event, for example, the MIB that defines the trap, or the string "watchdog", or "Unknown".Example:
$SERVICENAME
-
SubNode: string
The Instance of the Event, for example, the ifIndex value of a linkUp trap. Mechanization CorrelateProblemResolutions requires that this is the same for correlating eventsExample:
$SERVICEID
-
Summary: string
Event description summary.Example:
Service $STATE_TEXT ($VALUE $OPERATOR $THRESHOLD)
-
TicketFlag: string
A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = openedExample:
-
TicketID: integer
The Ticket ID associated with this Event in the external system. Should be populated by the process done to open the ticket in the external system.Example:
-
ZoneID: integer
Can be set to the Device Zone that the device is in.Example:
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object