1. REST API for Unified Assurance Core
  2. Tasks
  3. Diagrams
  4. Widgets

Get Event Widget Status

post

/api/diagram/Widgets/readEventStatus

Gets the event severity status for the list of diagram widgets. For each widget listed in the request body, this API makes a GET request to the /api/event/Events endpoint to get the status.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Widgets
Type: array
List of event widgets with event parameters.
Show Source
Example:
[
    {
        "WidgetID":"Widget_1-497",
        "FilterType":"FilterID",
        "DeviceName":null,
        "DisplayName":"Default",
        "FilterGroupName":"//Global",
        "FilterValueName":"All Events",
        "DeviceZoneName":null,
        "DeviceZoneID":null,
        "AllZonesRecord":null
    },
    {
        "WidgetID":"Widget_2-497",
        "FilterType":"TEL",
        "DeviceName":null,
        "DisplayName":"Default",
        "FilterGroupName":"",
        "FilterValueName":"Severity=3 AND EventType='Ping Jitter Utilization High' AND Node like 'qa2%'",
        "DeviceZoneName":null,
        "DeviceZoneID":null,
        "AllZonesRecord":null
    }
]
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulAddOperation
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The status of the event widget.
Show Source
Example:
[
    {
        "WidgetID":"Widget_1-497",
        "SeverityCounts":[
            7,
            1,
            1,
            1620,
            807,
            164
        ],
        "Count":2600,
        "SumOfCount":122761923
    },
    {
        "WidgetID":"Widget_2-497",
        "SeverityCounts":[
            0,
            0,
            0,
            5,
            0,
            0
        ],
        "Count":5,
        "SumOfCount":8621
    }
]
Nested Schema : items
Type: object
Show Source
  • The number of unique events (ie Rows).
    Example: 2600
  • SeverityCounts
    The array of event severity counts in the order from Normal to Critical. The order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.
  • The sum of count is the total count, SUM(Count),of all events. Each event can be deduplicated and the count for each one can be more than 1. Sum includes everything. For example, for a device with 2 events, the first with a count of 1 and the second with a count of 9; the Count is 2, and the SumOfCount is 10.
    Example: 122761923
  • The unique widget ID within the diagram.
    Example: Widget_1-497
Nested Schema : SeverityCounts
Type: array
The array of event severity counts in the order from Normal to Critical. The order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.
Show Source
Example:
[
    7,
    1,
    1,
    1620,
    807,
    164
]

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
Back to Top