Отправка выбранных сущностей в Git
Запрос
| Тип | Метод |
|---|---|
POST |
/git_integration_entities/push |
Описание: метод запускает отправку в Git выбранных сущностей для указанного экземпляра Git-интеграции.
В поле entity_ids передаются ID целевых сущностей, которые необходимо отправить в Git.
При использовании режима push_mode = event метод также может вызываться через API. Плановая отправка в данном режиме дополнительно запускается после изменений правил корреляции, конвейеров или импорта контента.
Пример запроса
POST
https://development.gigantic-server.com/v1/git_integration_entities/push
Тело запроса:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| integration_id | string (uuid) |
Required | ID экземпляра Git-интеграции |
| entity_ids | Array<string (uuid)> |
Required | Список ID сущностей, которые необходимо отправить в Git |
Пример тела запроса
{
"integration_id": "00000000-0000-0000-0000-000000000000",
"entity_ids": [
"11111111-1111-1111-1111-111111111111",
"22222222-2222-2222-2222-222222222222"
]
}
Успешный ответ
Статус код: 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—"entity_ids is required"— параметрentity_idsне передан или содержит пустой список;400—"entity_ids should contain uuid values"— вentity_idsпередано значение, не соответствующее формату UUID;400—"push is disabled"— отправка данных в Git отключена для интеграции;400—"entity not found:"— указанная сущность не найдена для отправки в Git;400—"not a git integration"— указанная интеграция не является Git-интеграцией;404—"integration not found"— интеграция с указанным ID не найдена;500—"Internal Server Error"— ошибка сервера.
Пример ответа с кодом 400
{
"error": "entity not found:"
}
Пример ответа с кодом 404
{
"error": "integration not found"
}
Пример ответа с кодом 500
{
"error": "Internal Server Error"
}