Close Investigation

This endpoint can be used by you to close an ongoing investigation using the supportTicketId in the request URL.

1. If you close an OPEN investigation, then the status of the investigation is changed to CLOSED.
2. If you close an already CLOSED investigation, then the endpoint will return an error (see below).

Request

URL: /api/v{version}/investigation/:supportTicketId/close

Method: PUT

Example Request

{
  "description": "Closing this query as it has been resolved"
}

Response

When you close the investigation, the API will return a 202 Accepted message which means your request to close the investigation was successful.

Http code: 202 Accepted

Error Scenario

If you don't provide description, the API will return an error as below:

{
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "errors": {
        "Description": [
            "The Description field is required."
        ]
    },
    "traceId": "00-ba4dc02444454c78a8c4b8a851f39b42-009cb432bc701524-00"
}

If you close an investigation that is already in a CLOSED status, the API will return an error as below:

{
    "title": "Bad Input",
    "status": 400,
    "detail": "This investigation is already closed. Please check and enter a new investigation ID or reopen the investigation to query further",
    "traceId": "00-ca5182fafd9fd5d2b78fd8a0a2e1348f-af311533e541ab2e-00",
    "errorCode": "INV00005"
}