GET - Список действий

Описание

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

---

Авторизация

Для доступа к этому эндпоинту необходимо предоставить действительный токен доступа в заголовке Authorization.

Пример использования токена в заголовке:

Authorization: Bearer YOUR_API_TOKEN

---

Параметры запроса

Параметр	Описание	Пример значения	Значение по умолчанию
limit	Ограничивает количество возвращаемых элементов.	20	2147483647
offset	Пропускает указанное количество элементов в начале коллекции.	0	0
sort	Параметры сортировки (поле и направление).	id,asc	id,asc
name	Фильтрация по названию действия.	Check panel
checkListId	Фильтрация по ID чек-листа.	in:99b267f4-9cf1-45cd-a9cb-4ef2b64e3a61

---

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

URL:

https://api.targpatrol.com/v1/check-lists/actions?name=Check%20panel&limit=20

Заголовки:

Authorization: Bearer YOUR_API_TOKEN

---

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

Код состояния:

200 OK

Тело ответа:

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Device sounds loudly",
      "type": "BOOLEAN"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1000,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ]
  }
}

---

Пример ошибки

Код состояния:

500 Internal Server Error

Тело ответа:

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

---

Заключение

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