Jump to

• Request
• Response

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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Widgets: array Widgets
  List of event widgets with event parameters.
• WidgetType: string
  Type of Widget

  Example: EventEllipse

{
    "type":"object",
    "properties":{
        "WidgetType":{
            "description":"Type of Widget",
            "type":"string",
            "example":"EventEllipse"
        },
        "Widgets":{
            "description":"List of event widgets with event parameters.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "WidgetID":{
                        "description":"The unique widget ID within the diagram.",
                        "type":"integer",
                        "example":"Widget_1-497"
                    },
                    "FilterType":{
                        "description":"The filter type.",
                        "type":"string",
                        "example":"FilterID"
                    },
                    "DeviceName":{
                        "description":"The name of an associated device name, if any.",
                        "type":"string",
                        "nullable":true,
                        "example":"Device1"
                    },
                    "DisplayName":{
                        "description":"The display name.",
                        "type":"string",
                        "example":"Default"
                    },
                    "FilterGroupName":{
                        "description":"The filter group name.",
                        "type":"string",
                        "example":"//Global"
                    },
                    "FilterValueName":{
                        "description":"The filter value name.",
                        "type":"string",
                        "example":"All Events"
                    },
                    "DeviceZoneName":{
                        "description":"The device zone name, if any.",
                        "type":"string",
                        "nullable":true,
                        "example":"Zone1"
                    },
                    "DeviceZoneID":{
                        "description":"The device zone ID, if any.",
                        "type":"integer",
                        "nullable":true,
                        "example":1
                    },
                    "AllZonesRecord":{
                        "description":"The record of all zones, if any.",
                        "type":"string",
                        "nullable":true,
                        "example":""
                    }
                }
            },
            "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 : Widgets

Type: array

List of event widgets with event parameters.

Show Source

• Array of: object items

{
    "description":"List of event widgets with event parameters.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "WidgetID":{
                "description":"The unique widget ID within the diagram.",
                "type":"integer",
                "example":"Widget_1-497"
            },
            "FilterType":{
                "description":"The filter type.",
                "type":"string",
                "example":"FilterID"
            },
            "DeviceName":{
                "description":"The name of an associated device name, if any.",
                "type":"string",
                "nullable":true,
                "example":"Device1"
            },
            "DisplayName":{
                "description":"The display name.",
                "type":"string",
                "example":"Default"
            },
            "FilterGroupName":{
                "description":"The filter group name.",
                "type":"string",
                "example":"//Global"
            },
            "FilterValueName":{
                "description":"The filter value name.",
                "type":"string",
                "example":"All Events"
            },
            "DeviceZoneName":{
                "description":"The device zone name, if any.",
                "type":"string",
                "nullable":true,
                "example":"Zone1"
            },
            "DeviceZoneID":{
                "description":"The device zone ID, if any.",
                "type":"integer",
                "nullable":true,
                "example":1
            },
            "AllZonesRecord":{
                "description":"The record of all zones, if any.",
                "type":"string",
                "nullable":true,
                "example":""
            }
        }
    },
    "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
        }
    ]
}

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

• AllZonesRecord: string
  The record of all zones, if any.

  Example:
• DeviceName: string
  The name of an associated device name, if any.

  Example: Device1
• DeviceZoneID: integer
  The device zone ID, if any.

  Example: 1
• DeviceZoneName: string
  The device zone name, if any.

  Example: Zone1
• DisplayName: string
  The display name.

  Example: Default
• FilterGroupName: string
  The filter group name.

  Example: //Global
• FilterType: string
  The filter type.

  Example: FilterID
• FilterValueName: string
  The filter value name.

  Example: All Events
• WidgetID: integer
  The unique widget ID within the diagram.

  Example: Widget_1-497

{
    "type":"object",
    "properties":{
        "WidgetID":{
            "description":"The unique widget ID within the diagram.",
            "type":"integer",
            "example":"Widget_1-497"
        },
        "FilterType":{
            "description":"The filter type.",
            "type":"string",
            "example":"FilterID"
        },
        "DeviceName":{
            "description":"The name of an associated device name, if any.",
            "type":"string",
            "nullable":true,
            "example":"Device1"
        },
        "DisplayName":{
            "description":"The display name.",
            "type":"string",
            "example":"Default"
        },
        "FilterGroupName":{
            "description":"The filter group name.",
            "type":"string",
            "example":"//Global"
        },
        "FilterValueName":{
            "description":"The filter value name.",
            "type":"string",
            "example":"All Events"
        },
        "DeviceZoneName":{
            "description":"The device zone name, if any.",
            "type":"string",
            "nullable":true,
            "example":"Zone1"
        },
        "DeviceZoneID":{
            "description":"The device zone ID, if any.",
            "type":"integer",
            "nullable":true,
            "example":1
        },
        "AllZonesRecord":{
            "description":"The record of all zones, if any.",
            "type":"string",
            "nullable":true,
            "example":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The status of the event widget.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "WidgetID":{
                                "description":"The unique widget ID within the diagram.",
                                "type":"integer",
                                "example":"Widget_1-497"
                            },
                            "SeverityCounts":{
                                "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.",
                                "type":"array",
                                "items":{
                                    "type":"integer"
                                },
                                "example":[
                                    7,
                                    1,
                                    1,
                                    1620,
                                    807,
                                    164
                                ]
                            },
                            "Count":{
                                "description":"The number of unique events (ie Rows).",
                                "type":"integer",
                                "example":2600
                            },
                            "SumOfCount":{
                                "description":"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.",
                                "type":"integer",
                                "example":122761923
                            }
                        }
                    },
                    "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
                        }
                    ]
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The status of the event widget.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The status of the event widget.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "WidgetID":{
                        "description":"The unique widget ID within the diagram.",
                        "type":"integer",
                        "example":"Widget_1-497"
                    },
                    "SeverityCounts":{
                        "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.",
                        "type":"array",
                        "items":{
                            "type":"integer"
                        },
                        "example":[
                            7,
                            1,
                            1,
                            1620,
                            807,
                            164
                        ]
                    },
                    "Count":{
                        "description":"The number of unique events (ie Rows).",
                        "type":"integer",
                        "example":2600
                    },
                    "SumOfCount":{
                        "description":"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.",
                        "type":"integer",
                        "example":122761923
                    }
                }
            },
            "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
                }
            ]
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The status of the event widget.

Show Source

• Array of: object items

{
    "description":"The status of the event widget.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "WidgetID":{
                "description":"The unique widget ID within the diagram.",
                "type":"integer",
                "example":"Widget_1-497"
            },
            "SeverityCounts":{
                "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.",
                "type":"array",
                "items":{
                    "type":"integer"
                },
                "example":[
                    7,
                    1,
                    1,
                    1620,
                    807,
                    164
                ]
            },
            "Count":{
                "description":"The number of unique events (ie Rows).",
                "type":"integer",
                "example":2600
            },
            "SumOfCount":{
                "description":"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.",
                "type":"integer",
                "example":122761923
            }
        }
    },
    "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
        }
    ]
}

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

• Count: integer
  The number of unique events (ie Rows).

  Example: 2600
• SeverityCounts: array 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.
• SumOfCount: integer
  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
• WidgetID: integer
  The unique widget ID within the diagram.

  Example: Widget_1-497

{
    "type":"object",
    "properties":{
        "WidgetID":{
            "description":"The unique widget ID within the diagram.",
            "type":"integer",
            "example":"Widget_1-497"
        },
        "SeverityCounts":{
            "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                7,
                1,
                1,
                1620,
                807,
                164
            ]
        },
        "Count":{
            "description":"The number of unique events (ie Rows).",
            "type":"integer",
            "example":2600
        },
        "SumOfCount":{
            "description":"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.",
            "type":"integer",
            "example":122761923
        }
    }
}

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

• Array of: integer

{
    "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        7,
        1,
        1,
        1620,
        807,
        164
    ]
}

Example:

[
    7,
    1,
    1,
    1620,
    807,
    164
]

Default Response

Failed operation

Body ()

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.

Back to Top