REST API for Active Topology Automation and Service Impact Analysis

Bulk update impacts

patch

/sia/v1/impact/bulkUpdate

Update the impacts in bulk using the given operation records. Updates to owner name, impact severity and analysis status are supported.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object ImpactBulkUpdateRecord

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

Nested Schema : ImpactBulkUpdateRecord

Type: object

Show Source

analysisStatus: string

Analysis status to be updated for the impact.
id: string

Impact document id for which update operation is to be performed.
impactSeverity: string

Impact severity to be updated for the impact.
ownerName: string

Owner name to be updated for the impact.

{
    "properties":{
        "id":{
            "description":"Impact document id for which update operation is to be performed.",
            "type":"string"
        },
        "ownerName":{
            "description":"Owner name to be updated for the impact.",
            "type":"string"
        },
        "impactSeverity":{
            "description":"Impact severity to be updated for the impact.",
            "type":"string"
        },
        "analysisStatus":{
            "description":"Analysis status to be updated for the impact.",
            "type":"string"
        }
    },
    "type":"object"
}

Examples

Response

Supported Media Types

application/json

200 Response

Impacts updated successfully.

Root Schema : BulkOperationResult

Type: object

Show Source

errors: array errors

Error records to store the information of the failed operations on the entities.
hasErrors: boolean

Flag to indicate if there are any errors.

{
    "properties":{
        "hasErrors":{
            "description":"Flag to indicate if there are any errors.",
            "type":"boolean"
        },
        "errors":{
            "description":"Error records to store the information of the failed operations on the entities.",
            "items":{
                "$ref":"#/components/schemas/ErrorRecord"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Error records to store the information of the failed operations on the entities.

Show Source

Array of: object ErrorRecord

{
    "description":"Error records to store the information of the failed operations on the entities.",
    "items":{
        "$ref":"#/components/schemas/ErrorRecord"
    },
    "type":"array"
}

Nested Schema : ErrorRecord

Type: object

Show Source

errorMessage: string

Error message indicating the reason for the failure.
id: string

Document id of the entity for which the operation failed.

{
    "properties":{
        "id":{
            "description":"Document id of the entity for which the operation failed.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Error message indicating the reason for the failure.",
            "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"
}