API aracılığıyla iş durumu ve özel teklif ayrıntılarını alma

Bu makale, İş Ortağı Merkezi API'sini kullanarak durumu denetleme ve özel teklif ayrıntılarını alma yöntemlerini içerir.

Mevcut işin durumunu sorgulama

Mevcut bir işin durumunu sorgulamak için bu yöntemi kullanın. Dakikada en fazla bir istek sıklığına sahip yoklama aralığıyla var olan bir işin durumunu yoklayabilirsiniz.

İstek

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

İstek üst bilgisi

İstek parametreleri

• jobId – gerekli. Bu, durumunu sorgulamak istediğiniz işin kimliğidir. Özel teklif oluşturma, silme, geri çekme veya yükseltme isteği sırasında oluşturulan yanıt verilerinde kullanılabilir.
• $version - gerekli. Bu, istekte kullanılan şemanın sürümüdür.

Request body

Bu yöntem için kullanılabilir istek gövdesi yok.

Response

Tamamlanmış bir iş için üç olası yanıt vardır:

Örnek çıkışlar

Çalışıyor

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

Başarılı

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

Hata

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

Hata kodları

Mevcut bir özel teklifin ayrıntılarını alma

ResourceURI'nize veya özel teklif kimliğine sahip olmanıza bağlı olarak bunu yapmak için iki yöntem vardır.

İstek

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

veya

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

İstek üst bilgisi

İstek parametreleri

• Kimlik - gerekli. Bu, tüm ayrıntılarını öğrenmek istediğiniz özel teklifin kimliğidir. Bu kimlik, jobId kullanarak var olan çok bölümlü özel teklifin ayrıntılarını almak için önceki bir istek sırasında oluşturulan yanıt verilerinde kullanılabilir.

• jobId - gerekli. Bu, tüm ayrıntılarını istediğiniz işin kimliğidir. Bu kimlik, bir özel teklif oluşturma, silme, geri çekme veya yükseltme isteği sırasında oluşturulan yanıt verilerinde kullanılabilir.

• $version - gerekli. Bu, istekte kullanılan şemanın sürümüdür

Request body

Bu yöntem için istek gövdesi sağlama.

Response

Özel teklifin tüm ayrıntılarını alırsınız. Aşağıda, çok bölümlü özel bir teklifi sorgularken kanal iş ortağı arayanlara bir örnek verilmiştir.

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

Hata kodları

İlgili içerik

• Mevcut özel teklifleri yönetme
• Sorun giderme ve ek kaynaklar