Dela via

Jobbstatus och hämta information om privata erbjudanden via API

  • Artikel

Den här artikeln innehåller metoder för att kontrollera status och hämta information om privata erbjudanden via Partnercenter-API:et.

Fråga efter status för ett befintligt jobb

Använd den här metoden för att fråga efter status för ett befintligt jobb. Du kan avsöka status för ett befintligt jobb med ett avsökningsintervall med en maximal frekvens på en begäran per minut.

Förfrågan

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01

Begärandehuvud

Header Typ Beskrivning
Auktorisering String Obligatoriskt. Microsoft Entra-åtkomsttoken i formuläret Bearer <token>.

Parametrar för begäran

  • jobId – krävs. Det här är ID:t för det jobb som du vill köra frågor mot statusen för. Den är tillgänglig i svarsdata som genererades under en tidigare begäran om att antingen skapa, ta bort, ta bort eller uppgradera ett privat erbjudande.
  • $version - krävs. Det här är den version av schemat som används i begäran.

Begärandetext

Ingen begärandetext är tillgänglig för den här metoden.

Response

Det finns tre möjliga svar för ett slutfört jobb:

jobResult beskrivning
Körs Jobbet har ännu inte slutförts.
Lyckades Jobbet slutfört framgångsrikt. Detta returnerar också en resourceURI som refererar till erbjudandet som är relaterat till jobbet. Använd den här resurs-URI:n för att hämta fullständig information om ett erbjudande.
Misslyckad Jobbet misslyckades. Detta returnerar även eventuella relevanta fel som hjälper dig att fastställa orsaken till felet.

Exempelutdata

Körs

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": []
}

Lyckades

{
    "$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": []
}

Kommentar

Om jobbet skapades av en begäran om att ta bort ett privat erbjudande kommer det inte att finnas någon resourceURI i svaret.

Fel

{
    "$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"
        }
    ]
}

Felkoder

Felkod beskrivning
401 Autentiseringsfel: Kontrollera att du använder en giltig Microsoft Entra-åtkomsttoken.

Få information om ett befintligt privat erbjudande

Det finns två metoder för att göra detta beroende på om du har resourceURI eller det privata erbjudande-ID:t.

Förfrågan

GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15

eller

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15

Begärandehuvud

Header Typ Beskrivning
Auktorisering String Obligatoriskt. Microsoft Entra-åtkomsttoken i formuläret Bearer <token>.

Parametrar för begäran

  • ID – krävs. Det här är ID:t för det privata erbjudandet som du vill ha fullständig information om. Det här ID:t är tillgängligt i svarsdata som genererades under en tidigare begäran för att få information om ett befintligt privat erbjudande för flera delar med hjälp av jobId.

  • jobId – krävs. Det här är ID:t för det jobb som du vill ha fullständig information om. Det här ID:t är tillgängligt i svarsdata som genererades under en tidigare begäran om att antingen skapa, ta bort, dra tillbaka eller uppgradera ett privat erbjudande.

  • $version - krävs. Det här är den version av schemat som används i begäran

Begärandetext

Ange ingen begärandetext för den här metoden.

Response

Du får fullständig information om det privata erbjudandet. Här är ett exempel för en kanalpartner som anropar när du frågar efter ett privat erbjudande för flera delar.

{
    "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"
}

Felkoder

HTTP-statuskod beskrivning
401 Autentiseringsfel: Kontrollera att du använder en giltig Microsoft Entra-åtkomsttoken.
404 Det gick inte att hitta resursen. Kontrollera att du använder rätt ID i begäran.

Relaterat innehåll