Get impact entity by document ID.

get

/sia/v1/impact/docid/{docid}

Retrieve an individual impact entity using its document id.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Impact entity retrieved successfully.
Body ()
Root Schema : SmartSearchEventImpact
Type: object
Show Source
Nested Schema : customer
Type: array
Details about the customers impacted due to this impact.
Show Source
Nested Schema : edgeLinkEntityId
Type: array
Entity ids of the communication edges in topology, currently used for ring impacts.
Show Source
Nested Schema : SmartSearchCustomer
Type: object
Show Source
Examples

400 Response

The request isn't valid
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

401 Response

The request is unauthorized
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

403 Response

The request is forbidden
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

404 Response

The requested resource not found
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

500 Response

An Internal Server Error has occurred
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source
Back to Top