Skip to main content

POST - Создать новый чек-лист

Эндпоинт POST /check-lists используется для создания нового чек-листа, включающего указанные действия и теги.

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

  • Метод: POST

  • Эндпоинт: /check-lists

  • Заголовки:

    • Authorization: Требуется токен доступа.
    • Content-Type: application/json.

  • Тело запроса:
    JSON-объект, содержащий следующие поля:

    • name (строка, обязательное): Название чек-листа.
    • actionIds (массив, обязательное): Массив идентификаторов действий (UUID), которые будут включены в чек-лист.
    • tags (массив, обязательное): Список тегов, связанных с чек-листом.

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

URL​

https://api.targpatrol.com/v1/check-lists

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

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

Пример на Python​

import requests

# URL API
url = "https://api.targpatrol.com/v1/check-lists"

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

# Данные запроса
data = {
    "name": "Kitchen list 1",
    "actionIds": [
        "1cea9223-e7d4-4b12-becc-9482afd7999d",
        "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
    ],
    "tags": ["kitchen"]
}

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

# Обработка ответа
if response.status_code == 201:
    created_checklist = response.json()
    print("Чек-лист создан:", created_checklist)
else:
    print(f"Ошибка: {response.status_code}, {response.json()}")

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

  • Код состояния: 201 Created
  • Тело ответа:
{
  "id": "2e04ee59-c0af-4621-adea-f854d4b8572b",
  "name": "Kitchen list 1",
  "actionIds": [
    "1cea9223-e7d4-4b12-becc-9482afd7999d",
    "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
  ],
  "tags": [
    "kitchen"
  ]
}

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

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

Возникает, если обязательные поля отсутствуют или имеют недопустимые значения.

Ответ:

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

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

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

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

Ответ:

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

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

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

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

Ответ:

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

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

Итог​

Эндпоинт POST /check-lists позволяет создавать чек-листы, указав действия и теги. Убедитесь, что данные запроса и заголовки настроены корректно, чтобы успешно выполнить операцию. Правильная обработка ошибок упрощает отладку и интеграцию с API.