Status do trabalho e recuperação de detalhes da oferta privada via API
Este artigo inclui métodos para verificar o status e recuperar detalhes da oferta privada por meio da API do Partner Center.
Consultar o status de um trabalho existente
Use esse método para consultar o status de um trabalho existente. Você pode sondar o status de um trabalho existente com um intervalo de sondagem com uma frequência máxima de uma solicitação por minuto.
Solicitar
GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01
Cabeçalho da solicitação
| Cabeçalho | Tipo | Descrição |
|---|---|---|
| Autorização | String | Obrigatória. O token de acesso do Microsoft Entra no formato Bearer <token>. |
Parâmetros da solicitação
- jobId – obrigatório. Essa é a ID do trabalho do qual você deseja consultar o status. Ele está disponível nos dados de resposta gerados durante uma solicitação anterior para criar, excluir, retirar ou atualizar uma oferta privada.
- $version - obrigatório. Esta é a versão do esquema que está sendo usada na solicitação.
Corpo da solicitação
Nenhum corpo de solicitação está disponível para esse método.
Resposta
Existem três respostas possíveis para um trabalho concluído:
| jobResult | Descrição |
|---|---|
| Executando | O trabalho ainda não foi concluído. |
| Com sucesso | Operação concluída com sucesso. Isso também retorna um resourceURI que se refere à oferta relacionada ao trabalho. Use este resourceURI para obter os detalhes completos de uma oferta. |
| Com falha | Houve falha no trabalho. Isso também retornará quaisquer erros relevantes para ajudar a determinar a causa da falha. |
Saídas de exemplo
Executando
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": []
}
Com sucesso
{
"$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": []
}
Observação
Se o trabalho foi criado por uma solicitação para excluir uma oferta privada, não haverá resourceURI na resposta.
Falha
{
"$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 do Erro
| Código do erro | Descrição |
|---|---|
| 401 | Erro de autenticação: verifique se você está usando um token de acesso válido do Microsoft Entra. |
Obter detalhes de uma oferta privada existente
Existem dois métodos para fazer isso, dependendo de você ter o resourceURI ou o ID da oferta privada.
Solicitar
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
Cabeçalho da solicitação
| Cabeçalho | Tipo | Descrição |
|---|---|---|
| Autorização | String | Obrigatória. O token de acesso do Microsoft Entra no formato Bearer <token>. |
Parâmetros da solicitação
ID - obrigatório. Essa é a ID da oferta privada da qual você deseja obter todos os detalhes. Essa ID está disponível nos dados de resposta gerados durante uma solicitação anterior para obter os detalhes de uma oferta privada multipartidária existente usando o jobId.
jobId - obrigatório. Essa é a ID do trabalho do qual você deseja obter todos os detalhes. Essa ID está disponível nos dados de resposta gerados durante uma solicitação anterior para criar, excluir, retirar ou atualizar uma oferta privada.
$version - obrigatório. Esta é a versão do esquema que está sendo usado na solicitação
Corpo da solicitação
Não forneça um corpo de solicitação para este método.
Resposta
Você receberá todos os detalhes da oferta privada. Aqui está um exemplo para um chamador de parceiro de canal ao consultar uma oferta privada com vários participantes.
{
"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 do Erro
| Código de status HTTP | Descrição |
|---|---|
| 401 | Erro de autenticação: verifique se você está usando um token de acesso válido do Microsoft Entra. |
| 404 | Recurso não encontrado. Verifique se você está usando a ID correta na solicitação. |