Auftragsstatus und Abrufen von Details zu privaten Angeboten über API
Dieser Artikel enthält Methoden zum Überprüfen des Status und Abrufen von Details zu privaten Angeboten über die Partner Center-API.
Abfragen des Status eines vorhandenen Auftrags
Verwenden Sie diese Methode, um den Status eines vorhandenen Auftrags abzufragen. Sie können den Status eines vorhandenen Auftrags mit einem Abrufintervall mit einer maximalen Häufigkeit von einer Anforderung pro Minute abfragen.
Anfordern
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
Anforderungsheader
| Header | Typ | Beschreibung |
|---|---|---|
| Autorisierung | String | Erforderlich. Das Microsoft Entra-Zugriffstoken im Formular Bearer <token>. |
Anforderungsparameter
- jobId – erforderlich. Dabei handelt es sich um die ID des Auftrags, dessen Status Sie abfragen möchten. Diese ID ist in den Antwortdaten verfügbar, die bei einer vorherigen Anforderung zum Erstellen, Löschen, Zurückziehen oder Upgraden eines privaten Angebots generiert wurden.
- $version – erforderlich. Dies ist die Version des Schemas, das in der Anforderung verwendet wird.
Anforderungstext
Für diese Methode ist kein Anforderungstext verfügbar.
Antwort
Es gibt drei mögliche Antworten für einen abgeschlossenen Auftrag:
| jobResult | Beschreibung |
|---|---|
| Wird ausgeführt | Der Auftrag wurde noch nicht abgeschlossen. |
| Erfolgreich | Der Auftrag wurde erfolgreich abgeschlossen. Dadurch wird auch ein Ressourcen-URI zurückgegeben, der auf das Angebot im Zusammenhang mit dem Auftrag verweist. Verwenden Sie diesen Ressourcen-URI, um die vollständigen Details eines Angebots abzurufen. |
| Fehler | Der Auftrag ist fehlgeschlagen. Dadurch werden auch relevante Fehler zurückgegeben, sodass Sie die Fehlerursache ermitteln können. |
Beispielausgabe
Wird ausgeführt
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": []
}
Erfolgreich
{
"$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": []
}
Hinweis
Wenn der Auftrag von einer Anforderung zum Löschen eines privaten Angebots erstellt wurde, enthält die Antwort keinen Ressourcen-URI.
Fehler
{
"$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"
}
]
}
Fehlercodes
| Fehlercode | BESCHREIBUNG |
|---|---|
| 401 | Authentifizierungsfehler: Stellen Sie sicher, dass Sie ein gültiges Microsoft Entra-Zugriffstoken verwenden. |
Abrufen von Details zu einem vorhandenen privaten Angebot
Hierfür gibt es zwei Methoden, je nachdem, ob Sie über den Ressourcen-URI oder die ID des privaten Angebots verfügen.
Anfordern
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15
oder
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15
Anforderungsheader
| Header | Typ | Beschreibung |
|---|---|---|
| Autorisierung | String | Erforderlich. Das Microsoft Entra-Zugriffstoken im Formular Bearer <token>. |
Anforderungsparameter
ID – erforderlich. Dabei handelt es sich um die ID des privaten Angebots, für das Sie die vollständigen Details abrufen möchten. Diese ID ist in den Antwortdaten verfügbar, die während einer vorherigen Anforderung generiert wurden, um die Details eines vorhandenen privaten Angebots mit mehreren Teilnehmern mithilfe der jobId abzurufen.
jobId - erforderlich. Dabei handelt es sich um die ID des Auftrags, für den Sie die vollständigen Details abrufen möchten. Diese ID ist in den Antwortdaten verfügbar, die bei einer vorherigen Anforderung zum Erstellen, Löschen, Zurückziehen oder Upgraden eines privaten Angebots generiert wurden.
$version – erforderlich. Dies ist die Version des Schemas, das in der Anforderung verwendet wird.
Anforderungstext
Geben Sie bei dieser Methode keinen Anforderungstext an.
Antwort
Sie erhalten die vollständigen Details des privaten Angebots. Hier ist ein Beispiel für einen Kanalpartneranrufer beim Abfragen eines privaten Angebots mit mehreren Teilnehmern.
{
"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"
}
Fehlercodes
| HTTP-Statuscode | Beschreibung |
|---|---|
| 401 | Authentifizierungsfehler: Stellen Sie sicher, dass Sie ein gültiges Microsoft Entra-Zugriffstoken verwenden. |
| 404 | Die Ressource wurde nicht gefunden. Stellen Sie sicher, dass Sie in der Anforderung die richtige ID verwenden. |