Skip to main content

GET - Детали действия по ID

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

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

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

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

URL запроса:​

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

Заголовки:​

Authorization: Bearer YOUR_API_TOKEN

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

Если действие с указанным ID найдено, API возвращает следующие данные:

{
  "id": "be63c536-6cf3-4866-8970-37a956e3f403",
  "name": "Device sounds loudly",
  "type": "BOOLEAN"
}

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

  • id: Уникальный идентификатор действия.
  • name: Название действия.
  • type: Тип действия (может быть одним из следующих: BOOLEAN, MEDIA, NUMBER, или TEXT).

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

Если что-то пошло не так, API вернет одно из следующих сообщений об ошибке:

1. Неверные входные данные​

Возникает, если id не соответствует формату UUID.

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

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "invalid data type",
      "code": "data.type.invalid",
      "identifier": "id",
      "args": [
        "[UUID]"
      ]
    }
  ]
}

Решение: Убедитесь, что формат id соответствует стандарту UUID, например: be63c536-6cf3-4866-8970-37a956e3f403.

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

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

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

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

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

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

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

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

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

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

Заключение​

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