Перейти до основного вмісту

Отримання статусу пакета даних

URI: /api/v1/marketplace/data-import/{import_id}/status

Метод використовується для отримання статусу пакета даних.

Запит виконується методом GET

⚠️ Запит повинен містити заголовок Accept: application/json

Параметри URI

Метод дозволяє передати в рядку запиту наступні параметри:

Ім'яТипОбов'язковийОпис
import_idstringТакІдентифікатор імпорту

Приклад запиту

/api/v1/marketplace/data-import/544/status

Параметри відповіді

Ім'яТипОпис
dataobjectДані імпорту
data.idintegerІдентифікатор імпорту
data.dataset_typestringТип даних
data.import_statusstringСтатус імпорту даних:
  • wait_in_queue - очікує в черзі (1)
  • processing - опрацювання (2)
  • deleting - видалення (2)
  • success - успішно (3)
  • deleted - видалено (3)
  • error - помилка (3)

  • 1 - статус одразу після завантаження
    2 - процес імпорту запущено
    3 - фінальний статус
    data.index_statusstringСтатус індексації даних для подальшого аналізу
    data.imported_rowsintegerКількість імпортованих документів
    data.indexed_rowsintegerКількість індексованих документів для подальшого аналізу
    data.duplicated_rowsintegerКількість документів які раніше були вже завантажено (дублі)
    data.deleted_rowsintegerКількість видалених документів (за полем deleted)
    data.created_atstringДата та час створення імпорту
    data.updated_atstringДата та час останнього оновлення імпорту
    messagestringТекст помилки

    Приклад успішної відповіді

    200 OK

    Відповідь: /api/v1/marketplace/data-import/544/status
    {
    "data": {
    "id": 544,
    "dataset_type": "sell",
    "import_status": "success",
    "index_status": "error",
    "imported_rows": 2,
    "indexed_rows": 0,
    "duplicated_rows": 0,
    "deleted_rows": 0,
    "created_at": "2024-01-24 18:09:32",
    "updated_at": "2024-01-24 18:10:31"
    }
    }

    Приклад неуспішної відповіді

    Користувач немає доступу до даного імпорту даних

    400 Bad Request

    Відповідь: /api/v1/marketplace/data-import/544/status
    {
    "message": "User has not access to this data import"
    }