作業狀態，並透過 API 擷取私人供應專案詳細數據
本文包含透過合作夥伴中心 API 檢查狀態和擷取私人供應專案詳細數據的方法。
查詢現有作業的狀態
使用這個方法來查詢現有作業的狀態。 您可以使用輪詢間隔輪詢現有作業的狀態，每分鐘最多一個要求的頻率。
Request
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
要求標頭
| 標題 | 類型 | 描述 |
|---|---|---|
| 授權 | String | 必要。 表單中的 Bearer <token>Microsoft Entra 存取令牌。 |
要求參數
- jobId – 必要。 這是您要查詢狀態之作業的識別碼。 其可在先前要求期間產生的響應數據中取得，以建立、刪除、撤銷或升級私人供應專案。
- $version - 必要。 這是要求中使用的架構版本。
要求本文
此方法沒有可用的要求本文。
回應
已完成作業有三個可能的回應：
| jobResult | 描述 |
|---|---|
| 執行中 | 作業尚未完成。 |
| 成功 | 作業已順利完成。 這也會傳回 resourceURI，參考與作業相關的供應專案。 使用此 resourceURI 來取得供應專案的完整詳細數據。 |
| 失敗 | 作業失敗。 這也會傳回任何相關的錯誤，以協助判斷失敗的原因。 |
範例輸出
執行中
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": []
}
成功
{
"$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": []
}
注意
如果作業是由刪除私人供應專案的要求所建立，則回應中將不會有任何 resourceURI。
失敗
{
"$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"
}
]
}
錯誤碼
| 錯誤碼 | 描述 |
|---|---|
| 401 | 驗證錯誤：請確定您使用有效的Microsoft Entra 存取令牌。 |
取得現有私人供應項目的詳細數據
根據您是否有 resourceURI 或私人供應專案標識碼，有兩種方法可以執行這項操作。
Request
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15
或
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15
要求標頭
| 標題 | 類型 | 描述 |
|---|---|---|
| 授權 | String | 必要。 表單中的 Bearer <token>Microsoft Entra 存取令牌。 |
要求參數
標識碼 - 必要。 這是您想要完整詳細數據的私人供應項目標識碼。 此標識碼可在先前要求期間產生的響應數據中取得，以使用jobId取得現有多方私人供應專案的詳細數據。
jobId - 必要。 這是您想要完整詳細數據的作業標識碼。 此標識碼可在先前要求期間產生的響應數據中取得，以建立、刪除、撤銷或升級私人供應專案。
$version - 必要。 這是要求中使用的架構版本
要求本文
請勿提供此方法的要求本文。
回應
您將會收到私人供應專案的完整詳細數據。 以下是在查詢多方私人供應專案時，通道合作夥伴呼叫端的範例。
{
"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"
}
錯誤碼
| HTTP 狀態碼 | 描述 |
|---|---|
| 401 | 驗證錯誤：請確定您使用有效的Microsoft Entra 存取令牌。 |
| 404 | 找不到資源。 請確定您在要求中使用正確的識別碼。 |