Skip to main content

Потоковый результат

POST {host}/bgt/stream/

ЗАПРОС

Заголовок
{
    "Accept-Language": "ru", // ○ язык ответов: ru или en (ru по-умолчанию)
    "Authorization": "Bearer {token}" // ● JWT токен авторизации
}
Структура
{
    "bgt_uuid": string // ● UUID фоновой задачи
}
Пример
{
    "bgt_uuid": "550e8400-e29b-41d4-a716-446655440000"
}

ОТВЕТ

Структура

Для успешно завершенных задач (state = SUCCESS):

Потоковая передача данных в виде байтов (текст в кодировке UTF-8). Полученные байты нужно декодировать в UTF-8 для получения текстовых данных. Структура и формат данных зависят от типа задачи.

Для задач в процессе выполнения или завершенных с ошибкой:

{
    "bgt_uuid": string, // UUID фоновой задачи
    "name": string, // Название задачи (URL путь)
    "created_at": string, // Время создания задачи (ISO 8601)
    "attrs": { // Атрибуты задачи
        "user_id": integer, // ● ID пользователя, запустившего задачу
        "serviceprovider_id": integer, // ● ID сервис-провайдера
        // ○ Дополнительные атрибуты, специфичные для типа задачи
    },
    "state": string // Состояние задачи
}

💡 Список доступных значений для состояний задач см. в разделе Доступные значения

Пример ответа (задача в процессе выполнения)
{
    "bgt_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "/psp/poas/pull/",
    "created_at": "2025-01-15T10:30:00Z",
    "attrs": {
        "user_id": 123,
        "serviceprovider_id": 456
    },
    "state": "PENDING"
}
Пример ответа (завершенная с ошибкой задача)
{
    "bgt_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "/psp/poas/pull/",
    "created_at": "2025-01-15T10:30:00Z",
    "attrs": {
        "user_id": 123,
        "serviceprovider_id": 456
    },
    "state": "FAILED"
}
Пример потока данных (успешно завершенная задача)
<данные в виде байтов, которые нужно декодировать в UTF-8>

ОШИБКИ

Статус Код Описание
400 BackgroundTaskNotFound Фоновая задача не найдена
400 BackgroundTaskHasNoData Фоновая задача не содержит данных для потоковой передачи

💡 Метод также может возвращать глобальные ошибки.

ДОСТУПНЫЕ ЗНАЧЕНИЯ

Состояния задач
Значение Описание
PENDING Задача в процессе выполнения
SUCCESS Задача успешно завершена
FAILED Задача завершена с ошибкой

ПРИМЕЧАНИЯ

  1. Метод требует аутентификации пользователя или служебного аккаунта через JWT токен
  2. Используется для потоковой передачи данных успешно завершенных фоновых задач
  3. Для задач в состоянии SUCCESS возвращает данные в виде потока байтов (текст в кодировке UTF-8)
  4. Для задач в состояниях PENDING и FAILED возвращает JSON структуру аналогично методу /bgt/
  5. Данные передаются один раз и удаляются после отправки
Back to top