REST API for Unified Assurance Core

Get Device Event Details

get

/api/deviceNavigation/Devices/readStatesEvent

Get event details about the devices specified in DeviceID, including the number of events by severity.

Request

Query Parameters

DeviceID(required): string
The comma-separated list of device IDs.
Example:
```
109,7
```
limit: integer(int32)
The number of records to limit results by.
Example:
```
100
```
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

Type: object

Show Source

data: array data
message: string

The response message.

Example: Retrieved Event States
success: boolean

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

Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Retrieved Event States"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesEvent"
            },
            "example":[
                {
                    "DeviceID":"109",
                    "EventExists":true,
                    "EventSeverity":"normal",
                    "Count":"0",
                    "SumCount":"0",
                    "SeverityValues":[
                        "0",
                        "0",
                        "0",
                        "0",
                        "0",
                        "0"
                    ],
                    "LoadingStates":false
                },
                {
                    "DeviceID":"7",
                    "EventExists":true,
                    "EventSeverity":"major",
                    "Count":"32",
                    "SumCount":"8627",
                    "SeverityValues":[
                        "1",
                        "0",
                        "0",
                        "28",
                        "3",
                        "0"
                    ],
                    "LoadingStates":false
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object deviceNavigationDevicesReadStatesEvent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesEvent"
    },
    "example":[
        {
            "DeviceID":"109",
            "EventExists":true,
            "EventSeverity":"normal",
            "Count":"0",
            "SumCount":"0",
            "SeverityValues":[
                "0",
                "0",
                "0",
                "0",
                "0",
                "0"
            ],
            "LoadingStates":false
        },
        {
            "DeviceID":"7",
            "EventExists":true,
            "EventSeverity":"major",
            "Count":"32",
            "SumCount":"8627",
            "SeverityValues":[
                "1",
                "0",
                "0",
                "28",
                "3",
                "0"
            ],
            "LoadingStates":false
        }
    ]
}

Example:

[
    {
        "DeviceID":"109",
        "EventExists":true,
        "EventSeverity":"normal",
        "Count":"0",
        "SumCount":"0",
        "SeverityValues":[
            "0",
            "0",
            "0",
            "0",
            "0",
            "0"
        ],
        "LoadingStates":false
    },
    {
        "DeviceID":"7",
        "EventExists":true,
        "EventSeverity":"major",
        "Count":"32",
        "SumCount":"8627",
        "SeverityValues":[
            "1",
            "0",
            "0",
            "28",
            "3",
            "0"
        ],
        "LoadingStates":false
    }
]

Nested Schema : deviceNavigationDevicesReadStatesEvent

Type: object

Show Source

Count: integer

The total number of unique events reported for the device.

Example: 0
DeviceID: integer

The device ID.

Example: 40
EventExists: boolean

Whether an event exists (true) or not (false).

Example: true
EventSeverity: string

The highest event severity for the device. Possible values are info, critical, major, minor, normal,and unknown.

Example: normal
LoadingStates: boolean

Whether states are loading (true) or not (false).

Example: false
SeverityValues: array SeverityValues

An array of event counts for each severity value in the following order - Normal, Unknown, Info, Minor, Major, and Critical.
SumCount: integer

The SUM(Count) of all the unique events. For example, if a device has 2 events, the first with a count of 1 and the second with a count of 9, then the Count is 2, SumCount is 10.

Example: 0

{
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer",
            "example":"40"
        },
        "EventExists":{
            "description":"Whether an event exists (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":true
        },
        "EventSeverity":{
            "description":"The highest event severity for the device. Possible values are <b>info</b>, <b>critical</b>, <b>major</b>, <b>minor</b>, <b>normal</b>,and <b>unknown</b>.",
            "type":"string",
            "example":"normal"
        },
        "Count":{
            "description":"The total number of unique events reported for the device.",
            "type":"integer",
            "example":"0"
        },
        "SumCount":{
            "description":"The SUM(Count) of all the unique events. For example, if a device has 2 events, the first with a count of 1 and the second with a count of 9, then the Count is 2, SumCount is 10.",
            "type":"integer",
            "example":"0"
        },
        "SeverityValues":{
            "description":"An array of event counts for each severity value in the following order - Normal, Unknown, Info, Minor, Major, and Critical.",
            "type":"array",
            "items":{
            },
            "example":[
                "0",
                "0",
                "0",
                "0",
                "0",
                "0"
            ]
        },
        "LoadingStates":{
            "description":"Whether states are loading (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":false
        }
    },
    "type":"object"
}

Nested Schema : SeverityValues

Type: array

An array of event counts for each severity value in the following order - Normal, Unknown, Info, Minor, Major, and Critical.

Show Source

Array of:

{
    "description":"An array of event counts for each severity value in the following order - Normal, Unknown, Info, Minor, Major, and Critical.",
    "type":"array",
    "items":{
    },
    "example":[
        "0",
        "0",
        "0",
        "0",
        "0",
        "0"
    ]
}

Example:

[
    "0",
    "0",
    "0",
    "0",
    "0",
    "0"
]

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.