REST API for Unified Assurance Core

Get Events

get

/api/event/Events

Gets the events that match the specified parameters. If no parameters are specified, all events are returned.

Request

Query Parameters

DateFrom: string

The beginning of the date range in the format yyyy-mm-dd.
DateTo: string

The end of the date range in the format yyyy-mm-dd.
DisableConversions: boolean

Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.
DisplayID: integer
The ID of the display used to determine the columns selected.
Example:
```
1
```
FilterGroupID: integer

The filter group of the filter. This parameter is required when FilterType is set to FilterId or MetaTag, otherwise it is optional.
FilterType: string
The type of filter. Possible values are:
- FilterID
- DeviceName
- MetaTag
- TEL
The default value is TEL (Transient Event List).
FilterValue: string

The value of the filter. You can use a filter ID, a device name, metadata with the MetaType FilterGroupID, or an SQL where clause.
QuerySort: string

This parameter indicates the way the event field values are sorted. The allowed values are frequency and alphanumeric values.
ReadSeveritiesOnly: integer

Read severities only and prevent returning events. The default value is 0.
ShardID: integer
The shard ID to query. Default value is 1.
Example:
```
1
```

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

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

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

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
The page of results to start from.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of events that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventEventsReadData"
                    }
                },
                "metaData":{
                    "description":"The metadata associated with the method.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventEventsReadMetaData"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The list of events that match the specified parameters.
metaData: array metaData

The metadata associated with the method.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of events that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventEventsReadData"
            }
        },
        "metaData":{
            "description":"The metadata associated with the method.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventEventsReadMetaData"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of events that match the specified parameters.

Show Source

Array of: object eventEventsReadData

{
    "description":"The list of events that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventEventsReadData"
    }
}

Nested Schema : metaData

Type: array

The metadata associated with the method.

Show Source

Array of: object eventEventsReadMetaData

{
    "description":"The metadata associated with the method.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventEventsReadMetaData"
    }
}

Nested Schema : eventEventsReadData

Type: object

Show Source

Ack: integer

Whether the event has been acknowledged (1) or not (0). Events will be displayed differently based on whether or not they have been acknowledged.

Example: 1
Action: string

The non-human entity that caused a change to be made.

Example: SQL Tool: Acknowledge
Actor: string

The entity or user that caused the change to be made.

Example: admin
Count: integer

The number of times this event has happened (deduplicated).

Example: 1963
Customer: string

Customer can be set to a value when needed.

Example:
Department: string

Customer.rules will set this to Unknown if not previously set.

Example: Unknown
Details: string

Details of the event in JSON format.

Example: {"ThresholdName":"Device Down","Time":"1667230800","InstanceName":"Device","ThresholdTimeRange":900,"ThresholdTypeName":"StandardThreshold","ThresholdSeverity":5,"MetricValue":0,"ThresholdOperator":"==","DeviceName":"router.example.com","ThresholdType":"1","ThresholdMessage":"Performance threshold violation: Device Down","Measurement":"metrictype_Latency","ThresholdValue":"0"}
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: Unknown
Duration: number

Duration for which the event occurred (LastReported - FirstReported)

Example: 24417000.000
EscalationFlag: integer
Whether the event should or has been escalated. Can be:
- 0: Should not be escalated.
- 1: Should be escalated.
- 2: Has been escalated.
Example: 0
EventCategory: string
The event category. Allowed values are:
- Resolution
- Problem
- Discrete

Example: Problem

EventID: integer

The event ID specified for individual read operations.

Example: 57341

EventKey: string

The event key.

Example: Standard Threshold-router1.example.com-Device Down-Device

EventType: string

The type of event. For example, linkUpDown for a linkDown trap.

Example: Device Down

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: 0

FirstReported: string

The timestamp when the event was first reported.

Example: 2022-10-31 10:40:00.000

GeoLocation: string

An object containing a longitude and latitude denoting a geographic location related to the event.

Example: {"type": "Point", "coordinates": [0.0, 0.0]}

GeoPath: string

An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.

Example: {"type": "LineString", "coordinates": [[0.0, 0.0], [0.0, 0.0]]}

IPAddress: string

The IPv4 or IPv6 address of the Device associated with this Event

Example: 100.77.1.4

LastChanged: string

The timestamp when the event was last changed.

Example: 2023-08-10 01:10:00.000

LastReported: string

The timestamp when the event was last reported.

Example: 2023-08-10 01:10:00.000

Location: string

Name, Address, or something similar associated with the Event. Event Analytics will use this if it is set.

Example:

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: StandardThresholdEngined

Node: string

The name of the device where the event happened. This is usually the DNS name of the device associated with the event.

Example: router1.example.com

OrigSeverity: integer

The original severity when the event was first created.

Example: 5

OwnerName: string

The name of the currently-responsible person. Some event Tools (for example, "Acknowledge", "Delete", and "Take Ownership") set this to the username that executed the tool; "UnAcknowledge" sets it to 0.

Example: admin

RootCauseFlag: integer

Used by applications to know whether the event is being processed as a root cause of another event or not.

Example: 0

RootCauseID: integer

Used by applications to know whether the event was caused by another event or not.

Example: 0

Score: integer

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: 0

Service: string

The SLM applications will set this to the name of the SLM Service if a violation is detected.

Example:

ServiceImpact: integer

Flag to indicate a provided service has been impacted. Allowed values:

0: Not service impacting
1: Service impacting

Example: 0

Severity: string

Must be a value between 0 and 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 => Critical

Example: Critical

ShardID: integer

The shard ID of the database to query. If no value is specified, the default is 1.

Example: 1

SubDeviceType: string

Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.

Example: Unknown

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: Standard Threshold

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 events

Example: Device

Summary: string

The event summary.

Example: Device Down with availability 0.00% == 0%

TicketFlag: integer

A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = opened

Example: 0

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: 5

{
    "type":"object",
    "properties":{
        "EventID":{
            "description":"The event ID specified for individual <b>read</b> operations.",
            "type":"integer",
            "example":"57341"
        },
        "ShardID":{
            "description":"The shard ID of the database to query. If no value is specified, the default is 1.",
            "type":"integer",
            "example":"1"
        },
        "Node":{
            "description":"The name of the device where the event happened. This is usually the DNS name of the device associated with the event.",
            "type":"string",
            "example":"router1.example.com"
        },
        "EventType":{
            "description":"The type of event. For example, <b>linkUpDown</b> for a linkDown trap.",
            "type":"string",
            "example":"Device Down"
        },
        "Summary":{
            "description":"The event summary.",
            "type":"string",
            "example":"Device Down  with availability 0.00% == 0%"
        },
        "Count":{
            "description":"The number of times this event has happened (deduplicated).",
            "type":"integer",
            "example":"1963"
        },
        "FirstReported":{
            "description":"The timestamp when the event was first reported.",
            "type":"string",
            "example":"2022-10-31 10:40:00.000"
        },
        "LastReported":{
            "description":"The timestamp when the event was last reported.",
            "type":"string",
            "example":"2023-08-10 01:10:00.000"
        },
        "LastChanged":{
            "description":"The timestamp when the event was last changed.",
            "type":"string",
            "example":"2023-08-10 01:10:00.000"
        },
        "EventKey":{
            "description":"The event key.",
            "type":"string",
            "example":"Standard Threshold-router1.example.com-Device Down-Device"
        },
        "EventCategory":{
            "description":"The event category.\nAllowed values are:\n<ul><li>Resolution</li>\n<li>Problem</li>\n<li>Discrete</li></li>",
            "type":"string",
            "example":"Problem"
        },
        "Ack":{
            "description":"Whether the event has been acknowledged (<b>1</b>) or not (<b>0</b>). Events will be displayed differently based on whether or not they have been acknowledged.",
            "type":"integer",
            "example":"1"
        },
        "Action":{
            "description":"The non-human entity that caused a change to be made.",
            "type":"string",
            "example":"SQL Tool: Acknowledge"
        },
        "Actor":{
            "description":"The entity or user that caused the change to be made.",
            "type":"string",
            "example":"admin"
        },
        "Customer":{
            "description":"Customer can be set to a value when needed.",
            "type":"string",
            "example":""
        },
        "Department":{
            "description":"Customer.rules will set this to Unknown if not previously set.",
            "type":"string",
            "example":"Unknown"
        },
        "Details":{
            "description":"Details of the event in JSON format.",
            "type":"string",
            "example":"{\"ThresholdName\":\"Device Down\",\"Time\":\"1667230800\",\"InstanceName\":\"Device\",\"ThresholdTimeRange\":900,\"ThresholdTypeName\":\"StandardThreshold\",\"ThresholdSeverity\":5,\"MetricValue\":0,\"ThresholdOperator\":\"==\",\"DeviceName\":\"router.example.com\",\"ThresholdType\":\"1\",\"ThresholdMessage\":\"Performance threshold violation: Device Down\",\"Measurement\":\"metrictype_Latency\",\"ThresholdValue\":\"0\"}"
        },
        "DeviceType":{
            "description":"Device Type is used as a general category for the event. Customer.rules will set this to Unknown if not previously set.",
            "type":"string",
            "example":"Unknown"
        },
        "Duration":{
            "description":"Duration for which the event occurred (LastReported - FirstReported)",
            "type":"number",
            "example":"24417000.000"
        },
        "EscalationFlag":{
            "description":"Whether the event should or has been escalated. Can be:\n<ul><li><b>0</b>: Should not be escalated.</li>\n<li><b>1</b>: Should be escalated.</li>\n<li><b>2</b>: Has been escalated.</li></ul>",
            "type":"integer",
            "example":"0"
        },
        "ExpireTime":{
            "description":"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)",
            "type":"integer",
            "example":"0"
        },
        "GeoPath":{
            "description":"An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.",
            "type":"string",
            "example":"{\"type\": \"LineString\", \"coordinates\": [[0.0, 0.0], [0.0, 0.0]]}"
        },
        "GeoLocation":{
            "description":"An object containing a longitude and latitude denoting a geographic location related to the event.",
            "type":"string",
            "example":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
        },
        "IPAddress":{
            "description":"The IPv4 or IPv6 address of the Device associated with this Event",
            "type":"string",
            "example":"100.77.1.4"
        },
        "Location":{
            "description":"Name, Address, or something similar associated with the Event. Event Analytics will use this if it is set.",
            "type":"string",
            "example":""
        },
        "Method":{
            "description":"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.",
            "type":"string",
            "example":"StandardThresholdEngined"
        },
        "OrigSeverity":{
            "description":"The original severity when the event was first created.",
            "type":"integer",
            "example":"5"
        },
        "OwnerName":{
            "description":"The name of the currently-responsible person. Some event Tools (for example, \"Acknowledge\", \"Delete\", and \"Take Ownership\") set this to the username that executed the tool; \"UnAcknowledge\" sets it to 0.",
            "type":"string",
            "example":"admin"
        },
        "RootCauseFlag":{
            "description":"Used by applications to know whether the event is being processed as a root cause of another event or not.",
            "type":"integer",
            "example":"0"
        },
        "RootCauseID":{
            "description":"Used by applications to know whether the event was caused by another event or not.",
            "type":"integer",
            "example":"0"
        },
        "Score":{
            "description":"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.",
            "type":"integer",
            "example":"0"
        },
        "Service":{
            "description":"The SLM applications will set this to the name of the SLM Service if a violation is detected.",
            "type":"string",
            "example":""
        },
        "ServiceImpact":{
            "description":"Flag to indicate a provided service has been impacted. \nAllowed values: \n<ul><li><b>0</b>: Not service impacting</li> \n<li><b>1</b>: Service impacting</li></ul>",
            "type":"integer",
            "example":"0"
        },
        "Severity":{
            "description":"Must be a value between 0 and 5. The event will change colors in the Event List based on the severity.\nAllowed Values:\n- 0 => Normal\n- 1 => Unknown\n- 2 => Info\n- 3 => Minor\n- 4 => Major\n- 5 => Critical",
            "type":"string",
            "example":"Critical"
        },
        "SubDeviceType":{
            "description":"Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.",
            "type":"string",
            "example":"Unknown"
        },
        "SubMethod":{
            "description":"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\".",
            "type":"string",
            "example":"Standard Threshold"
        },
        "SubNode":{
            "description":"The Instance of the Event, for example, the ifIndex value of a linkUp trap. Mechanization CorrelateProblemResolutions requires that this is the same for correlating events",
            "type":"string",
            "example":"Device"
        },
        "TicketFlag":{
            "description":"A flag for the ticket state of this event. \n- 0 = no ticket\n- 1 = ticket to be created\n- 2 = processing\n- 3 = opened",
            "type":"integer",
            "example":"0"
        },
        "TicketID":{
            "description":"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.",
            "type":"integer",
            "example":""
        },
        "ZoneID":{
            "description":"Can be set to the Device Zone that the device is in.",
            "type":"integer",
            "example":"5"
        }
    }
}

Nested Schema : eventEventsReadMetaData

Type: object

Show Source

columns: array columns

The columns for the events table.
fields: array fields

Fields within the data object (Events)
root: string

root

Example: data
severity: object severity

Object containing number of all type of severities

{
    "type":"object",
    "properties":{
        "root":{
            "description":"root",
            "type":"string",
            "example":"data"
        },
        "fields":{
            "description":"Fields within the data object (Events)",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":"[\n  \"EventID\",\n  \"ShardID\",\n  \"Node\",\n  \"EventType\",\n  \"Summary\",\n  \"Count\",\n  \"FirstReported\",\n  \"LastReported\",\n  \"LastChanged\",\n  \"EventKey\",\n  \"EventCategory\",\n  \"Ack\",\n  \"Action\",\n  \"Actor\",\n  \"Customer\",\n  \"Department\",\n  \"Details\",\n  \"DeviceType\",\n  \"Duration\",\n  \"EscalationFlag\",\n  \"ExpireTime\",\n  \"GeoPath\",\n  \"GeoLocation\",\n  \"IPAddress\",\n  \"Location\",\n  \"Method\",\n  \"OrigSeverity\",\n  \"OwnerName\",\n  \"RootCauseFlag\",\n  \"RootCauseID\",\n  \"Score\",\n  \"Service\",\n  \"ServiceImpact\",\n  \"Severity\",\n  \"SubDeviceType\",\n  \"SubMethod\",\n  \"SubNode\",\n  \"TicketFlag\",\n  \"TicketID\",\n  \"ZoneID\"\n]"
        },
        "columns":{
            "description":"The columns for the events table.",
            "type":"array",
            "items":{
                "type":"object"
            },
            "example":[
                {
                    "text":"<div class=\"fa fa-link\"></div>",
                    "tooltip":"Indicates correlated symptom events",
                    "dataIndex":"RootCauseFlag",
                    "align":"left",
                    "filter":false,
                    "sortable":false,
                    "hidden":false,
                    "menuDisabled":true,
                    "width":"34"
                },
                {
                    "header":"EventID",
                    "dataIndex":"EventID",
                    "align":"left",
                    "filter":"int",
                    "hidden":true,
                    "width":"100"
                },
                {
                    "header":"ShardID",
                    "dataIndex":"ShardID",
                    "align":"left",
                    "filter":"int",
                    "hidden":true,
                    "width":"60"
                },
                {
                    "header":"Device",
                    "dataIndex":"Node",
                    "align":"left",
                    "filter":"string",
                    "hidden":false,
                    "width":"300"
                },
                {
                    "header":"Event Type",
                    "dataIndex":"EventType",
                    "align":"left",
                    "filter":"string",
                    "hidden":false,
                    "width":"200"
                },
                {
                    "header":"Event Text",
                    "dataIndex":"Summary",
                    "align":"left",
                    "filter":"string",
                    "hidden":false,
                    "flex":"1",
                    "minWidth":"100"
                },
                {
                    "header":"Count",
                    "dataIndex":"Count",
                    "align":"center",
                    "filter":"int",
                    "hidden":false,
                    "width":"70"
                },
                {
                    "header":"First Occurred",
                    "dataIndex":"FirstReported",
                    "align":"center",
                    "filter":"datetime",
                    "hidden":false,
                    "width":"190"
                },
                {
                    "header":"Last Occurred",
                    "dataIndex":"LastReported",
                    "align":"center",
                    "filter":"datetime",
                    "hidden":false,
                    "width":"190"
                },
                {
                    "header":"Last Changed",
                    "dataIndex":"LastChanged",
                    "align":"center",
                    "filter":"datetime",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"EventKey",
                    "dataIndex":"EventKey",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"EventCategory",
                    "dataIndex":"EventCategory",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Ack",
                    "dataIndex":"Ack",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Action",
                    "dataIndex":"Action",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Actor",
                    "dataIndex":"Actor",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Customer",
                    "dataIndex":"Customer",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Department",
                    "dataIndex":"Department",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Details",
                    "dataIndex":"Details",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"DeviceType",
                    "dataIndex":"DeviceType",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Duration",
                    "dataIndex":"Duration",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"EscalationFlag",
                    "dataIndex":"EscalationFlag",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"ExpireTime",
                    "dataIndex":"ExpireTime",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"GeoPath",
                    "dataIndex":"GeoPath",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"GeoLocation",
                    "dataIndex":"GeoLocation",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"IPAddress",
                    "dataIndex":"IPAddress",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Location",
                    "dataIndex":"Location",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Method",
                    "dataIndex":"Method",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"OrigSeverity",
                    "dataIndex":"OrigSeverity",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"OwnerName",
                    "dataIndex":"OwnerName",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"RootCauseFlag",
                    "dataIndex":"RootCauseFlag",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"RootCauseID",
                    "dataIndex":"RootCauseID",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Score",
                    "dataIndex":"Score",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Service",
                    "dataIndex":"Service",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"ServiceImpact",
                    "dataIndex":"ServiceImpact",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"Severity",
                    "dataIndex":"Severity",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"SubDeviceType",
                    "dataIndex":"SubDeviceType",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"SubMethod",
                    "dataIndex":"SubMethod",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"SubNode",
                    "dataIndex":"SubNode",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"TicketFlag",
                    "dataIndex":"TicketFlag",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"TicketID",
                    "dataIndex":"TicketID",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                },
                {
                    "header":"ZoneID",
                    "dataIndex":"ZoneID",
                    "align":"left",
                    "filter":"string",
                    "hidden":true,
                    "width":"120"
                }
            ]
        },
        "severity":{
            "description":"Object containing number of all type of severities",
            "type":"object",
            "example":{
                "normal":"11",
                "unknown":"1",
                "info":"1",
                "minor":"1620",
                "major":"809",
                "critical":"165",
                "all":"2607",
                "sum":"130887185"
            }
        }
    }
}

Nested Schema : columns

Type: array

The columns for the events table.

Show Source

Array of: object items

{
    "description":"The columns for the events table.",
    "type":"array",
    "items":{
        "type":"object"
    },
    "example":[
        {
            "text":"<div class=\"fa fa-link\"></div>",
            "tooltip":"Indicates correlated symptom events",
            "dataIndex":"RootCauseFlag",
            "align":"left",
            "filter":false,
            "sortable":false,
            "hidden":false,
            "menuDisabled":true,
            "width":"34"
        },
        {
            "header":"EventID",
            "dataIndex":"EventID",
            "align":"left",
            "filter":"int",
            "hidden":true,
            "width":"100"
        },
        {
            "header":"ShardID",
            "dataIndex":"ShardID",
            "align":"left",
            "filter":"int",
            "hidden":true,
            "width":"60"
        },
        {
            "header":"Device",
            "dataIndex":"Node",
            "align":"left",
            "filter":"string",
            "hidden":false,
            "width":"300"
        },
        {
            "header":"Event Type",
            "dataIndex":"EventType",
            "align":"left",
            "filter":"string",
            "hidden":false,
            "width":"200"
        },
        {
            "header":"Event Text",
            "dataIndex":"Summary",
            "align":"left",
            "filter":"string",
            "hidden":false,
            "flex":"1",
            "minWidth":"100"
        },
        {
            "header":"Count",
            "dataIndex":"Count",
            "align":"center",
            "filter":"int",
            "hidden":false,
            "width":"70"
        },
        {
            "header":"First Occurred",
            "dataIndex":"FirstReported",
            "align":"center",
            "filter":"datetime",
            "hidden":false,
            "width":"190"
        },
        {
            "header":"Last Occurred",
            "dataIndex":"LastReported",
            "align":"center",
            "filter":"datetime",
            "hidden":false,
            "width":"190"
        },
        {
            "header":"Last Changed",
            "dataIndex":"LastChanged",
            "align":"center",
            "filter":"datetime",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"EventKey",
            "dataIndex":"EventKey",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"EventCategory",
            "dataIndex":"EventCategory",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Ack",
            "dataIndex":"Ack",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Action",
            "dataIndex":"Action",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Actor",
            "dataIndex":"Actor",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Customer",
            "dataIndex":"Customer",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Department",
            "dataIndex":"Department",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Details",
            "dataIndex":"Details",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"DeviceType",
            "dataIndex":"DeviceType",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Duration",
            "dataIndex":"Duration",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"EscalationFlag",
            "dataIndex":"EscalationFlag",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"ExpireTime",
            "dataIndex":"ExpireTime",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"GeoPath",
            "dataIndex":"GeoPath",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"GeoLocation",
            "dataIndex":"GeoLocation",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"IPAddress",
            "dataIndex":"IPAddress",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Location",
            "dataIndex":"Location",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Method",
            "dataIndex":"Method",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"OrigSeverity",
            "dataIndex":"OrigSeverity",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"OwnerName",
            "dataIndex":"OwnerName",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"RootCauseFlag",
            "dataIndex":"RootCauseFlag",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"RootCauseID",
            "dataIndex":"RootCauseID",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Score",
            "dataIndex":"Score",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Service",
            "dataIndex":"Service",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"ServiceImpact",
            "dataIndex":"ServiceImpact",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"Severity",
            "dataIndex":"Severity",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"SubDeviceType",
            "dataIndex":"SubDeviceType",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"SubMethod",
            "dataIndex":"SubMethod",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"SubNode",
            "dataIndex":"SubNode",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"TicketFlag",
            "dataIndex":"TicketFlag",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"TicketID",
            "dataIndex":"TicketID",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        },
        {
            "header":"ZoneID",
            "dataIndex":"ZoneID",
            "align":"left",
            "filter":"string",
            "hidden":true,
            "width":"120"
        }
    ]
}

Example:

[
    {
        "text":"<div class=\"fa fa-link\"></div>",
        "tooltip":"Indicates correlated symptom events",
        "dataIndex":"RootCauseFlag",
        "align":"left",
        "filter":false,
        "sortable":false,
        "hidden":false,
        "menuDisabled":true,
        "width":"34"
    },
    {
        "header":"EventID",
        "dataIndex":"EventID",
        "align":"left",
        "filter":"int",
        "hidden":true,
        "width":"100"
    },
    {
        "header":"ShardID",
        "dataIndex":"ShardID",
        "align":"left",
        "filter":"int",
        "hidden":true,
        "width":"60"
    },
    {
        "header":"Device",
        "dataIndex":"Node",
        "align":"left",
        "filter":"string",
        "hidden":false,
        "width":"300"
    },
    {
        "header":"Event Type",
        "dataIndex":"EventType",
        "align":"left",
        "filter":"string",
        "hidden":false,
        "width":"200"
    },
    {
        "header":"Event Text",
        "dataIndex":"Summary",
        "align":"left",
        "filter":"string",
        "hidden":false,
        "flex":"1",
        "minWidth":"100"
    },
    {
        "header":"Count",
        "dataIndex":"Count",
        "align":"center",
        "filter":"int",
        "hidden":false,
        "width":"70"
    },
    {
        "header":"First Occurred",
        "dataIndex":"FirstReported",
        "align":"center",
        "filter":"datetime",
        "hidden":false,
        "width":"190"
    },
    {
        "header":"Last Occurred",
        "dataIndex":"LastReported",
        "align":"center",
        "filter":"datetime",
        "hidden":false,
        "width":"190"
    },
    {
        "header":"Last Changed",
        "dataIndex":"LastChanged",
        "align":"center",
        "filter":"datetime",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"EventKey",
        "dataIndex":"EventKey",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"EventCategory",
        "dataIndex":"EventCategory",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Ack",
        "dataIndex":"Ack",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Action",
        "dataIndex":"Action",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Actor",
        "dataIndex":"Actor",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Customer",
        "dataIndex":"Customer",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Department",
        "dataIndex":"Department",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Details",
        "dataIndex":"Details",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"DeviceType",
        "dataIndex":"DeviceType",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Duration",
        "dataIndex":"Duration",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"EscalationFlag",
        "dataIndex":"EscalationFlag",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"ExpireTime",
        "dataIndex":"ExpireTime",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"GeoPath",
        "dataIndex":"GeoPath",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"GeoLocation",
        "dataIndex":"GeoLocation",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"IPAddress",
        "dataIndex":"IPAddress",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Location",
        "dataIndex":"Location",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Method",
        "dataIndex":"Method",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"OrigSeverity",
        "dataIndex":"OrigSeverity",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"OwnerName",
        "dataIndex":"OwnerName",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"RootCauseFlag",
        "dataIndex":"RootCauseFlag",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"RootCauseID",
        "dataIndex":"RootCauseID",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Score",
        "dataIndex":"Score",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Service",
        "dataIndex":"Service",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"ServiceImpact",
        "dataIndex":"ServiceImpact",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"Severity",
        "dataIndex":"Severity",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"SubDeviceType",
        "dataIndex":"SubDeviceType",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"SubMethod",
        "dataIndex":"SubMethod",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"SubNode",
        "dataIndex":"SubNode",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"TicketFlag",
        "dataIndex":"TicketFlag",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"TicketID",
        "dataIndex":"TicketID",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    },
    {
        "header":"ZoneID",
        "dataIndex":"ZoneID",
        "align":"left",
        "filter":"string",
        "hidden":true,
        "width":"120"
    }
]

Nested Schema : fields

Type: array

Fields within the data object (Events)

Show Source

Array of: string

{
    "description":"Fields within the data object (Events)",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":"[\n  \"EventID\",\n  \"ShardID\",\n  \"Node\",\n  \"EventType\",\n  \"Summary\",\n  \"Count\",\n  \"FirstReported\",\n  \"LastReported\",\n  \"LastChanged\",\n  \"EventKey\",\n  \"EventCategory\",\n  \"Ack\",\n  \"Action\",\n  \"Actor\",\n  \"Customer\",\n  \"Department\",\n  \"Details\",\n  \"DeviceType\",\n  \"Duration\",\n  \"EscalationFlag\",\n  \"ExpireTime\",\n  \"GeoPath\",\n  \"GeoLocation\",\n  \"IPAddress\",\n  \"Location\",\n  \"Method\",\n  \"OrigSeverity\",\n  \"OwnerName\",\n  \"RootCauseFlag\",\n  \"RootCauseID\",\n  \"Score\",\n  \"Service\",\n  \"ServiceImpact\",\n  \"Severity\",\n  \"SubDeviceType\",\n  \"SubMethod\",\n  \"SubNode\",\n  \"TicketFlag\",\n  \"TicketID\",\n  \"ZoneID\"\n]"
}

Example:

[
  "EventID",
  "ShardID",
  "Node",
  "EventType",
  "Summary",
  "Count",
  "FirstReported",
  "LastReported",
  "LastChanged",
  "EventKey",
  "EventCategory",
  "Ack",
  "Action",
  "Actor",
  "Customer",
  "Department",
  "Details",
  "DeviceType",
  "Duration",
  "EscalationFlag",
  "ExpireTime",
  "GeoPath",
  "GeoLocation",
  "IPAddress",
  "Location",
  "Method",
  "OrigSeverity",
  "OwnerName",
  "RootCauseFlag",
  "RootCauseID",
  "Score",
  "Service",
  "ServiceImpact",
  "Severity",
  "SubDeviceType",
  "SubMethod",
  "SubNode",
  "TicketFlag",
  "TicketID",
  "ZoneID"
]

Nested Schema : severity

Type: object

Object containing number of all type of severities

Example:

{
    "normal":"11",
    "unknown":"1",
    "info":"1",
    "minor":"1620",
    "major":"809",
    "critical":"165",
    "all":"2607",
    "sum":"130887185"
}

Nested Schema : items

Type: object

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.