Estado del trabajo y recuperación de detalles de la oferta privada a través de la API
En este artículo se incluyen métodos para comprobar el estado y recuperar los detalles de la oferta privada a través de la API del Centro de partners.
Consulta del estado de un trabajo existente
Use este método para consultar el estado de un trabajo existente. Puede sondear el estado de un trabajo existente con un intervalo de sondeo con una frecuencia máxima de una solicitud por minuto.
Solicitar
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
Encabezado de solicitud
| Encabezado | Tipo | Descripción |
|---|---|---|
| Autorización | Cadena | Necesario. Token de acceso de Microsoft Entra con el formato Bearer <token>. |
Parámetros de solicitud
- jobId : obligatorio. Este es el identificador del trabajo del que desea consultar el estado. Está disponible en los datos de respuesta generados durante una solicitud anterior para crear, eliminar, retirar o actualizar una oferta privada.
- $version: obligatorio. Esta es la versión del esquema que se usa en la solicitud.
Cuerpo de la solicitud
No hay ningún cuerpo de solicitud disponible para este método.
Respuesta
Hay tres respuestas posibles para un trabajo completado:
| jobResult | Descripción |
|---|---|
| Ejecución | El trabajo aún no se ha completado. |
| Correcto | El trabajo se completó correctamente. Esto también devuelve un resourceURI que hace referencia a la oferta relacionada con el trabajo. Use este resourceURI para obtener los detalles completos de una oferta. |
| Con error | Se produjo un error en el trabajo. Esto también devolverá los errores pertinentes para ayudar a determinar la causa del error. |
Salidas de ejemplo
En ejecución
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": []
}
Correcto
{
"$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": []
}
Nota:
Si el trabajo se creó mediante una solicitud para eliminar una oferta privada, no habrá ningún resourceURI en la respuesta.
Error
{
"$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"
}
]
}
Códigos de error
| Código de error | Descripción |
|---|---|
| 401 | Error de autenticación: asegúrese de que usa un token de acceso válido de Microsoft Entra. |
Obtención de detalles de una oferta privada existente
Hay dos métodos para hacerlo en función de si tiene el identificador de recurso o el identificador de la oferta privada.
Solicitar
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15
o
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15
Encabezado de solicitud
| Encabezado | Tipo | Descripción |
|---|---|---|
| Autorización | Cadena | Necesario. Token de acceso de Microsoft Entra con el formato Bearer <token>. |
Parámetros de solicitud
Id. : obligatorio. Este es el identificador de la oferta privada de la que desea obtener todos los detalles. Este identificador está disponible en los datos de respuesta generados durante una solicitud anterior para obtener los detalles de una oferta privada de varias partes existente mediante jobId.
jobId : obligatorio. Este es el identificador del trabajo del que desea obtener los detalles completos. Este id. está disponible en los datos de respuesta generados durante una solicitud anterior para crear, eliminar, retirar o actualizar una oferta privada.
$version: obligatorio. Esta es la versión del esquema que se usa en la solicitud
Cuerpo de la solicitud
No incluyas un cuerpo de la solicitud para este método.
Respuesta
Recibirá los detalles completos de la oferta privada. Este es un ejemplo de un llamador de asociado de canal al consultar una oferta privada de varias partes.
{
"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"
}
Códigos de error
| Código de estado HTTP | Descripción |
|---|---|
| 401 | Error de autenticación: asegúrese de que usa un token de acceso válido de Microsoft Entra. |
| 404 | Recurso no encontrado. Asegúrese de que usa el identificador correcto en la solicitud. |