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

Поиск сущностей Git-интеграции

Запрос

Тип Метод
POST /git_integration_entities/search

Описание: метод выполняет поиск staging-сущностей Git-интеграции с учетом заданных фильтров.

Staging-сущности содержат данные, полученные из Git-репозитория до их применения в Платформе.

Поддерживаемые типы сущностей:

  • logmule_go_rule — правила корреляции;
  • sources_pipeline — источники и конвейеры разбора.

Поле applied определяет состояние применения сущности:

  • false — сущность ожидает применения;
  • true — сущность применена в Платформе.
Пример запроса 

POST

https://development.gigantic-server.com/v1/git_integration_entities/search

Тело запроса соответствует модели GenericSearchRequest.

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

{
  "<параметр>": "<значение>"
}

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

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

Формат: JSON.

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

Параметр Тип данных Описание
items Array<GitIntegrationEntity> Список найденных staging-сущностей Git-интеграции
total integer Общее количество найденных объектов
Пример ответа 

{
  "items": [
    {
      "<параметр>": "<значение>"
    }
  ],
  "total": 1
}

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

Код Ответ Описание
400 Bad Request Ошибка в параметрах запроса
500 Internal Server Error Ошибка сервера

Возможные ошибки:

  • 400 — "missing uid header" — отсутствует заголовок Pgr-User-ID;
  • 400 — "Pgr-User-Id should be uuid format" — неверный формат Pgr-User-ID;
  • 400 — "Bad Request" — неверный тип параметра запроса либо отсутствует обязательный параметр;
  • 500 — "Internal Server Error" — ошибка сервера.
Пример ответа с кодом 400 

{
  "error": "Bad Request"
}
Пример ответа с кодом 500 

{
  "error": "Internal Server Error"
}