REST API for Active Topology Automation and Service Impact Analysis

Get impacts for an event

get

/sia/v1/impact/event/{eventId}

Fetch impacts based on related event document id.

Request

Path Parameters

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

Query Parameters

limit(required): integer(int32)
The limit for the pagination.
Example:
```
10
```
offset(required): integer(int32)
The offset for the pagination.
Example:
```
0
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List of impacts for the given event document id.

Root Schema : schema

Type: array

Show Source

Array of: object SmartSearchResultsImpact

{
    "items":{
        "$ref":"#/components/schemas/SmartSearchResultsImpact"
    },
    "type":"array"
}

Nested Schema : SmartSearchResultsImpact

Type: object

Show Source

_shards: object Shards
count: integer (int32)
hasMore: boolean
items: array items
limit: integer (int32)
offset: integer (int32)
sort: array sort
timed_out: boolean
took: integer (int32)
totalResults: integer (int32)

{
    "properties":{
        "totalResults":{
            "format":"int32",
            "type":"integer"
        },
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "took":{
            "format":"int32",
            "type":"integer"
        },
        "sort":{
            "items":{
                "$ref":"#/components/schemas/Sort"
            },
            "type":"array"
        },
        "timed_out":{
            "type":"boolean"
        },
        "_shards":{
            "$ref":"#/components/schemas/Shards"
        },
        "items":{
            "items":{
                "$ref":"#/components/schemas/ImpactItem"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : Shards

Type: object

Show Source

failed: integer (int32)
skipped: integer (int32)
successful: integer (int32)
total: integer (int32)

{
    "properties":{
        "total":{
            "format":"int32",
            "type":"integer"
        },
        "successful":{
            "format":"int32",
            "type":"integer"
        },
        "skipped":{
            "format":"int32",
            "type":"integer"
        },
        "failed":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object ImpactItem

{
    "items":{
        "$ref":"#/components/schemas/ImpactItem"
    },
    "type":"array"
}

Nested Schema : sort

Type: array

Show Source

Array of: object Sort

{
    "items":{
        "$ref":"#/components/schemas/Sort"
    },
    "type":"array"
}

Nested Schema : ImpactItem

Type: object

Show Source

_id: string
_index: string
_score: number (double)
_source: object SmartSearchEventImpact

{
    "properties":{
        "_id":{
            "type":"string"
        },
        "_index":{
            "type":"string"
        },
        "_score":{
            "format":"double",
            "type":"number"
        },
        "_source":{
            "$ref":"#/components/schemas/SmartSearchEventImpact"
        }
    },
    "type":"object"
}

Nested Schema : SmartSearchEventImpact

Type: object

Show Source

analysisStatus: string

Analysis status for the impacted entity.
comments: string

Free-text comments related to the impact added by user.
customer: array customer

Details about the customers impacted due to this impact.
endDate: string (date)

The date at which the impact is closed.

Example: 2022-03-10
entityType: string

Entity Type of the impacted entity.
event: string

Document id of the event with which this impact is associated.
flowIdentifierDomain: string

Domain of the impacted flow identifier.
flowIdentifierIdentifier: integer (int32)

Identifier of the impacted flow identifier.
href: string

Inventory href of the impacted entity.
id: string

Document id for the impact entity.
impactSeverity: string

Severity of the impact.
impactType: string

Type of impact, possible values are DIRECT and INDIRECT.
index: object SmartSearchBulkIndex
lang: string

Smart Search internal field used in lang pipeline processing.
lastUpdatedDate: string (date)

The date at which the impact was last modified.

Example: 2022-03-10
latitude: number (double)

Latitude of the impacted location entity.
location: string

Latitude and Longitude coordinates for the location.
longitude: number (double)

Longitude of the impacted location entity.
name: string

Name of the impacted entity.
ownerName: string

Owner of the impact.
qualificationTime: string

The number of epoch milliseconds between the time the event is created and the time the impact analysis status changes to QUALIFIED or DISQUALIFIED.
ratecode: string

Ratecode of the impacted Connectivity entity.
specification: string

Specification of the impacted entity.
technology: string

Technology of the impacted Connectivity entity.
tenant_id: string

Smart Search internal field for search tenancy.

{
    "properties":{
        "index":{
            "$ref":"#/components/schemas/SmartSearchBulkIndex"
        },
        "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 impact entity.",
            "type":"string"
        },
        "name":{
            "description":"Name of the impacted entity.",
            "type":"string"
        },
        "entityType":{
            "description":"Entity Type of the impacted entity.",
            "type":"string"
        },
        "href":{
            "description":"Inventory href of the impacted entity.",
            "type":"string"
        },
        "specification":{
            "description":"Specification of the impacted entity.",
            "type":"string"
        },
        "latitude":{
            "description":"Latitude of the impacted location entity.",
            "format":"double",
            "type":"number"
        },
        "longitude":{
            "description":"Longitude of the impacted location entity.",
            "format":"double",
            "type":"number"
        },
        "impactType":{
            "description":"Type of impact, possible values are DIRECT and INDIRECT.",
            "type":"string"
        },
        "technology":{
            "description":"Technology of the impacted Connectivity entity.",
            "type":"string"
        },
        "ratecode":{
            "description":"Ratecode of the impacted Connectivity entity.",
            "type":"string"
        },
        "analysisStatus":{
            "description":"Analysis status for the impacted entity.",
            "type":"string"
        },
        "event":{
            "description":"Document id of the event with which this impact is associated.",
            "type":"string"
        },
        "location":{
            "description":"Latitude and Longitude coordinates for the location.",
            "type":"string"
        },
        "endDate":{
            "description":"The date at which the impact is closed.",
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "lastUpdatedDate":{
            "description":"The date at which the impact was last modified.",
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "qualificationTime":{
            "description":"The number of epoch milliseconds between the time the event is created and the time the impact analysis status changes to QUALIFIED or DISQUALIFIED.",
            "type":"string"
        },
        "customer":{
            "description":"Details about the customers impacted due to this impact.",
            "items":{
                "$ref":"#/components/schemas/SmartSearchCustomer"
            },
            "type":"array"
        },
        "impactSeverity":{
            "description":"Severity of the impact.",
            "type":"string"
        },
        "ownerName":{
            "description":"Owner of the impact.",
            "type":"string"
        },
        "comments":{
            "description":"Free-text comments related to the impact added by user.",
            "type":"string"
        },
        "flowIdentifierIdentifier":{
            "description":"Identifier of the impacted flow identifier.",
            "format":"int32",
            "type":"integer"
        },
        "flowIdentifierDomain":{
            "description":"Domain of the impacted flow identifier.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : customer

Type: array

Details about the customers impacted due to this impact.

Show Source

Array of: object SmartSearchCustomer

{
    "description":"Details about the customers impacted due to this impact.",
    "items":{
        "$ref":"#/components/schemas/SmartSearchCustomer"
    },
    "type":"array"
}

Nested Schema : SmartSearchBulkIndex

Type: object

Show Source

_id: string
_index: string

{
    "properties":{
        "_index":{
            "type":"string"
        },
        "_id":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : SmartSearchCustomer

Type: object

Show Source

customerHref: string
customerId: string
customerName: string
customerRole: string
customerType: string

{
    "properties":{
        "customerId":{
            "type":"string"
        },
        "customerName":{
            "type":"string"
        },
        "customerHref":{
            "type":"string"
        },
        "customerRole":{
            "type":"string"
        },
        "customerType":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : Sort

Type: object

Show Source

label: string
value: string

{
    "properties":{
        "value":{
            "type":"string"
        },
        "label":{
            "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"
}