Stav úlohy a načtení podrobností o privátní nabídce prostřednictvím rozhraní API
Tento článek obsahuje metody pro kontrolu stavu a načtení podrobností o privátní nabídce prostřednictvím rozhraní API Partnerského centra.
Dotaz na stav existující úlohy
Tato metoda slouží k dotazování stavu existující úlohy. Můžete se dotazovat na stav existující úlohy s intervalem dotazování s maximální frekvencí jednoho požadavku za minutu.
Prosba
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
Hlavička požadavku
| Záhlaví | Typ | Popis |
|---|---|---|
| Oprávnění | Řetězec | Nutné. Přístupový token Microsoft Entra ve formátu Bearer <token>. |
Parametry požadavku
- id úlohy – povinné. Toto je ID úlohy, na kterou chcete dotazovat stav. Tato data jsou k dispozici v datech odpovědí vygenerovaných během předchozí žádosti o vytvoření, odstranění, odvolání nebo upgrade soukromé nabídky.
- $version – povinné. Toto je verze schématu, které se používá v požadavku.
Text požadavku
Pro tuto metodu není k dispozici žádný text požadavku.
Odpověď
U dokončené úlohy existují tři možné odpovědi:
| výsledek úlohy | Popis |
|---|---|
| Běhání | Úloha ještě nebyla dokončena. |
| Uspěl | Úloha byla úspěšně dokončena. Tím se také vrátí identifikátor resourceURI, který odkazuje na nabídku související s prací. Pomocí tohoto identifikátoru RESOURCEURI získáte úplné podrobnosti o nabídce. |
| Neúspěšný | Úloha se nezdařila. Tím se vrátí také všechny relevantní chyby, které vám pomůžou určit příčinu selhání. |
Ukázkové výstupy
Běh
JSON
{
"$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
"jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
"jobStatus": "running",
"jobResult": "pending",
"jobStart": "2021-12-21T21:29:54.9702903Z",
"jobEnd": "2021-12-21T21:30:10.3649551Z",
"errors": []
}
Uspěl
{
"$schema": " https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
"jobId": "b3f49dff-381f-480d-a10e-17f4ce49b65f",
"jobStatus": "completed",
"jobResult": "succeeded",
"jobStart": "2021-12-21T21:29:54.9702903Z",
"jobEnd": "2021-12-21T21:30:10.3649551Z",
"resourceUri": "https://product-ingestion.mp.microsoft.com/configure/b3f49dff-381f-480d-a10e-17f4ce49b65f",
"errors": []
}
Poznámka
Pokud úlohu vytvořila žádost o odstranění privátní nabídky, v odpovědi se nezobrazí žádný identifikátor resourceURI.
Selhání
{
"$schema": " https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
"jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
"jobStatus": "completed",
"jobResult": "failed",
"jobStart": "2021-12-21T21:29:54.9702903Z",
"jobEnd": "2021-12-21T21:30:10.3649551Z",
"errors": [
{
"code": "Conflict",
"message": "The start date should be defined"
}
]
}
Kódy chyb
| Kód chyby | Popis |
|---|---|
| 401 | Chyba ověřování: Ujistěte se, že používáte platný přístupový token Microsoft Entra. |
Získání podrobností o stávající privátní nabídce
Existují dvě metody, jak to provést v závislosti na tom, jestli máte identifikátor RESOURCEURI nebo ID privátní nabídky.
Prosba
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15
nebo
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15
Hlavička požadavku
| Záhlaví | Typ | Popis |
|---|---|---|
| Oprávnění | Řetězec | Povinné. Přístupový token Microsoft Entra ve formě Bearer <token>. |
Parametry požadavku
ID – povinné. Toto je ID privátní nabídky, o které chcete mít úplné podrobnosti. Toto identifikační číslo je k dispozici v datech odpovědi vygenerovaných během předchozího požadavku k získání podrobností o existující vícestranné privátní nabídce pomocí ID úlohy.
id úlohy – povinné. Toto je ID úlohy, o které chcete úplné podrobnosti. Toto ID je k dispozici v datech odpovědi vygenerovaných během předchozí žádosti o vytvoření, odstranění, odvolání nebo upgrade soukromé nabídky.
$version – povinné. Toto je verze schématu, které se používá v požadavku.
Tělo žádosti
Pro tuto metodu nezadávejte text požadavku.
Odpověď
Získáte úplné podrobnosti o privátní nabídce. Tady je příklad volajícího distribučního partnera při dotazování na vícestrannou soukromou nabídku.
{
"id": "private-offer/30b90a6a-df19-43cc-a107-b0c62057da6d",
"name": "mpo_api_test",
"privateOfferType": "multiPartyPromotionChannelPartner",
"offerPricingType": "editExistingOfferPricingOnly",
"variableStartDate": true,
"end": "2023-01-31",
"acceptBy": "2023-01-21",
"notificationContacts": [],
"state": "draft",
"originatorTermsAndConditionsDocs": [
{
"sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
"fileName": "test.pdf",
"customerFacingDocumentName": "test1"}],
"termsAndConditionsDocs": [],
"beneficiaries": [
{
"id": "ac357579-e860-54a6-80b3-66958aea67fe:7471d04e-f696-4d20-af34-fa78d51e419c_2019-05-31",
"description": "beneficiary Id"}],
"partners": [
{
"id": "12345678",
"partnerName": "Market Place Test",
"location": "United States" }],
"originatorPricing": [
{
"product": "product/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03",
"productName": "mpo_test_saas_site_1",
"plan": "plan/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03/570ebda0-467b-4ac3-a0d8-069131afd7ee",
"planName": "MPO Site 1 - LTS 2",
"discountType": "absolute",
"priceDetails": "price-and-availability-private-offer-plan/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03/2152924500014081860"},
{
"product": "product/6c73a19b-ba11-496c-b38b-1d4a3cc64d91",
"productName": "mpo_test_vmsr",
"plan": "plan/6c73a19b-ba11-496c-b38b-1d4a3cc64d91/24f34f12-df93-4a7b-93d7-d9336e02d44e",
"planName": "MPO VMSR 4",
"discountType": "percentage",
"discountPercentage": 2.0 }],
"lastModified": "2023-01-19",
"eTag": "\"7d02cb1b-0000-0800-0000-63c9aee80000\"",
"$schema": "https://schema.mp.microsoft.com/schema/private-offer/2023-07-15"
}
Kódy chyb
| Stavový kód HTTP | Popis |
|---|---|
| 401 | Chyba ověřování: Ujistěte se, že používáte platný přístupový token Microsoft Entra. |
| 404 | Zdroj nebyl nalezen. Ujistěte se, že v požadavku používáte správné ID. |