Taakstatus en details van privéaanbiedingen ophalen via API
Dit artikel bevat methoden om de status te controleren en details van privéaanbiedingen op te halen via de Partnercentrum-API.
De status van een bestaande taak opvragen
Gebruik deze methode om een query uit te voeren op de status van een bestaande taak. U kunt de status van een bestaande taak peilen met een polling-interval met een maximale frequentie van één aanvraag per minuut.
Aanvraag
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
Aanvraagheader
| Koptekst | Type | Description |
|---|---|---|
| Autorisatie | String | Vereist. Het Microsoft Entra-toegangstoken in het formulier Bearer <token>. |
Aanvraagparameters
- jobId : vereist. Dit is de id van de taak waarvan u de status wilt opvragen. Deze is beschikbaar in de antwoordgegevens die zijn gegenereerd tijdens een vorige aanvraag om een privéaanbieding te maken, te verwijderen, in te trekken of bij te werken.
- $version - vereist. Dit is de versie van het schema dat in de aanvraag wordt gebruikt.
Aanvraagtekst
Er is geen aanvraagbody beschikbaar voor deze methode.
Respons
Er zijn drie mogelijke antwoorden voor een voltooide taak:
| jobResult | Beschrijving |
|---|---|
| Wordt uitgevoerd | De taak is nog niet voltooid. |
| Geslaagd | De taak is voltooid Hiermee wordt ook een resource-URI geretourneerd die verwijst naar de aanbieding die betrekking heeft op de taak. Gebruik deze resourceURI om de volledige details van een aanbieding te verkrijgen. |
| Mislukt | De taak is mislukt. Hiermee worden ook eventuele relevante fouten geretourneerd om de oorzaak van de fout te bepalen. |
Voorbeelduitvoer
Wordt uitgevoerd
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": []
}
Geslaagd
{
"$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": []
}
Notitie
Als de taak is gemaakt door een aanvraag om een privéaanbieding te verwijderen, wordt er geen resource-URI in het antwoord weergegeven.
Mislukking
{
"$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"
}
]
}
Foutcodes
| Foutcode | Beschrijving |
|---|---|
| 401 | Verificatiefout: zorg ervoor dat u een geldig Microsoft Entra-toegangstoken gebruikt. |
Details verkrijgen van een bestaande privéaanbieding
Er zijn twee methoden om dit te doen, afhankelijk van of u de resource-URI of de id van de privéaanbieding hebt.
Aanvraag
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
Aanvraagheader
| Koptekst | Type | Description |
|---|---|---|
| Autorisatie | String | Vereist. Het Microsoft Entra-toegangstoken in het formulier Bearer <token>. |
Aanvraagparameters
Id - vereist. Dit is de id van de privéaanbieding waarvan u de volledige details wilt weten. Deze id is beschikbaar in de antwoordgegevens die tijdens een vorige aanvraag zijn gegenereerd om de details van een bestaande privéaanbieding met meerdere partijen te verkrijgen met behulp van de jobId.
jobId - vereist. Dit is de id van de taak waarvan u de volledige details wilt weten. Deze id is beschikbaar in de antwoordgegevens die zijn gegenereerd tijdens een vorige aanvraag voor het maken, verwijderen, intrekken of upgraden van een privéaanbieding.
$version - vereist. Dit is de versie van het schema dat wordt gebruikt in de aanvraag
Aanvraagtekst
Geef geen aanvraagbody op voor deze methode.
Respons
U ontvangt de volledige details van de privéaanbieding. Hier volgt een voorbeeld voor een beller van een kanaalpartner bij het uitvoeren van query's voor een privéaanbieding met meerdere partijen.
{
"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"
}
Foutcodes
| HTTP-statuscode | Beschrijving |
|---|---|
| 401 | Verificatiefout: zorg ervoor dat u een geldig Microsoft Entra-toegangstoken gebruikt. |
| 404 | Resource niet gevonden. Zorg ervoor dat u de juiste id in de aanvraag gebruikt. |