API를 통해 작업 상태 및 프라이빗 제품 세부 정보 검색
이 문서에는 파트너 센터 API를 통해 상태를 확인하고 프라이빗 제품 세부 정보를 검색하는 방법이 포함되어 있습니다.
기존 작업의 상태 쿼리
이 방법을 사용하여 기존 작업의 상태를 쿼리합니다. 최대 빈도가 분당 하나의 요청인 폴링 간격으로 기존 작업의 상태를 폴링할 수 있습니다.
요청
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
요청 헤더
| 헤더 | 형식 | 설명 |
|---|---|---|
| 권한 부여 | 문자열 | 필수입니다. 형식 Bearer <token>의 Microsoft Entra 액세스 토큰입니다. |
요청 매개 변수
- jobId – 필수 요소입니다 . 상태를 쿼리하려는 작업의 ID입니다. 프라이빗 제품을 만들기, 삭제, 철회 또는 업그레이드하기 위한 이전 요청 중에 만들어진 응답 데이터에서 사용할 수 있습니다.
- $version - 필수입니다. 요청에 사용되는 스키마의 버전입니다.
요청 본문
이 메서드에 사용할 수 있는 요청 본문이 없습니다.
Response
완료된 작업에 대한 세 가지 가능한 응답이 있습니다.
| 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가 없습니다.
Failure
{
"$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 또는 프라이빗 제품 ID가 있는지 여부에 따라 이를 수행하는 두 가지 방법이 있습니다.
요청
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
요청 헤더
| 헤더 | 형식 | 설명 |
|---|---|---|
| 권한 부여 | 문자열 | 필수입니다. 형식 Bearer <token>의 Microsoft Entra 액세스 토큰입니다. |
요청 매개 변수
ID - 필수입니다. 전체 세부 정보를 원하는 프라이빗 제품의 ID입니다. 이 ID는 jobId를 사용하여 기존 다중 파티 프라이빗 제품의 세부 정보를 얻기 위해 이전 요청 중에 생성된 응답 데이터에서 사용할 수 있습니다.
jobId - 필수입니다. 전체 세부 정보를 원하는 작업의 ID입니다. 이 ID는 프라이빗 제품을 만들기, 삭제, 철회 또는 업그레이드하기 위한 이전 요청 중에 만들어진 응답 데이터에서 사용할 수 있습니다.
$version - 필수입니다. 이는 요청에서 사용 중인 스키마의 버전입니다.
요청 본문
이 메서드에 대한 요청 본문을 제공하지 마세요.
Response
프라이빗 제품에 대한 전체 세부 정보를 받게 됩니다. 다음은 다중 파티 프라이빗 제안을 쿼리할 때 채널 파트너 호출자에 대한 예입니다.
{
"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 | 리소스를 찾을 수 없습니다. 요청에 올바른 ID를 사용하고 있는지 확인합니다. |