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

Получение всех сущностей из Git

Запрос

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

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

Метод выполняет операцию, аналогичную заданию получения данных из Git. В ветке pull_branch обрабатываются все файлы с расширением .json, кроме meta.json.

JSON-файл может содержать один объект или массив объектов. Каждая сущность должна содержать поле id в формате UUID.

При выполнении операции:

  • данные создаются или обновляются в git_integration_entities;
  • обновляется сопоставление файлов;
  • сущности, которые больше отсутствуют в Git-репозитории, удаляются из staging;
  • если включен параметр pull_auto_apply, после получения данных выполняется автоматическое применение сущностей с учетом изменений чувствительных данных на Платформе.
Пример запроса

POST

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

Тело запроса:

Параметр Тип данных Обязательность Описание
integration_id string (uuid) Required ID экземпляра Git-интеграции
Пример тела запроса

{
  "integration_id": "00000000-0000-0000-0000-000000000000"
}

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

Статус код: 200 – получение данных из Git выполнено успешно.

Формат: JSON.

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

Параметр Тип данных Описание
result string Результат выполнения операции
Пример ответа

{
  "result": "ok"
}

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

Код Ответ Описание
400 Bad Request Ошибка в параметрах запроса или при выполнении получения данных
404 integration not found Интеграция не найдена
500 Internal Server Error Ошибка сервера

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

  • 400 — "missing uid header" — отсутствует заголовок Pgr-User-ID;
  • 400 — "Pgr-User-Id should be uuid format" — неверный формат Pgr-User-ID;
  • 400 — "integration_id is required" — не передан integration_id;
  • 400 — "integration_id should be uuid format" — неверный формат UUID параметра integration_id;
  • 400 — "pull is disabled" — получение данных из Git отключено для интеграции;
  • 400 — "not a git integration" — указанная интеграция не является Git-интеграцией;
  • 400 — "integration module not found" — модуль интеграции не загружен;
  • 400 — "git integration job already running" — для интеграции уже выполняется операция получения или отправки данных;
  • 404 — "integration not found" — интеграция с указанным ID не найдена;
  • 500 — "Internal Server Error" — ошибка сервера.
Пример ответа с кодом 400

{
  "error": "pull is disabled"
}
Пример ответа с кодом 404

{
  "error": "integration not found"
}
Пример ответа с кодом 500

{
  "error": "Internal Server Error"
}