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
  • The comma-separated list of device IDs.
    Example:
    109,7
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
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
  • The total number of unique events reported for the device.
    Example: 0
  • The device ID.
    Example: 40
  • Whether an event exists (true) or not (false).
    Example: true
  • The highest event severity for the device. Possible values are info, critical, major, minor, normal,and unknown.
    Example: normal
  • Whether states are loading (true) or not (false).
    Example: false
  • SeverityValues
    An array of event counts for each severity value in the following order - Normal, Unknown, Info, Minor, Major, and Critical.
  • 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
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
Example:
[
    0,
    0,
    0,
    0,
    0,
    0
]

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
An error.
Back to Top