Получение статуса задачи формирования данных – Proxima Research

Описание

Этот эндпоинт проверяет текущий статус ранее отправленной задачи на генерацию данных. Он возвращает код статуса и дополнительную информацию о задаче, такую как количество пакетов (для ответов в формате JSON).

Endpoint

GET https://yourdomain.pharmahrm.com/crm-api/db-function/status/{{job_id}}

Аутентификация

Bearer Token (обязателен)

Запрос

Заголовки

Key	Value
Authorization	Bearer `<token>`
Content-Type	`application/json` (optional)

Path Parameter

Параметр	Тип	Обязателен	Описание
job_id	integer	Да	Уникальный идентификатор отправленной задачи

Тело

Тело запроса не требуется

Успешный ответ

200 OK

{
    "id": 39,
    "status": 3,
    "batch_count": null
}

Поля запроса

Поле	Тип	Описание
id	integer	Job ID — идентификатор отправленной задачи
status	integer	Текущий статус задачи (см. коды статуса ниже)
batch_count	integer или null	Количество пакетов данных (применимо только для формата JSON; один пакет = 500 записей)

Коды статусов

Код	Статус	Описание
1	Pending (В ожидании)	Задача находится в очереди на выполнение
2	Running (В процессе)	Задача в данный момент выполняется
3	Finished (Завершено)	Задача успешно выполнена
4	Error (Ошибка )	Во время выполнения произошла ошибка

Ошибочный ответ

40x / 50x

{
  "message": "Error message string"
}

Код	Описание
400-499	Ошибки клиента (например, неверный идентификатор задачи)
500–599	Ошибки сервера

Поиск