API - Autotests
Отправка данных в коллектор автотестов осуществляется с помощью HTTP-запросов к API https://<instance-name>/api/public/fm/v1/aggregator.
Описание формата запроса для отправки результатов автотестирования в соответствующий проект
POST /api/public/fm/v1/aggregator
Параметры запроса
| Параметр | Тип | Обязательный параметр | Значение по умолчанию | Описание |
|---|---|---|---|---|
| projectKey | string | да, если не указан заголовок x-fmonq-project-key | нет | Ключ проекта автотестирования |
Возможно использование заголовка запроса для передачи ключа проекта
Заголовки запроса
| Заголовок | Тип | Обязательный параметр | Значение по умолчанию | Описание |
|---|---|---|---|---|
| x-fmonq-project-key | string | да, если не указан параметр projectKey | нет | Ключ проекта автотестирования |
| Content-Type | string | да | нет | Необходимо указать multipart/form-data |
Тело запроса
Тело запроса задаётся в формате multipart/form-data.
| Ключ | Значение | Описание |
|---|---|---|
| build | путь к файлу сборки автотеста: /path/to/<build-path>.zip | Файл результата автотестирования обязательно должен быть в формате архива .zip |
Пример запроса CURL
curl --location --request POST 'https://<instance>/api/public/fm/v1/aggregator' \
--header 'x-fmonq-project-key: <projectKey>' \
--header 'Content-Type: multipart/form-data' \
--form 'build=@"/path/to/<build-path>.zip"'
Коды ответа
| Код | Описание |
|---|---|
| 201 | Сборка отправлена в конвейер обработки |
| 400 | Не найден файл сборки в теле запроса |
| 400 | Не указан ключ проекта FMonq |
| 400 | Не указано имя файла в заголовке 'Content-Disposition' |
| 400 | Неверный формат файла |
| 415 | Неправильный тип входных данных. Требуется указать тип: multipart/form-data |
| 422 | Проект ФТ не активен |
| 422 | Проект ФТ по указанному ключу не найден |