Перейти к содержанию

Получение источника по ID

Запрос

Тип Метод
GET /input_sources/{id}

Описание: При выполнении запроса будет возвращен источник с соответствующим ID.

Если не указан параметр relations, то подгружаются все связи объекта. Если параметр указан, но не имеет значений - связи не подгружаются. Если параметр указан и содержит значения (поля модели хранящие связанные сущности), то они будут заполнены в ответе.

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

GET
http://127.0.0.1/cruddy/v2/input_sources/{id}

Path параметры запроса:

Параметр Описание
{id} Идентификатор источника

Query параметры запроса:

Параметр Описание
relations Перечисление подгружаемых связей

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Тело ответа: модель источника.

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2025-02-21T11:33:03.241694Z",
  "updated_at": "2025-03-27T15:18:23.118238Z",
  "trace_id": "df570c03-5a03-4cea-8df0-c162d05127ac",
  "name": "string",
  "source_type": "string",
  "vendor": "string",
  "port": 0,
  "is_active": true,
  "display_name": "string",
  "check_min": true,
  "check_min_value": 0,
  "check_max": true,
  "check_max_value": 0,
  "no_raw": true,
  "input_type": "raw-json",
  "pipelines": [
    {}
  ],
  "_relations": {}
}

Другие возможные ответы

Код Ответ Описание
400 id is empty Не передан параметр “id”
404 not found Объект не найден
500 Internal Server Error Другие ошибки при получении объекта

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа
Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 404

{
  "error": "Not Found",
  "error_code": 404
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}