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

Обзор

Основные характеристики

Характеристика Значение
Наименование retro_jobs
Компоненты Cruddy
Появился в версии 4.0.0
Доступен в версиях 4.0.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс retro_jobs отвечает за управление задачами ретроспективной корреляции.

Список методов для работы с ресурсом

Тип Метод Описание
POST /retro_jobs/create Создание задачи
PUT /retro_jobs/update Обновление информации о задаче
POST /retro_jobs/search Поиск задач
GET /retro_jobs/{id} Получение задачи по ID
DELETE /retro_jobs/{id} Удаление задачи
POST /retro_jobs/group Группировка задач
POST /retro_jobs/mass_delete Массовое удаление задач
DELETE /retro_jobs/all Удаление всех задач
GET /retro_jobs/reserve Зарезервировать задачу
PUT /retro_jobs/update-worker Обновление работающей задачи
POST /retro_jobs/mass_stop Остановка списка задач
POST /retro_jobs/mass_queued Массовая смена статуса на 'queued'
GET /retro_jobs/_meta Получение свойств полей задач и действий пользователей

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
401 Невозможно аутентифицировать пользователя
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
422 Внутренняя ошибка удаления
500 Ошибка сервера

Модели объектов

Название Описание
RetroJob Модель данных ресурса retro_jobs