Partager via

État du travail et récupération des détails de l’offre privée via l’API

  • Article

Cet article inclut des méthodes permettant de vérifier l’état et de récupérer les détails de l’offre privée via l’API espace partenaires.

Interroger l’état d’un travail existant

Utilisez cette méthode pour interroger l’état d’un travail existant. Vous pouvez interroger l’état d’un travail existant avec un intervalle d’interrogation d’une fréquence maximale d’une requête par minute.

Requête

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

En-tête de requête

En-tête Type Description
Autorisation Chaîne Obligatoire. Jeton d’accès Microsoft Entra dans le formulaire Bearer <token>.

Paramètres de la demande

  • jobId : obligatoire. Il s’agit de l’ID du travail dont vous souhaitez interroger l’état. Il est disponible dans les données de réponse générées lors d’une requête précédente pour créer, supprimer, retirer ou mettre à niveau une offre privée.
  • $version - obligatoire. Il s’agit de la version du schéma utilisé dans la requête.

Corps de la demande

Aucun corps de requête n’est disponible pour cette méthode.

Response

Il existe trois réponses possibles pour un travail terminé :

jobResult Description
Exécution Le travail n’est pas encore terminé.
Réussi La tâche s'est terminée avec succès. Cela renvoie également une ressourceURI qui fait référence à l’offre liée au travail. Utilisez cette ressourceURI pour obtenir les détails complets d’une offre.
Échec Le travail a échoué. Cela retourne également toutes les erreurs pertinentes pour vous aider à déterminer la cause de l’échec.

Exemples de sorties

En cours d’exécution

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

Succès

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

Remarque

Si le travail a été créé par une requête de suppression d’une offre privée, il n’y aura aucun ressourceURI dans la réponse.

Échec

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

Codes d’erreur

Code d'erreur Description
401 Erreur d’authentification : vérifiez que vous utilisez un jeton d’accès Microsoft Entra valide.

Obtenir les détails d’une offre privée existante

Il existe deux méthodes pour ce faire, selon que vous disposez de l’ID de ressource ou de l’offre privée.

Requête

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

En-tête de requête

En-tête Type Description
Autorisation Chaîne Obligatoire. Jeton d’accès Microsoft Entra dans le formulaire Bearer <token>.

Paramètres de la demande

  • ID : obligatoire. Il s’agit de l’ID de l’offre privée dont vous souhaitez obtenir les détails complets. Cet ID est disponible dans les données de réponse générées lors d’une demande précédente pour obtenir les détails d’une offre privée multipartie existante à l’aide du jobId.

  • jobId : obligatoire. Il s’agit de l’ID du travail dont vous souhaitez obtenir les détails complets. Cet ID est disponible dans les données de réponse générées lors d’une requête précédente pour créer, supprimer, retirer ou mettre à niveau une offre privée.

  • $version - obligatoire. Il s’agit de la version du schéma qui est utilisée dans la requête

Corps de la demande

Ne fournissez pas de corps de requête pour cette méthode.

Response

Vous recevrez les détails complets de l’offre privée. Voici un exemple d’appelant partenaire vendeur lors de l’interrogation d’une offre privée multipartie.

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

Codes d’erreur

Code d’état HTTP Description
401 Erreur d’authentification : vérifiez que vous utilisez un jeton d’accès Microsoft Entra valide.
404 La ressource est introuvable. Vérifiez que vous utilisez le bon ID dans la requête.

Étapes suivantes