Stan zadania i pobieranie szczegółów oferty prywatnej za pośrednictwem interfejsu API
Ten artykuł zawiera metody sprawdzania stanu i pobierania szczegółów oferty prywatnej za pośrednictwem interfejsu API Centrum partnerskiego.
Wykonywanie zapytań o stan istniejącego zadania
Użyj tej metody, aby wykonać zapytanie dotyczące stanu istniejącego zadania. Możesz sondować stan istniejącego zadania z interwałem sondowania z maksymalną częstotliwością jednego żądania na minutę.
Żądanie
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
Nagłówek żądania
| Nagłówek | Type | Opis |
|---|---|---|
| Autoryzacja | String | Wymagany. Token dostępu firmy Microsoft Entra w postaci Bearer <token>. |
Parametry żądania
- jobId — wymagane. Jest to identyfikator zadania, dla którego chcesz wykonać zapytanie o stan. Jest ona dostępna w danych odpowiedzi wygenerowanych podczas poprzedniego żądania utworzenia, usunięcia, wycofania lub uaktualnienia oferty prywatnej.
- $version — wymagane. Jest to wersja schematu używanego w żądaniu.
Treść żądania
Dla tej metody nie jest dostępna żadna treść żądania.
Response
Istnieją trzy możliwe odpowiedzi dla ukończonego zadania:
| jobResult | opis |
|---|---|
| Uruchomiono | Zadanie nie zostało jeszcze ukończone. |
| Powodzenie | Zadanie zostało ukończone pomyślnie. Spowoduje to również zwrócenie identyfikatora resourceURI, który odwołuje się do oferty powiązanej z zadaniem. Użyj tego identyfikatora resourceURI, aby uzyskać pełne szczegóły oferty. |
| Niepowodzenie | Zadanie nie powiodło się. Spowoduje to również zwrócenie wszelkich odpowiednich błędów, aby określić przyczynę awarii. |
Przykładowe dane wyjściowe
Uruchomiono
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": []
}
Powodzenie
{
"$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": []
}
Uwaga
Jeśli zadanie zostało utworzone przez żądanie usunięcia oferty prywatnej, w odpowiedzi nie będzie żadnych identyfikatorów resourceURI.
Błąd
{
"$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"
}
]
}
Kody błędów
| Kod błędu | opis |
|---|---|
| 401 | Błąd uwierzytelniania: upewnij się, że używasz prawidłowego tokenu dostępu firmy Microsoft Entra. |
Uzyskiwanie szczegółów istniejącej oferty prywatnej
Istnieją dwie metody, które należy wykonać w zależności od tego, czy masz identyfikator resourceURI, czy prywatny identyfikator oferty.
Żądanie
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15
lub
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15
Nagłówek żądania
| Nagłówek | Type | Opis |
|---|---|---|
| Autoryzacja | String | Wymagany. Token dostępu firmy Microsoft Entra w postaci Bearer <token>. |
Parametry żądania
Identyfikator — wymagane. Jest to identyfikator oferty prywatnej, której potrzebujesz, aby uzyskać pełne szczegóły. Ten identyfikator jest dostępny w danych odpowiedzi wygenerowanych podczas poprzedniego żądania w celu uzyskania szczegółów istniejącej oferty prywatnej z wieloma częściami przy użyciu identyfikatora jobId.
jobId — wymagane. Jest to identyfikator zadania, dla którego chcesz uzyskać pełne szczegóły. Ten identyfikator jest dostępny w danych odpowiedzi wygenerowanych podczas poprzedniego żądania utworzenia, usunięcia, wycofania lub uaktualnienia oferty prywatnej.
$version — wymagane. Jest to wersja schematu używanego w żądaniu
Treść żądania
Nie podaj treści żądania dla tej metody.
Response
Otrzymasz pełne szczegóły oferty prywatnej. Oto przykład dla rozmówców partnera kanału podczas wykonywania zapytań o ofertę prywatną z wieloma częściami.
{
"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"
}
Kody błędów
| Kod stanu HTTP | opis |
|---|---|
| 401 | Błąd uwierzytelniania: Upewnij się, że używasz prawidłowego tokenu dostępu firmy Microsoft Entra. |
| 404 | Nie znaleziono zasobu. Upewnij się, że używasz poprawnego identyfikatora w żądaniu. |