Jump to

• Request
• Response

Get Severity States and Summary Count of Event Filters

get

/api/eventNavigation/Events/readStates

Gets the severity states and the summary count of event filters.

Request

Query Parameters

• id(required): string
  The comma-separated list of event filter IDs.

  Example:

  private,1,Filter-1-7,Filter-1-23

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• 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 event filters with their severity states and summary count.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The event filter ID.",
                                "type":"string"
                            },
                            "EventSeverity":{
                                "description":"The highest severity value among the filtered events.",
                                "type":"string",
                                "example":"normal"
                            },
                            "Count":{
                                "description":"The number of unique events (ie Rows).",
                                "type":"integer",
                                "example":0
                            },
                            "SumCount":{
                                "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":0
                            },
                            "SeverityValues":{
                                "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":[
                                    0,
                                    0,
                                    0,
                                    0,
                                    0
                                ]
                            },
                            "LoadingStates":{
                                "description":"Loading States",
                                "type":"boolean",
                                "example":false
                            }
                        }
                    },
                    "example":[
                        {
                            "id":"Filter-1-7",
                            "EventSeverity":"normal",
                            "Count":0,
                            "SumCount":0,
                            "SeverityValues":[
                                0,
                                0,
                                0,
                                0,
                                0,
                                0
                            ],
                            "LoadingStates":false,
                            "raw":{
                                "success":true,
                                "message":"Loaded 0 entries",
                                "data":[
                                ],
                                "errors":null,
                                "total":0,
                                "warnings":null,
                                "metaData":{
                                    "root":"data",
                                    "fields":[
                                    ],
                                    "columns":[
                                    ],
                                    "severities":{
                                        "normal":0,
                                        "unknown":0,
                                        "info":0,
                                        "minor":0,
                                        "major":0,
                                        "critical":0,
                                        "all":0,
                                        "sum":0
                                    }
                                }
                            }
                        },
                        {
                            "id":"Filter-1-23",
                            "EventSeverity":"critical",
                            "Count":2562,
                            "SumCount":3577998,
                            "SeverityValues":[
                                2,
                                0,
                                1,
                                1589,
                                809,
                                161
                            ],
                            "LoadingStates":false,
                            "raw":{
                                "success":true,
                                "message":"Loaded 0 entries",
                                "data":[
                                ],
                                "errors":null,
                                "total":0,
                                "warnings":null,
                                "metaData":{
                                    "root":"data",
                                    "fields":[
                                    ],
                                    "columns":[
                                    ],
                                    "severities":{
                                        "normal":0,
                                        "unknown":0,
                                        "info":0,
                                        "minor":0,
                                        "major":102,
                                        "critical":147,
                                        "all":249,
                                        "sum":700295
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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 event filters with their severity states and summary count.
• 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 event filters with their severity states and summary count.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The event filter ID.",
                        "type":"string"
                    },
                    "EventSeverity":{
                        "description":"The highest severity value among the filtered events.",
                        "type":"string",
                        "example":"normal"
                    },
                    "Count":{
                        "description":"The number of unique events (ie Rows).",
                        "type":"integer",
                        "example":0
                    },
                    "SumCount":{
                        "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":0
                    },
                    "SeverityValues":{
                        "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":[
                            0,
                            0,
                            0,
                            0,
                            0
                        ]
                    },
                    "LoadingStates":{
                        "description":"Loading States",
                        "type":"boolean",
                        "example":false
                    }
                }
            },
            "example":[
                {
                    "id":"Filter-1-7",
                    "EventSeverity":"normal",
                    "Count":0,
                    "SumCount":0,
                    "SeverityValues":[
                        0,
                        0,
                        0,
                        0,
                        0,
                        0
                    ],
                    "LoadingStates":false,
                    "raw":{
                        "success":true,
                        "message":"Loaded 0 entries",
                        "data":[
                        ],
                        "errors":null,
                        "total":0,
                        "warnings":null,
                        "metaData":{
                            "root":"data",
                            "fields":[
                            ],
                            "columns":[
                            ],
                            "severities":{
                                "normal":0,
                                "unknown":0,
                                "info":0,
                                "minor":0,
                                "major":0,
                                "critical":0,
                                "all":0,
                                "sum":0
                            }
                        }
                    }
                },
                {
                    "id":"Filter-1-23",
                    "EventSeverity":"critical",
                    "Count":2562,
                    "SumCount":3577998,
                    "SeverityValues":[
                        2,
                        0,
                        1,
                        1589,
                        809,
                        161
                    ],
                    "LoadingStates":false,
                    "raw":{
                        "success":true,
                        "message":"Loaded 0 entries",
                        "data":[
                        ],
                        "errors":null,
                        "total":0,
                        "warnings":null,
                        "metaData":{
                            "root":"data",
                            "fields":[
                            ],
                            "columns":[
                            ],
                            "severities":{
                                "normal":0,
                                "unknown":0,
                                "info":0,
                                "minor":0,
                                "major":102,
                                "critical":147,
                                "all":249,
                                "sum":700295
                            }
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

The list of event filters with their severity states and summary count.

Show Source

• Array of: object items

{
    "description":"The list of event filters with their severity states and summary count.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The event filter ID.",
                "type":"string"
            },
            "EventSeverity":{
                "description":"The highest severity value among the filtered events.",
                "type":"string",
                "example":"normal"
            },
            "Count":{
                "description":"The number of unique events (ie Rows).",
                "type":"integer",
                "example":0
            },
            "SumCount":{
                "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":0
            },
            "SeverityValues":{
                "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":[
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            },
            "LoadingStates":{
                "description":"Loading States",
                "type":"boolean",
                "example":false
            }
        }
    },
    "example":[
        {
            "id":"Filter-1-7",
            "EventSeverity":"normal",
            "Count":0,
            "SumCount":0,
            "SeverityValues":[
                0,
                0,
                0,
                0,
                0,
                0
            ],
            "LoadingStates":false,
            "raw":{
                "success":true,
                "message":"Loaded 0 entries",
                "data":[
                ],
                "errors":null,
                "total":0,
                "warnings":null,
                "metaData":{
                    "root":"data",
                    "fields":[
                    ],
                    "columns":[
                    ],
                    "severities":{
                        "normal":0,
                        "unknown":0,
                        "info":0,
                        "minor":0,
                        "major":0,
                        "critical":0,
                        "all":0,
                        "sum":0
                    }
                }
            }
        },
        {
            "id":"Filter-1-23",
            "EventSeverity":"critical",
            "Count":2562,
            "SumCount":3577998,
            "SeverityValues":[
                2,
                0,
                1,
                1589,
                809,
                161
            ],
            "LoadingStates":false,
            "raw":{
                "success":true,
                "message":"Loaded 0 entries",
                "data":[
                ],
                "errors":null,
                "total":0,
                "warnings":null,
                "metaData":{
                    "root":"data",
                    "fields":[
                    ],
                    "columns":[
                    ],
                    "severities":{
                        "normal":0,
                        "unknown":0,
                        "info":0,
                        "minor":0,
                        "major":102,
                        "critical":147,
                        "all":249,
                        "sum":700295
                    }
                }
            }
        }
    ]
}

Example:

[
    {
        "id":"Filter-1-7",
        "EventSeverity":"normal",
        "Count":0,
        "SumCount":0,
        "SeverityValues":[
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "LoadingStates":false,
        "raw":{
            "success":true,
            "message":"Loaded 0 entries",
            "data":[
            ],
            "errors":null,
            "total":0,
            "warnings":null,
            "metaData":{
                "root":"data",
                "fields":[
                ],
                "columns":[
                ],
                "severities":{
                    "normal":0,
                    "unknown":0,
                    "info":0,
                    "minor":0,
                    "major":0,
                    "critical":0,
                    "all":0,
                    "sum":0
                }
            }
        }
    },
    {
        "id":"Filter-1-23",
        "EventSeverity":"critical",
        "Count":2562,
        "SumCount":3577998,
        "SeverityValues":[
            2,
            0,
            1,
            1589,
            809,
            161
        ],
        "LoadingStates":false,
        "raw":{
            "success":true,
            "message":"Loaded 0 entries",
            "data":[
            ],
            "errors":null,
            "total":0,
            "warnings":null,
            "metaData":{
                "root":"data",
                "fields":[
                ],
                "columns":[
                ],
                "severities":{
                    "normal":0,
                    "unknown":0,
                    "info":0,
                    "minor":0,
                    "major":102,
                    "critical":147,
                    "all":249,
                    "sum":700295
                }
            }
        }
    }
]

Nested Schema : items

Type: object

Show Source

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

  Example: 0
• EventSeverity: string
  The highest severity value among the filtered events.

  Example: normal
• id: string
  The event filter ID.
• LoadingStates: boolean
  Loading States

  Example: false
• SeverityValues: array SeverityValues
  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.
• SumCount: 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: 0

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The event filter ID.",
            "type":"string"
        },
        "EventSeverity":{
            "description":"The highest severity value among the filtered events.",
            "type":"string",
            "example":"normal"
        },
        "Count":{
            "description":"The number of unique events (ie Rows).",
            "type":"integer",
            "example":0
        },
        "SumCount":{
            "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":0
        },
        "SeverityValues":{
            "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":[
                0,
                0,
                0,
                0,
                0
            ]
        },
        "LoadingStates":{
            "description":"Loading States",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : SeverityValues

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":[
        0,
        0,
        0,
        0,
        0
    ]
}

Example:

[
    0,
    0,
    0,
    0,
    0
]

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top