Copy page

Разное

Получение статуса импорта

Статус импорта, поставленного запросом POST https://api.mindbox.ru/v3/operations/bulk, можно получить по его идентификатору. В ответе приходят статус импорта и количество обработанных строк, строк с ошибками и строк с предупреждениями.

Общая схема запросов:

1. Запрос импорта и получение идентификатора импорта importId.
2. Запрос статуса импорта по importId. Повторяйте запрос, пока импорт не завершится.

Идентификатор импорта

Идентификатор импорта приходит в ответе на запрос импорта, например массового импорта клиентов, в поле data.importId.

Ответ об успешной постановке импорта

Ответ
Content-Type: application/json

{
  "status": "Success",
  "data": {
    "workItemId": <Номер задачи импорта в административной панели>,
    "importId": "<Идентификатор импорта, который нужно передать в запросе статуса>"
  }
}

Ответ при повторном запросе

Если повторить запрос импорта с тем же ключом идемпотентности transactionId, новый импорт не ставится. В ответе приходит статус TransactionAlreadyProcessed и идентификатор первого импорта с этим transactionId.

Ответ
Content-Type: application/json

{
  "status": "TransactionAlreadyProcessed",
  "data": {
    "importId": "<Идентификатор первого импорта с этим transactionId>"
  }
}

Поле workItemId в ответе на повторный запрос не приходит. Чтобы найти задачу импорта в административной панели, сохраните workItemId из ответа на первый запрос.

Для импортов, поставленных до появления метода, поле data в ответе на повторный запрос может не прийти.

Запрос статуса импорта

Запрос статуса импорта
GET https://api.mindbox.ru/v3/operations/bulk/status?endpointId={endpointId}&importId={importId}

Authorization: SecretKey {Секретный ключ}
Accept: application/json

Параметры запроса

• endpointId — идентификатор точки интеграции проекта. Подойдет любая точка интеграции проекта, не обязательно та, через которую поставлен импорт.
• importId — идентификатор импорта из ответа на запрос импорта, в формате GUID.

Ответ о статусе импорта

Ответ
Content-Type: application/json

{
  "status": "Success",
  "importStatus": "<Статус импорта>",
  "failureReason": null,
  "rowsProcessed": 1000,
  "rowsWithErrors": 12,
  "rowsWithWarnings": 3
}

Счетчики строк приходят всегда. Для части операций импорта счетчики заполняются только после завершения импорта, поэтому пока импорт выполняется, в них может приходить 0.

Статусы импорта

Статусы Completed, CompletedWithValidationErrors и Failed — итоговые: после них статус импорта не меняется. Подробности по строкам с ошибками и предупреждениями смотрите в отчете по импорту в административной панели.

Ответ о статусе импорта (в случае отмены)

Ответ
Content-Type: application/json

{
  "status": "Success",
  "importStatus": "Failed",
  "failureReason": "<Причина отмены>",
  "rowsProcessed": 4500,
  "rowsWithErrors": 12,
  "rowsWithWarnings": 3
}

Счетчики показывают строки, обработанные до остановки импорта. Для части операций импорта счетчики заполняются только после завершения, поэтому при отмене в них может прийти 0, даже если часть строк уже обработана.

Импорт может быть не выполнен:

• если его отменили из административной панели;
• из-за внутренней ошибки;
• если файл импорта не удалось обработать.

Значение failureReason — текст для чтения человеком: формулировка зависит от операции импорта и языка проекта. Не используйте его для автоматической обработки, ориентируйтесь на importStatus.

Ошибки

Ответ
Content-Type: application/json

{
  "status": "ProtocolError",
  "errorMessage": "Import with ImportId='<importId>' not found.",
  "errorId": null,
  "httpStatusCode": 400
}