Stato del processo e recupero dei dettagli dell'offerta privata tramite API

Questo articolo include metodi per controllare lo stato e recuperare i dettagli dell'offerta privata tramite l'API del Centro per i partner.

Eseguire una query sullo stato di un processo esistente

Usare questo metodo per eseguire una query sullo stato di un processo esistente. È possibile eseguire il polling dello stato di un processo esistente con un intervallo di polling con una frequenza massima di una richiesta al minuto.

Richiedi

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

Intestazione della richiesta

Parametri della richiesta

• jobId : obbligatorio. ID del processo di cui si vuole eseguire una query sullo stato. È disponibile nei dati di risposta generati durante una richiesta precedente per creare, eliminare, ritirare o aggiornare un'offerta privata.
• $version : obbligatorio. Si tratta della versione dello schema in uso nella richiesta.

Corpo della richiesta

Per questo metodo non è disponibile alcun corpo della richiesta.

Response

Esistono tre possibili risposte per un processo completato:

Output di esempio

In esecuzione

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

Completato

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

Errore

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

Codici di errore

Ottenere i dettagli di un'offerta privata esistente

Esistono due metodi per eseguire questa operazione a seconda che si disponga dell'URI della risorsa o dell'ID offerta privata.

Richiedi

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

or

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

Intestazione della richiesta

Parametri della richiesta

• ID : obbligatorio. Si tratta dell'ID dell'offerta privata di cui si desidera ottenere i dettagli completi. Questo ID è disponibile nei dati di risposta generati durante una richiesta precedente per ottenere i dettagli di un'offerta privata multiparty esistente usando il jobId.

• jobId : obbligatorio. ID del processo di cui si desidera ottenere i dettagli completi. Questo ID è disponibile nei dati di risposta generati durante una richiesta precedente per creare, eliminare, ritirare o aggiornare un'offerta privata.

• $version : obbligatorio. Questa è la versione dello schema in uso nella richiesta

Corpo della richiesta

Non fornire un corpo della richiesta per questo metodo.

Response

Riceverai i dettagli completi dell'offerta privata. Di seguito è riportato un esempio per un chiamante partner di canale quando si esegue una query per un'offerta privata multiparty.

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

Codici di errore

Contenuto correlato

• Gestire le offerte private esistenti
• Risoluzione dei problemi e risorse aggiuntive