Skip to main content

GET - Детали проблемы по ID

Эндпоинт GET /issues/{id} используется для получения подробной информации о конкретной проблеме по её уникальному идентификатору (ID).

Параметры запроса​

ПараметрОписаниеТипОбязательный
idУникальный идентификатор проблемы, которую необходимо получить.UUIDДа

Пример запроса​

URL:
https://api.targpatrol.com/v1/issues/{id}

Пример запроса:
GET /issues/4adbc000-3095-42f3-bddd-d8a1da1ab2bd

Пример успешного ответа​

Код состояния: 200 OK

Тело ответа:

{
  "id": "4adbc000-3095-42f3-bddd-d8a1da1ab2bd",
  "name": "Issue",
  "description": "Description",
  "typeId": "cfd47385-fc8e-4727-a1b5-383e1842af1b",
  "status": "OPEN",
  "priority": "MAJOR",
  "assigneeId": "46ed469f-38f9-44fc-b6d5-9ec34f1e03cd",
  "seen": false,
  "untilDate": "2023-12-31T00:00:00.000Z",
  "locationId": "663745ce-daf9-4c0b-8616-e12ed40e6a34",
  "pointId": "59623848-fb58-4e19-b686-724d42d53c95",
  "email": "[email protected]",
  "mediaIds": [
    "44100168-11b1-4396-b863-96872820ab5f"
  ],
  "lastModifiedAt": "2023-03-07T05:57:59.315Z",
  "createdBy": "d3b4eb7b-567b-4e09-8646-09b648bf3bd6"
}

Примеры ошибок​

Недействительные входные данные​

Код состояния: 400 Bad Request

Тело ответа:

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "invalid data type",
      "code": "data.type.invalid",
      "identifier": "id",
      "args": [
        "[UUID]"
      ]
    }
  ]
}

Ресурс не найден​

Код состояния: 404 Not Found

Тело ответа:

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Внутренняя ошибка сервера​

Код состояния: 500 Internal Server Error

Тело ответа:

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Заключение​

Этот эндпоинт используется для получения информации о конкретной проблеме по её уникальному идентификатору. Запрос должен включать действительный id, чтобы успешно получить данные о проблеме, иначе будут возвращены ошибки в случае недействительного ID или технических проблем на сервере.