Skip to main content

GET - Список чек-листов

Эндпоинт GET /check-lists позволяет получить список чек-листов, которые представляют собой наборы действий, сгруппированных по задачам или категориям. Этот эндпоинт поддерживает пагинацию, фильтрацию и сортировку для удобного управления результатами.

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

  • Метод: GET
  • Эндпоинт: /check-lists
  • Заголовки:
    • Authorization: Токен доступа (обязательно).
  • Параметры запроса (необязательно):
    • offset (целое число): Смещение для пагинации (по умолчанию: 0).
    • limit (целое число): Количество элементов на странице (по умолчанию: 20).
    • sort (строка): Поле и направление сортировки (например, id, name).

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

URL запроса:​

https://api.targpatrol.com/v1/check-lists?offset=0&limit=20&sort=id

Заголовки:​

Authorization: Bearer YOUR_API_TOKEN

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

{
  "data": [
    {
      "id": "2e04ee59-c0af-4621-adea-f854d4b8572b",
      "name": "Kitchen list 1",
      "actionIds": [
        "1cea9223-e7d4-4b12-becc-9482afd7999d",
        "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
      ],
      "tags": [
        "kitchen"
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1000,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ]
  }
}

Поля ответа​

data​

Массив объектов чек-листов:

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

meta​

Метаданные для пагинации и сортировки:

  • offset (целое число): Текущее смещение для пагинации.
  • limit (целое число): Максимальное количество элементов в ответе.
  • count (целое число): Общее количество доступных чек-листов.
  • sort (массив): Критерии сортировки:
    • property (строка): Поле, по которому выполняется сортировка.
    • direction (строка): Порядок сортировки (asc или desc).

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

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

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

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

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

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

Итог​

Эндпоинт GET /check-lists предоставляет доступ к списку доступных чек-листов. Используйте параметры запроса для настройки результатов с помощью фильтрации, сортировки и пагинации. Корректная обработка ошибок и использование метаданных помогут оптимизировать интеграцию в ваше приложение.