Отримання статусу задачі формування даних – Proxima Research Ukraine

Опис

Цей ендпоінт перевіряє поточний статус раніше надісланої задачі на генерацію даних. Він повертає код статусу та додаткову інформацію про задачу, таку як кількість пакетів (для відповідей у форматі JSON).

Endpoint

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

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

Bearer Token (обов'язковий)

Запит

Заголовки

Ключ	Значення
Authorization	Bearer `<token>`
Content-Type	`application/json` (не обов'язковий)

Path Parameter (Параметр шляху)

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

Тіло запиту

Не вимагається

Успішна відповідь

200 OK

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

Поля запиту

Поле	Тип	Опис
id	integer	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	Помилки сервера

Пошук