Update an impact with document id
patch
/sia/v1/impact/docid/{docid}
Update an impact entity with the given document id. Updates to owner name, severity, analysis status and comments are supported.
Request
Path Parameters
-
docid(required): string
The document id of the impact entity to be updated.
Supported Media Types
- application/json
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Impact entity is updated successfully.
Root Schema : SmartSearchEventImpact
Type:
Show Source
object
-
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.
Nested Schema : customer
Type:
array
Details about the customers impacted due to this impact.
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