Skip to main content

PUT - Обновление списка проверок по ID

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

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

  • Метод: PUT
  • Эндпоинт: /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"
  ]
}

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

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

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

Ошибка валидации​

Происходит, если предоставленные данные недействительны или отсутствуют обязательные поля.

Ответ:

{
  "message": "validation failed",
  "code": "validation.failed",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "must not be null",
      "code": "validation.notnull.failed",
      "identifier": "type"
    }
  ]
}

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

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

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

Ответ:

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

Решение: Убедитесь, что ID списка проверок правильный.

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

Происходит, если заголовок Content-Type не установлен в application/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"
}

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

Заключение​

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