Sdílet prostřednictvím

Získání žádosti o export platby podle ID

  • Článek

Získá stav existujícího požadavku na export ve frontě.

Požadavek REST

GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}

Parametry požadavku

Name V Požaduje se Typ Description
requestId Dotaz Ano Identifikátor GUID ID žádosti o export

Hlavička požadavku

Name Požaduje se Typ Description
Autorizace Ano Řetězec Nosný autorizační token.
ms-correlationid No Řetězec Interní sledování požadavků. Každý požadavek vygeneruje nový sledovací modul (GUID).
ms-requestid No Řetězec ID idempotence požadavku.

Text požadavku

Není k dispozici.

Datová část odpovědi

Název Description
200 Přijato Žádost byla přijata.

Na základě požadavku může rozhraní API vrátit další standardní stav uvedený ve stavech odpovědí standardního rozhraní API:

Název Description
400 – Chybný požadavek Data chybí nebo jsou nesprávná.
401 – Neautorizováno Volající není ověřený a před prvním voláním se musí ověřit ve službě partnerského rozhraní API.
403 – Zakázáno Volající nemá oprávnění k podání žádosti.
500 – Vnitřní chyba serveru Rozhraní API nebo jedna z jeho závislostí nemůže požadavek splnit. Zkuste to později.
404 Nenalezeno Prostředek není k dispozici se vstupními parametry.
429 Omezování rychlosti Příliš mnoho požadavků stejného typu. Zkuste to po nějaké době.

Datová část odpovědi rozhraní API vrátí následující atributy:

Name Volitelné Description
Hodnota false (nepravda) Možné hodnoty a akce najdete v následující tabulce.

Možné hodnoty a akce

Hodnota Akce klienta
requestId ID žádosti o export
requestDateTime Počáteční datum a čas žádosti o export
cesta požadavku Zadejte dotaz na cestu požadavku na export.
requestQueryString Filtr použitý jako součást žádosti o export.
blobLocation Prostředek objektu blob s tokenem, když je soubor exportu připravený
Stav Stav operace exportu Projděte si následující seznam možných hodnot stavu.

Možné hodnoty stavu

  • Ve frontě: Operace exportu se nezačala.
  • Zpracování: Probíhá operace exportu.
  • Selhání: Operace exportu selhala po opakování. Zkuste zařadit nový požadavek do fronty.
  • Dokončeno: Operace exportu se dokončila a soubor exportu je připravený ke stažení.