Create Incident Report

Method: POST
/api/v1/incident-reports

---

Description

This endpoint allows the creation of a new incident report. It captures information about the incident, such as its name, description, related documents, and resolution details.

---

🔑 Authentication

This endpoint requires authentication via headers.

Param	Value	Type
userId	{{userId}}	string
countryCode	{{countryCode}}	string (optional)
tenantId	{{tenantId}}	string (optional)

---

Request Body

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

Request Body Explanation

Name	Type	Description
documents	array	A 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 unique tracking ID for the incident.
resolutionPeriod	number	The number of days or hours required to resolve the incident.
resolutionPeriodType	string	The unit for the resolution period (DAYS or HOURS).
incidentModelId	string	The unique ID of the incident model associated with the report.
incidentModelType	string	The type of incident model (e.g., TRADE, LOGISTICS).
userId	string	The ID of the user submitting the incident report.
countryCode	string	The country code where the incident occurred.
tenantId	string	The ID of the tenant associated with the incident.

Sample Response: 201 Created

{
  "message": "Incident report created successfully.",
  "incidentId": "incident123",
  "incidentName": "Product Delay",
  "trackingId": "track456",
  "status": "OPEN",
  "createdAt": "2025-02-12T04:04:39.986Z"
}