Skip to main content

PUT - Обновление действия по ID

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

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

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

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

URL запроса:​

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

Заголовки:​

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Данные для обновления:​

{
  "name": "Устройство издает громкий звук",
  "type": "BOOLEAN"
}

Пример на Python:​

import requests

# URL с идентификатором действия
url = "https://api.targpatrol.com/v1/check-lists/actions/be63c536-6cf3-4866-8970-37a956e3f403"

# Заголовки
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
}

# Данные для обновления
data = {
    "name": "Устройство издает громкий звук",
    "type": "BOOLEAN"
}

# Отправка PUT-запроса
response = requests.put(url, headers=headers, json=data)

# Обработка ответа
if response.status_code == 200:
    updated_action = response.json()
    print("Обновленные данные действия:", updated_action)
else:
    print(f"Ошибка: {response.status_code}, {response.json()}")

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

Если запрос успешен, API возвращает обновленные данные действия:

{
  "id": "be63c536-6cf3-4866-8970-37a956e3f403",
  "name": "Устройство издает громкий звук",
  "type": "BOOLEAN"
}

Поля ответа:​

  • id: Уникальный идентификатор действия.
  • name: Обновленное имя действия.
  • type: Обновленный тип действия (одно из значений: BOOLEAN, MEDIA, NUMBER, TEXT).

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

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

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

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

{
  "message": "Ошибка валидации",
  "code": "validation.failed",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "не может быть пустым",
      "code": "validation.notnull.failed",
      "identifier": "type"
    }
  ]
}

Решение: Убедитесь, что в теле запроса указаны все обязательные поля с допустимыми значениями. Например, поле type должно быть указано и соответствовать одному из разрешенных значений (BOOLEAN, MEDIA, NUMBER, TEXT).

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

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

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

{
  "message": "Ресурс не найден",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Решение: Проверьте, соответствует ли id существующему действию.

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

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

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

{
  "message": "Несоответствие типов контента",
  "code": "not.acceptable",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

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

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

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

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

{
  "message": "Внутренняя ошибка сервера",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

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

Заключение​

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