Проверка состояния запроса

Проверьте информацию о ранее запрошенном файле с отчётом.

Входные данные

End-point

https://tracker.my.com/api/report/v1/file/get.json

Метод

GET

Параметры

Название Значение Описание
idReportFile * Целое число Уникальный идентификатор файла

* — обязательные параметры

Пример запроса

/api/report/v1/file/get.json?idReportFile=2

Форматы ответа

В случае успеха

Если запрос принят и обработан корректно, вы получите код ответа 200. Формат ответа будет зависеть от статуса выгрузки:

  • Если файл находится в процессе создания.
    Дополнительно доступна информация о прогрессе выгрузки в процентах progress:

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idReportFile": "2",
        "status": "In progress",
        "progress": "64%",
      }
    }
  • Если в процессе создания произошла ошибка и данный файл никогда не будет создан:

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idReportFile": "2",
        "status": "Error occurred"
      }
    }
  • Если файл с отчётом создан удачно.
    У файла есть временная метка timestamp — до этого времени файл будет доступен для скачивания:

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idReportFile": "2",
        "status": "Success!",
        "files": [
          {
            "link": "https://rawdata.hb.bizmrg.com/report/2021.01.01/2.8e8defceaf77a773550a8a011fb74b85.xlsx",
            "timestampExpires": "1609502400"
          }
        ]
      }
    }

Ошибки

Обращение к несуществующему файлу или к файлу, к которому у вас нет доступа, вызывает 404 ошибку:

{
  "code": 404,
  "message": "Not Found",
  "data": {
    "error": {
      "detail": "File Report request not found"
    }
  }
}

Ограничения

Данный метод требует авторизации. Вы получите код ответа 403, если сделаете запрос с невалидной авторизацией или не передадите её совсем.

{
  "code": 403,
  "message": "Access denied",
  "data": null
}