Skip to main content

PATCH - Частичное обновление списка проверок по ID

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

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

  • Метод: PATCH
  • Эндпоинт: /check-lists/{id}
  • Заголовки:
    • Authorization: Необходим токен доступа.
    • Content-Type: application/json.
  • Параметры пути:
    • id (строка, обязательный): Уникальный идентификатор списка проверок (UUID).
  • Тело запроса: JSON-объект, содержащий поля для обновления:
    • name (строка, необязательное): Название списка проверок.
    • actionIds (массив, необязательное): Список идентификаторов действий, связанных с этим списком проверок.
    • tags (массив, необязательное): Список тегов, связанных с этим списком проверок.

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

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

Тело запроса:

{
  "name": "Kitchen list 1",
  "actionIds": [
    "1cea9223-e7d4-4b12-becc-9482afd7999d",
    "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
  ],
  "tags": [
    "kitchen"
  ]
}

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

{
  "id": "be63c536-6cf3-4866-8970-37a956e3f403",
  "name": "Kitchen list 1",
  "actionIds": [
    "1cea9223-e7d4-4b12-becc-9482afd7999d",
    "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
  ],
  "tags": [
    "kitchen"
  ]
}

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

Неверные данные ввода​

Происходит, когда данные имеют неправильный формат или некорректный тип.

Ответ:

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

Решение: Убедитесь, что все данные и типы соответствуют требованиям API.

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

Происходит, когда список проверок с указанным ID не существует.

Ответ:

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

Решение: Проверьте, что указанный ID существует в системе.

Несоответствие типа контента​

Происходит, когда заголовок Content-Type отсутствует или данные не находятся в формате JSON.

Ответ:

{
  "message": "mismatch in the types of content",
  "code": "not.acceptable",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Решение: Убедитесь, что тело запроса находится в формате JSON, и что заголовок Content-Type установлен правильно.

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

Происходит, когда на сервере возникают технические проблемы.

Ответ:

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

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

Заключение​

Эндпоинт PATCH /check-lists/{id} позволяет частично обновлять список проверок, предоставляя гибкость при интеграции с API. Убедитесь, что данные ввода точны, чтобы избежать ошибок.