Retrieve the event based on entityId
get
/vertex/event/eid/{eid}
Retrieve the event based on entityId
Request
Path Parameters
-
eid(required): string
The entityId of the event
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Vertex retrieved successfully
Root Schema : schema
Type:
Show Source
object
-
alarmDetails: string
-
alarmType: string
Allowed Values:
[ "COMMUNICATIONS_ALARM", "PROCESSING_ERROR_ALARM", "ENVIRONMENTAL_ALARM", "QUALITY_OF_SERVICE_ALARM", "EQUIPMENT_ALARM", "INTEGRITY_VIOLATION", "OPERATIONAL_VIOLATION", "PHYSICAL_VIOLATION", "SECURITY_SERVICE", "MECHANISM_VIOLATION", "TIME_DOMAIN_VIOLATION" ]
-
businessObjectClass: string
-
createdDate: string
(date)
-
createdUser: string
-
entityId: integer
(int64)
-
eventDate: string
(date)
-
eventStatus: string
Allowed Values:
[ "CLEARED", "RAISED", "UPDATED" ]
-
href: string
-
instanceName: string
-
lastModifiedDate: string
(date)
-
lastModifiedUser: string
-
measurement: string
-
metricValue: number
(double)
-
perceivedSeverity: string
Allowed Values:
[ "CLEARED", "INDETERMINATE", "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
-
probableCause: string
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
referenceId: integer
(int64)
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
sourceSystemID: string
-
specificProblem: string
-
thresholdMessage: string
-
thresholdName: string
-
thresholdOperator: string
-
thresholdSeverity: integer
(int64)
-
thresholdTimeRange: integer
(int64)
-
thresholdType: string
-
thresholdTypeName: string
-
thresholdValue: number
(double)
Examples
400 Response
The request isn't valid
401 Response
The request is unauthorized
403 Response
The request is forbidden
404 Response
The requested resource not found
500 Response
An Internal Server Error has occurred