Поделиться через

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

  • Статья

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

Запрос REST

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

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

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

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

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

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

Недоступно

Полезные данные ответа

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

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

Имя Описание
400 — недопустимый запрос Отсутствуют или неверные данные.
401 — недостаточно прав Вызывающий объект не проходит проверку подлинности и должен пройти проверку подлинности в партнерской службе API перед первым вызовом.
403. Запрещено Вызывающий объект не авторизован для выполнения запроса.
500 Internal Server Error (внутренняя ошибка сервера) API или одна из его зависимостей не может выполнить запрос. Повторите попытку позже.
404 — не найдено Ресурс недоступен с входными параметрами.
429 Ограничение скорости Слишком много запросов одного типа. Попробуйте через некоторое время.

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

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

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

Значение Действие клиента
requestId Идентификатор запроса на экспорт.
requestDateTime Дата и время запуска запроса на экспорт.
requestPath Путь запроса к запросу на экспорт.
requestQueryString Фильтр, используемый в рамках запроса на экспорт.
blobLocation Ресурс большого двоичного объекта с маркером, когда файл экспорта будет готов.
Состояние Состояние операции экспорта. См. следующий список возможных значений состояния.

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

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