Get Events for an Entity
get
/vision/api/rawEvents/forEntityName/{entityName}
Gets the events for the specified entity. You can optionally also specify a zone ID in the query parameter. This is useful if you have multiple devices with the same name in different device zones.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
- Admin
- Operator
- Viewer
- Api
Request
Path Parameters
-
entityName(required): string
The name of the entity to get events for.Example:
entity123
Query Parameters
-
zoneId: string
The zone ID for the entity.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : ResourceWrapper41
Type:
object
The response resource wrapper.
Show Source
-
columns: array
columns
Information about the columns used to display the requested or updated content.
-
content: array
content
The requested or updated content.
-
links: array
links
Links related to the requested or updated content.
Nested Schema : columns
Type:
array
Information about the columns used to display the requested or updated content.
Show Source
-
Array of:
object ColumnData
The details of columns to use to show data in a table.
Nested Schema : content
Type:
array
The requested or updated content.
Show Source
-
Array of:
object RawEvent
The raw event details.
Nested Schema : links
Type:
array
Links related to the requested or updated content.
Show Source
-
Array of:
object Link
The link details.
Nested Schema : ColumnData
Type:
object
The details of columns to use to show data in a table.
Show Source
-
cssClass: string
The CSS class for the column.Example:
slick-header-column
-
defaultSortAsc: boolean
Whether to sort the column in ascending order by default (true) or not (false).Example:
true
-
editor: string
The editor to use for the column.Example:
TaskEnabledEditor
-
entity: string
The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the Settings UI.Example:
Task
-
field: string
The field to use for data in the column cells.Example:
enabled
-
focusable: boolean
Whether the column is focusable (true) or not (false).Example:
true
-
formatter: string
The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like true to True.Example:
CamelCaseFormatter
-
headerCssClass: string
The CSS class for the column header.Example:
slick-header-column
-
id: integer
(int64)
The column ID.Example:
130
-
maxWidth: integer
(int32)
The maximum width for the column.Example:
80
-
minWidth: integer
(int32)
The minimum width for the column.Example:
30
-
name: string
The column name, that appears in the header row.Example:
Enabled
-
options: string
Options for values in the column.Example:
true,false
-
rerenderOnResize: boolean
Whether the column should be rerendered when resized (true) or not (false).Example:
false
-
resizable: boolean
Whether the column can be resized (true) or not (false).Example:
true
-
selectable: boolean
Whether the column can be selected (true) or not (false).Example:
true
-
sortable: boolean
Whether the column can be used to sort the table (true) or not (false).Example:
true
-
tooltip: string
The tooltip to display for the column.Example:
Whether the task is enabled or disabled.
-
width: integer
(int32)
The default width, in pixels, of the column.Example:
50
Nested Schema : RawEvent
Type:
object
The raw event details.
Show Source
-
ack: integer
(int32)
Whether the event has been acknowledged (1) or not (0).Example:
1
-
entityName: string
The name of the entity associated with the event.Example:
entity123
-
eventKey: string
The event key.Example:
Standard Threshold Event entity123
-
expireAfter: integer
(int32)
The timestamp when the event expires.Example:
203026500
-
id: integer
(int64)
The event ID.Example:
123
-
info: string
The event description.Example:
Inbound Bandwidth Unused on instance instance123 cleared
-
layer: string
The layer where the event appears.Example:
STE Events
-
metadata: object
metadata
Metadata for the event.
-
severity: integer
(int32)
The event severity.Example:
1
-
sourceId: integer
(int32)
The ID of the event source.Example:
1
-
timestamp: integer
(int32)
The event timestamp.Example:
2147483647
-
zoneId: integer
(int64)
The zone ID for the event.Example:
1
Nested Schema : metadata
Type:
object
Metadata for the event.
Example:
type: dDevice
Nested Schema : Link
Type:
object
The link details.
Show Source
-
expects: object
expects
Additional Properties Allowed: additionalPropertiesAny input expected by the link.
-
href: string
The link reference.Example:
https://example.com/layers
-
method: string
The HTTP method used by the linked object.Example:
GET
-
rel: string
The relationship between the linked object and the current object.Example:
self
Nested Schema : expects
Type:
object
Additional Properties Allowed
Show Source
Any input expected by the link.
Example:
text
Nested Schema : additionalProperties
Type:
object
401 Response
Unauthorized Access
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
500 Response
An internal server error occurred while accessing the database or performing a database operation.
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500