Update Incident Report

Method: PATCH
/api/v1/incident-reports/{id}

---

Description

This endpoint updates an existing incident report. You can update the incident name, description, documents, tracking details, and resolution period.

---

🔑 Authentication

This endpoint requires authentication via headers.

Param	Value	Type
userId	{{userId}}	string
tenantId	{{tenantId}}	string

---

Path Parameter

Name	Type	Description
id	string	The unique ID of the incident report.

---

Request Body

{
  "documents": [
    {
      "name": "string",
      "link": "string"
    }
  ],
  "incidentName": "string",
  "description": "string",
  "trackingId": "string",
  "resolutionPeriod": 0,
  "resolutionPeriodType": "DAYS",
  "userId": "string",
  "countryCode": "string",
  "tenantId": "string"
}

Request Body Explanation

Name	Type	Description
documents	array	List of documents related to the incident report.
documents[].name	string	The name of the document.
documents[].link	string	A URL linking to the document.
incidentName	string	The name of the incident.
description	string	A detailed description of the incident.
trackingId	string	A tracking ID associated with the incident report.
resolutionPeriod	number	The time period for resolving the incident.
resolutionPeriodType	string	The unit of time for the resolution period (e.g., "DAYS").
userId	string	The ID of the user updating the incident report.
countryCode	string	The country code associated with the incident report.
tenantId	string	The ID of the tenant associated with the incident report.

Response: 200

{
  "message": "Incident report updated successfully.",
  "incidentId": "12345",
  "updatedFields": {
    "incidentName": "System Outage",
    "description": "System outage due to power failure.",
    "resolutionPeriod": 2,
    "resolutionPeriodType": "DAYS"
  }
}