# API - fmonq (Testforge)
Отправка данных в агрегатор fmonq осуществляется с помощью HTTP-запросов к API http(s)://<instance-name>/api/public/fm/v1/aggregator
.
# Отправка сборки в Агрегатор
POST /api/public/fm/v1/aggregator
# Параметры запроса
Параметр | Тип | Требуется | Описание |
---|---|---|---|
projectKey | string | да | Ключ API проекта fmonq Можно заменить заголовком x-fmonq-project-key=<key> Если ключ указан обоими способами, то приоритет на стороне параметра |
# Заголовки запроса
Заголовок | Требуется | Описание |
---|---|---|
x-fmonq-project-key | да | Ключ API проекта fmonq Можно заменить параметром projectKey=<key> Если ключ указан обоими способами, то приоритет на стороне параметра |
Content-Type: multipart/form-data | да | Необходим для отправки сборки в запросе как содержимого |
# Тело запроса
Тело запроса задаётся в формате form-data.
Ключ | Значение | Описание |
---|---|---|
build | С:/<build-path>.zip | Возможен произвольный ключ Файл сборки обязательно должен быть в формате архива .zip |
# Пример запроса CURL
curl --location --request POST 'https://<instance-name>/api/public/fm/v1/aggregator' \
--header 'x-fmonq-project-key: 4c7fdf6e-f286-42e6-98bc-4b4b65dab0c4' \
--header 'Content-Type: multipart/form-data' \
--form 'build=@"C:/<build-path>.zip"'
# Коды ответа
Код | Описание |
---|---|
201 | Сборка отправлена в конвейер обработки |
400 | Не найден файл сборки в теле запроса |
400 | Не указан ключ проекта FMONQ |
400 | Не указано имя файла в заголовке 'Content-Disposition' |
400 | Неверный формат файла |
415 | Неправильный тип входных данных. Требуется указать тип: multipart/form-data |
422 | Проект ФТ не активен |
422 | Проект ФТ по указанному ключу не найден |