REST API for Active Topology Automation and Service Impact Analysis

Initiate impact analysis for device interface

get

/sia/v1/impact/deviceinterface/{id}

This operation fetches impacts based on device interface inventory id and related event document id from the inventory system. When the analysis is initiated, analysisStatus on the corresponding event changes to INITIATED. Once the analysis completes, analysisStatus for the event transitions to COLLECTED. However, if the analysis fails, analysisStatus for the event changes to FAILED and errorDetails field is populated with the error details occurred during analysis.

Request

Path Parameters

id(required): string
The device interface inventory id.
Example:
```
L1059-1
```

Query Parameters

event(required): string
The event document id.
Example:
```
UE1741839039068882843
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Updated Event on which impact analysis was initiated.

Root Schema : schema

Type: object

Show Source

alarmDetails: string

Protocol specific alarm details for this event.
alarmType: string

Alarm type for this event.
analysisStatus: string

Analysis status for this event.
businessObjectClass: string
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.
edgeLinkEntityId: array edgeLinkEntityId

Entity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.
~~entityId: integer~~ (int64)
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.
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.
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.
ownerName: string

Owner of this event.
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.
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.

{
    "properties":{
        "entityId":{
            "deprecated":true,
            "format":"int64",
            "type":"integer"
        },
        "eventId":{
            "type":"string"
        },
        "businessObjectClass":{
            "type":"string"
        },
        "instanceName":{
            "description":"Instance name for this event.",
            "type":"string"
        },
        "eventDate":{
            "description":"Event date when event status for this event was changed.",
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "eventStatus":{
            "description":"Event status for this event.",
            "type":"string"
        },
        "thresholdName":{
            "description":"Threshold name for this TCA event.",
            "type":"string"
        },
        "thresholdTimeRange":{
            "description":"Threshold time range for this TCA event.",
            "type":"string"
        },
        "thresholdTypeName":{
            "description":"Threshold time range for this TCA event.",
            "type":"string"
        },
        "thresholdSeverity":{
            "description":"Threshold severity for this TCA event.",
            "format":"int64",
            "type":"integer"
        },
        "metricValue":{
            "description":"Threshold metric value for this TCA event.",
            "type":"string"
        },
        "thresholdOperator":{
            "description":"Threshold operator value for this TCA event.",
            "type":"string"
        },
        "thresholdType":{
            "description":"Threshold type for this TCA event.",
            "type":"string"
        },
        "thresholdMessage":{
            "description":"Threshold message for this TCA event.",
            "type":"string"
        },
        "measurement":{
            "description":"Threshold measurement for this TCA event.",
            "type":"string"
        },
        "thresholdValue":{
            "description":"Threshold value for this TCA event.",
            "format":"double",
            "type":"number"
        },
        "referenceId":{
            "description":"External assurance system reference id for this event.",
            "type":"string"
        },
        "alarmType":{
            "description":"Alarm type for this event.",
            "type":"string"
        },
        "perceivedSeverity":{
            "description":"Alarm perceived severity for this event.",
            "type":"string"
        },
        "probableCause":{
            "description":"Alarm probable cause for this event.",
            "type":"string"
        },
        "specificProblem":{
            "description":"Alarm specific problem for this event.",
            "type":"string"
        },
        "sourceSystemID":{
            "description":"Assurance system source system identifier for this event.",
            "type":"string"
        },
        "alarmDetails":{
            "description":"Protocol specific alarm details for this event.",
            "type":"string"
        },
        "href":{
            "description":"External system alarm href for this event.",
            "type":"string"
        },
        "createdDate":{
            "description":"Date on which this event was created.",
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "description":"User by whom this event was created.",
            "type":"string"
        },
        "lastModifiedDate":{
            "description":"Date on which this event was last modified.",
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "description":"User by whom this event was last modified.",
            "type":"string"
        },
        "reportId":{
            "description":"System generated report id, when this event was completed.",
            "type":"string"
        },
        "reportCreationDate":{
            "description":"Date at which this event was completed and a report was generated.",
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "relationships":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "lang":{
            "description":"Smart Search internal field used in lang pipeline processing.",
            "type":"string"
        },
        "tenant_id":{
            "description":"Smart Search internal field for search tenancy.",
            "type":"string"
        },
        "id":{
            "description":"Document id for the event entity.",
            "type":"string"
        },
        "resourceName":{
            "description":"Name of the resource on which this event is raised.",
            "type":"string"
        },
        "resourceCategory":{
            "description":"Category of the resource on which this event is raised.",
            "type":"string"
        },
        "resourceType":{
            "description":"Type of the resource on which this event is raised.",
            "type":"string"
        },
        "resourceSubType":{
            "description":"Sub type of the resource on which this event is raised.",
            "type":"string"
        },
        "resourceId":{
            "description":"Inventory id of the resource on which this event is raised.",
            "type":"string"
        },
        "resourceHref":{
            "description":"Inventory href of the resource on which this event is raised.",
            "type":"string"
        },
        "resourceActiveEvent":{
            "description":"Active event on the topology node when this event was raised.",
            "format":"int64",
            "type":"integer"
        },
        "nodeLinkEntityId":{
            "description":"Entity id of the device node in topology to which this event is associated.",
            "type":"string"
        },
        "edgeLinkEntityId":{
            "description":"Entity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "ownerName":{
            "description":"Owner of this event.",
            "type":"string"
        },
        "analysisStatus":{
            "description":"Analysis status for this event.",
            "type":"string"
        },
        "errorDetails":{
            "description":"Error details gathered when event analysis fails for this event.",
            "type":"string"
        },
        "description":{
            "description":"Free-text description for this event.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : edgeLinkEntityId

Type: array

Entity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.

Show Source

Array of: string

{
    "description":"Entity ids of the communication edges in topology that terminate on the inventory resource on which this event is raised.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Nested Schema : relationships

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Examples

400 Response

The request isn't valid

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

401 Response

The request is unauthorized

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

403 Response

The request is forbidden

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

404 Response

The requested resource not found

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

500 Response

An Internal Server Error has occurred

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}