Get Parent Simulated Event details
get
/sia/v1/event/simulated/{id}
Returns parent simulated event details. When include=aggregations is provided, also returns resource aggregations computed from child simulated events (grouped by resourceType) and a UI-friendly summary string.
Request
Path Parameters
-
id(required): string
The document id of the parent simulated event.
Query Parameters
-
include: string
Optional include flags. Supported: aggregationsExample:
aggregations
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Event details retrieved.
Root Schema : SimulatedEventDetailsResponse
Type:
objectEnriched simulated event details including resource aggregations.
Show Source
-
aggregations: object
aggregations
Aggregated resource details for this simulated event.
-
event: object
event
The parent simulated event entity.
-
totalResourcesCount: integer
(int64)
Total number of resources across all types (sum of aggregation counts).
Nested Schema : aggregations
Type:
objectAggregated resource details for this simulated event.
Match All
Aggregated resource details for this simulated event.
Aggregated resource details for this simulated event.
Show Source
-
object
SimulatedEventAggregations
Aggregated resource details for a simulated event.
-
object
SimulatedEventAggregations
Aggregated resource details for a simulated event.
Nested Schema : event
Type:
objectThe parent simulated event entity.
Match All
The parent simulated event entity.
The parent simulated event entity.
Show Source
Nested Schema : SimulatedEventAggregations
Type:
objectAggregated resource details for a simulated event.
Show Source
-
resourceAggregations: array
resourceAggregations
Resource aggregations grouped by resource type.
-
resourceSummaryString: string
UI-friendly summary string for resources, e.g., '6 Logical Devices, 12 Physical Ports'.
Nested Schema : resourceAggregations
Type:
arrayResource aggregations grouped by resource type.
Show Source
-
Array of:
object ResourceAggregationItem
Aggregation bucket for a resource type and its count.
Nested Schema : ResourceAggregationItem
Type:
objectAggregation bucket for a resource type and its count.
Show Source
-
count: integer
(int64)
Number of children events of this type for the parent.
-
type: string
Resource type name, e.g., PhysicalPort, LogicalDevice, Equipment.
Nested Schema : schema
Type:
Show Source
object-
alarmDetails: string
Protocol specific alarm details for this event.
-
alarmType: string
Alarm type for this event.
-
analysisStatus: string
Analysis status for this event.
-
attemptedRingStrategies: array
attemptedRingStrategies
Ring calculation strategy context: the successful strategy for positive Rings results, or zero-result attempted strategies when noRingsFound is true.
-
businessObjectClass: string
-
childrenCount: integer
(int64)
Total number of child events under this parent (derived).
-
completionDate: string
(date)
Completion date of this Planned Maintenance event.Example:
2022-03-10 -
createdDate: string
(date)
Date on which this event was created.Example:
2022-03-10 -
createdUser: string
User by whom this event was created.
-
description: string
Free-text description for this event.
-
duration: string
Duration for which this Planned Maintenance event is planned.
-
edgeLinkEntity: string
ATA Edge Link Entity Id for edge alarms.
-
edgeLinkEntityId: array
edgeLinkEntityId
Entity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.
-
errorDetails: string
Error details gathered when event analysis fails for this event.
-
eventDate: string
(date)
Event date when event status for this event was changed.Example:
2022-03-10 -
eventId: string
-
eventStatus: string
Event status for this event.
-
externalReferenceId: string
External system reference identifier for Simulated / Planned event.
-
href: string
External system alarm href for this event.
-
id: string
Document id for the event entity.
-
instanceName: string
Instance name for this event.
-
lang: string
Smart Search internal field used in lang pipeline processing.
-
lastModifiedDate: string
(date)
Date on which this event was last modified.Example:
2022-03-10 -
lastModifiedUser: string
User by whom this event was last modified.
-
maintenanceCategory: string
Maintenance category for Planned Maintenance event.
-
masterEvent: string
Id of the master Planned / Scheduled event.
-
measurement: string
Threshold measurement for this TCA event.
-
metricValue: string
Threshold metric value for this TCA event.
-
nodeLinkEntityId: string
Entity id of the device node in topology to which this event is associated.
-
noRingsFound: boolean
Indicates that Rings calculation completed successfully and found no rings.
-
ownerName: string
Owner of this event.
-
parentNodeEntityId: string
parent node entity Id
-
perceivedSeverity: string
Alarm perceived severity for this event.
-
probableCause: string
Alarm probable cause for this event.
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
referenceId: string
External assurance system reference id for this event.
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
reportCreationDate: string
(date)
Date at which this event was completed and a report was generated.Example:
2022-03-10 -
reportId: string
System generated report id, when this event was completed.
-
resourceActiveEvent: integer
(int64)
Active event on the topology node when this event was raised.
-
resourceCategory: string
Category of the resource on which this event is raised.
-
resourceHref: string
Inventory href of the resource on which this event is raised.
-
resourceId: string
Inventory id of the resource on which this event is raised.
-
resourceName: string
Name of the resource on which this event is raised.
-
resourceSubType: string
Sub type of the resource on which this event is raised.
-
resourceType: string
Type of the resource on which this event is raised.
-
rootElement: boolean
Indicates if this is top level event in the events hierarchy.
-
scheduledDate: string
(date)
Date at which this Planned Maintenance event is scheduled.Example:
2022-03-10 -
sourceSystemID: string
Assurance system source system identifier for this event.
-
specificProblem: string
Alarm specific problem for this event.
-
tenant_id: string
Smart Search internal field for search tenancy.
-
thresholdMessage: string
Threshold message for this TCA event.
-
thresholdName: string
Threshold name for this TCA event.
-
thresholdOperator: string
Threshold operator value for this TCA event.
-
thresholdSeverity: integer
(int64)
Threshold severity for this TCA event.
-
thresholdTimeRange: string
Threshold time range for this TCA event.
-
thresholdType: string
Threshold type for this TCA event.
-
thresholdTypeName: string
Threshold time range for this TCA event.
-
thresholdValue: number
(double)
Threshold value for this TCA event.
Nested Schema : attemptedRingStrategies
Type:
arrayRing calculation strategy context: the successful strategy for positive Rings results, or zero-result attempted strategies when noRingsFound is true.
Show Source
Nested Schema : edgeLinkEntityId
Type:
arrayEntity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.
Show Source
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