Получение запроса на экспорт заработка по ID

Возвращает статус существующего запроса на экспорт, находящегося в очереди.

Запрос REST

GET https://api.partner.microsoft.com/v1.0/payouts/transactionhistory/{transactionHistoryRequestId}

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

Имя В Обязательно Тип Описание
идентификатор запроса Запрос Верно Guid Идентификатор запроса экспорта

Заголовок запроса

Имя Обязательно Тип Описание
Авторизация Да Струна Маркер носителя авторизации.
ms-correlationid Нет Струна Внутреннее средство отслеживания запросов. Каждый запрос создает новый трекер (GUID).
ms-requestid Нет Струна Идентификатор идемпотентности запроса.

Текст запроса

N/A.

Пакет данных ответа

API возвращает состояние HTTP 200.

На основе запроса API может возвращать другое стандартное состояние, указанное в состояниях ответа API уровня "Стандартный":

Имя Описание
400 Недопустимый запрос Были обнаружены отсутствующие или неверные данные.
401 Несанкционированный доступ Вызывающая сторона не прошла аутентификацию и должна аутентифицироваться через API-службу партнера перед первым вызовом.
403 Запрещено Абонент не авторизован для выполнения запроса.
Ошибка внутреннего сервера 500 API или одна из его зависимостей не может выполнить запрос. Повторите попытку позже.
404 Не найдено Ресурс недоступен с входными параметрами.
Ограничение скорости 429 Слишком много запросов одного типа. Попробуйте через некоторое время.

В ответе API возвращаются следующие атрибуты:

Имя Необязательный Описание
Ценность ложный В следующей таблице приведены возможные значения и действия.

возможные значения и действия

Ценность Действие клиента
идентификатор запроса Идентификатор запроса на экспорт.
датаВремяЗапроса Дата начала запроса на экспорт.
путь запроса Путь запроса на экспорт.
requestQueryString Фильтр используется в рамках запроса на экспорт.
BLOBLocation Ресурс BLOB с токеном предоставляется, когда файл экспорта готов.
Статус Состояние операции экспорта. См. следующий список возможных значений для состояния.

Возможные значения для состояния

  • В очереди: операция экспорта не запущена
  • обработка: выполняется операция экспорта
  • сбой: операция экспорта не удалась после повторных попыток выполнить действие, попробуйте поставить в очередь новый запрос.
  • завершено: операция экспорта завершена, а файл экспорта готов к скачиванию.