Skip to main content

Фоновые задачи

POST {host}/bgt/

ЗАПРОС

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

ОТВЕТ

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

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

Пример (задача в процессе выполнения - синхронизация доверенностей)
{
    "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/order/create/",
    "created_at": "2025-01-15T10:30:00Z",
    "attrs": {
        "user_id": 123,
        "serviceprovider_id": 456,
        "participant_id": 789,
        "attributes": {
            "release_method_type": "PRODUCTION",
            "create_method_type": "SELF_MADE"
        }
    },
    "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": "SUCCESS",
    "result": {
        "state": "SUCCESS",
        "messages": [
            {
                "text": "Доверенности синхронизированы"
            }
        ]
    }
}
Пример (завершенная с ошибкой задача)
{
    "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"
}

ОШИБКИ

Статус Код Описание
400 BackgroundTaskNotFound Фоновая задача не найдена

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

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

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

ПРИМЕЧАНИЯ

  1. Метод требует аутентификации пользователя или служебного аккаунта через JWT токен
  2. Используется для получения статуса и результата выполнения фоновых задач
Back to top