Skip to main content

DELETE - Удаление действия по ID

Эндпоинт DELETE /check-lists/actions/{id} используется для удаления определенного действия из чек-листа по его уникальному идентификатору (ID). Этот запрос позволяет удалить действие, если оно существует в системе.

Детали запроса​

  • Эндпоинт: DELETE /check-lists/actions/{id}
  • Метод: DELETE
  • Параметры пути:
    • id (обязательный): Уникальный идентификатор действия (UUID).
  • Заголовки:
    • Authorization: Требуется токен доступа.

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

URL запроса:​

https://api.targpatrol.com/v1/check-lists/actions/be63c536-6cf3-4866-8970-37a956e3f403

Заголовки:​

Authorization: Bearer YOUR_API_TOKEN

Возможные ответы​

1. Успешное удаление​

Если действие успешно удалено, API возвращает код ответа 204 No Content без тела ответа.

Обработка ошибок​

1. Неверные входные данные​

Происходит, если id не соответствует формату UUID.

Пример ответа:

{
  "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]"
      ]
    }
  ]
}

Решение: Убедитесь, что id соответствует формату UUID, например: be63c536-6cf3-4866-8970-37a956e3f403.

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

Происходит, если действие с указанным id не существует в системе.

Пример ответа:

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

Решение: Убедитесь, что id соответствует существующему действию.

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

Возникает из-за технических проблем на стороне сервера.

Пример ответа:

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

Решение: Повторите запрос позже или обратитесь в техническую поддержку.

Заключение​

Эндпоинт DELETE /check-lists/actions/{id} предоставляет безопасный способ удаления действий из чек-листа по их уникальному идентификатору. Соблюдая требования к идентификатору и заголовкам запроса, вы сможете избежать ошибок и обеспечить корректную работу.