API para parceiros para soluções de negócios de IA e insights de segurança

Observação

Essa API fornece acesso ao relatório AI Business Solutions &Security Insights. Para todos os outros cenários de dados do Partner Center, consulte as APIs REST do Partner Center.

Visão geral

A API de Parceiros para Soluções de Negócios de IA & O Security Insights permite que os parceiros integrem seus sistemas CRM existentes com dados Microsoft, incluindo sinais de uso, propensão de venda alta, qualificação de incentivo, oportunidades de referência e outros insights importantes.

Antes de começar a codificar, examine a seção Introdução para as etapas necessárias para integrar e obter acesso à API.

Recursos adicionais estão disponíveis:

Detalhes de API

A API é uma API padrão formatada em REST acessível em https://m365partner.microsoft.com. Todos os pontos de acesso são prefixados por um número de versão. No momento, estamos em versões v1.3, portanto, as chamadas usam a seguinte URL base: https://m365partner.microsoft.com/abss/v{version}/api/.

Exemplo: https://m365partner.microsoft.com/abss/v1.3/api/timezones

Como começar

Conclua oFormulário de Integração da API de Parceiro.
- Deve ser concluído por um administrador global do Partner Center.
- Você receberá um email de confirmação depois que PXPartnerSupport@microsoft.com o processo de integração for concluído.
Utilize o Microsoft Graph Explorer para criar as entidades de serviço necessárias da API de Parceiro Microsoft 365 em seu locatário. Essa é uma configuração única necessária para concluir a integração.
1. Navegue até o Explorador do Graph.
2. Verifique se você está conectado usando uma conta com uma das seguintes funções do AD Azure:
  - Administrador global
  - Desenvolvedor de aplicativos
  - Administrador de Aplicativos
  - Administrador de Aplicativos na Nuvem
  - Administrador de Identidade Híbrida
Request 1: Microsoft 365 API de Parceiro

No Explorador do Graph:
1. Altere o método HTTP para POST.
2. Insira a seguinte URL:https://graph.microsoft.com/v1.0/servicePrincipals.
3. Selecione a guia Corpo da Solicitação e cole o seguinte JSON: "appId": "7b388e5c-7dea-4e0b-bc73-415971207918".
4. Em Modificar permissões, revise e conceda consentimento às permissões solicitadas.
5. Selecione Executar Consulta.
Example:

Solicitação 2: M365-Partner-API-Admin-App

Repita as mesmas etapas usando este Corpo da Solicitação:"appId": "c584e1eb-b862-4992-b2f7-c2a94b4331a0".

Ambas as solicitações devem ser executadas com êxito para provisionar os principais de serviço necessários em seu locatário.
Register um aplicativo no Microsoft Entra ID seguindo estas etapas:
- No portal do Azure, acesse Microsoft Entra ID >App registrations>Novo registro. Crie o aplicativo e conclua o registro.
Adicione permissões da API do Microsoft 365 Partner seguindo estas etapas:
1. Abra o registro do aplicativo e acesse permissões de API>Adicionar permissões>APIs que minha organização usa.
2. Pesquise por M365 Partner API.
3. Para acesso ao usuário, selecione Permissões delegadas; para acesso ao aplicativo, selecione permissões de aplicativo.
4. Selecione a permissão apropriada, selecione Adicionar permissões e conceda consentimento do administrador, se necessário.
Configure a autenticação seguindo estas etapas:
- No mesmo registro de aplicativo, abra a Autenticação, adicione sua URL de Redirecionamento e verifique se os tokens do Access estão habilitados.
https://management.m365partner.microsoft.com Acesse e adicione seu aplicativo à seção Gerenciamento de Aplicativos.

Authentication

Os tokens de acesso podem ser recuperados por meio de Microsoft Entra ID.

Em Microsoft Entra ID, configure seu aplicativo com a seguinte permissão com base em seu cenário:

Autenticação de Usuário: Api.Access
Autenticação de aplicativo (Entidade de Serviço): Api.Access.Application

Ao solicitar um token em seu cliente OAuth de escolha, solicite um token para o seguinte escopo (recurso):
https://m365partner.microsoft.com/.default.

Depois de ter o token de acesso, chame a API com o seguinte cabeçalho de autorização: Authorization: Bearer \<Access Token\>

Base URLs

https://m365partner.microsoft.com/abss/v1.3/api/

Limites de taxa e tratamento de erros

Limites de taxa

A taxa de API limita a atividade a 600 chamadas por minuto por usuário identificável (ou, se nenhum token de usuário estiver presente, por endereço IP).

Tratamento de erros

Todas as respostas de erro retornam um código de status HTTP no cabeçalho, além de detalhes de erro no seguinte formato:


{  
ErrorStatus: (400, 500, etc.)  
DependencyErrorCode: Optional structured error code from the dependency.  
Message: A descriptive message about the error that has occurred.  
}

O DependencyErrorCode normalmente fornece mais informações de depuração, geralmente como uma cadeia de caracteres simples. Para erros de 400 (validação), ele pode conter JSON estruturado descrevendo quais campos de entrada eram inválidos e por quê.

Example:


{  
"errors": {  
   "Email": [ "Invalid email address provided" ],  
   "ContactTypeId": [ "Contact Type is Required" ]  
},  
"errorStatus": 400,  
"message": "One or more validation errors occurred."  
}

Saída de exemplo

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants


Response Example (HTTP)  
Status: 200 OK  
{  
   "count": 2,  
   "hasMore": false,  
   "items": [  
    {  
      "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",  
      "tpid": 123,  
      "name": "Dummy Tenant 1",  
      "claimedWorkloads": [  
        {"id": 456, "name": "Dummy Workload 1"},  
        {"id": 789, "name": "Dummy Workload 2"}  
      ]  
   },  
   {  
      "tenantId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",  
      "tpid": 456,  
      "name": "Dummy Tenant 2",  
      "claimedWorkloads": [  
        {"id": 123, "name": "Dummy Workload 3"}  
      ]  
     }  
    ]  
   }

Support

Se você encontrar problemas com integração ou acesso à API, entre em contato com nossa equipe de suporte em:

Suporte a parceiros do AI Business Solutions &security Insights: PXPartnerSupport@microsoft.com

Inclua:

Nome do parceiro
IDs de MPN
A ID do locatário de sua associação ao programa
Uma breve descrição do seu problema

Operação de Endpoint

Oportunidades de Copilot

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/opportunities/copilot`	Oportunidades paginadas do Copilot (filtros e classificação)
GET	`/opportunities/copilot/tenantPenetration`	Locatários com vs sem Copilot
GET	`/opportunities/copilot/mciPotentialEarningsSummary`	Ganhos potenciais por tipo de engajamento MCI
GET	`/opportunities/copilot/filters/adoptionStatuses`	Status de adoção (Copilot)
GET	`/opportunities/copilot/filters/tenantCountries`	Países/regiões de locatários (Copilot)
GET	`/opportunities/copilot/adoptionSummary`	Resumo da classificação de saúde entre locatários
GET	`/opportunities/copilot/summary`	Pipeline, penetração, utilização, receita
GET	`/opportunities/copilot/usageByProductMonthlySnapshot`	Instantâneo mensal de Uso Ativo Mensal (MAU) licenciado, não licenciado e total
GET	`/opportunities/copilot/targetingScenarioSummary`	Resumo das oportunidades do Copilot por cenário de segmentação
GET	`/opportunities/copilot/filters/tenantSegments`	Segmentos de locatário disponíveis (Copilot)

Oportunidades

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/opportunities/categories/{opportunityCategoryId}/Workloads`	Oportunidades paginadas por workload para uma categoria específica (filtros/classificação – E3, E5, E5 exp)
GET	`/opportunities/MciEngagements`	Compromissos de MCI para determinados locatários/cargas de trabalho
GET	`/opportunities/categories`	Listar categorias de oportunidade (por exemplo, E3/E5/E5 exp)
GET	`/opportunities/categories/{opportunityCategoryId}/filters/PotentialWorkloads`	Cargas de trabalho potenciais para categoria
GET	`/opportunities/categories/{opportunityCategoryId}/filters/segments`	Segmentos de locatário válidos para categoria
GET	`/opportunities/categories/{opportunityCategoryId}/filters/tenantCountries`	Países/regiões de locatário válidos para categoria
GET	`/opportunities/categories/{opportunityCategoryId}/PotentialEarnings`	Ganhos potenciais por carga de trabalho
GET	`/opportunities/categories/{opportunityCategoryId}/TenantHealth`	Distribuição de saúde do locatário
GET	`/opportunities/categories/{opportunityCategoryId}/WorkloadHealth`	Distribuição da saúde da carga de trabalho
GET	`/opportunities/categories/{opportunityCategoryId}/WorkloadRecommendations`	Contagens de recomendações por carga de trabalho
GET	`/opportunities/categories/{opportunityCategoryId}/WorkloadUtilization`	Utilização de licença por carga de trabalho
GET	`/opportunities/categories/{opportunityCategoryId}/WorkloadWhitespace`	Espaço em branco por carga de trabalho
GET	`/opportunities/categories/{opportunityCategoryId}`	Resumo da categoria: contagens, saúde, ganhos
GET	`/opportunities/PotentialWorkloads`	Cargas de trabalho potenciais (global)
GET	`/opportunities/filters/segments`	Segmentos para MPNs do usuário atual
GET	`/opportunities/filters/tenantCountries`	Países/regiões de locatário para os MPNs do usuário atual

Referências

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/partnerReferrals`	Lista paginada de referências de parceiro (filtros/ordenação)
GET	`/partnerReferrals/AcceptanceStatuses`	Status de aceitação (consulta)
GET	`/partnerReferrals/DeclineReasons`	Razões de declínio (pesquisa)
GET	`/partnerReferrals/ReferralStatuses`	Status de referência (consulta)
GET	`/partnerReferrals/ServicesValues`	Intervalos de valores de serviço (consulta)
CORREÇÃO	`/partnerReferrals/{partnerReferralId}`	Aceitar/recusar ou atualizar uma indicação
GET	`/referralSources`	Listar fontes de referência disponíveis

Desempenho da MCI

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/mci/partnerPerformance`	Dados de desempenho do parceiro MCI
GET	`/mci/partnerPerformance/solutions/{mciSolution}`	Dados de desempenho do parceiro MCI para uma solução específica
GET	`/mci/partnerPerformance/summary`	Retorna um resumo do desempenho da MCI

Contatos

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/contactTypes`	Tipos de contato e IDs
GET	`/skillTypes`	Tipos de habilidades de contato
GET	`/surveyLanguages`	Idiomas de consulta para contatos
GET	`/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts`	Contatos de locatários por tipo de contato (paginado)
POST	`/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts`	Criar um contato de locatário
CORREÇÃO	`/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts/{contactId}`	Atualizar um contato de inquilino
DELETE	`/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts/{contactId}`	Excluir um contato de inquilino

Incentives

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/incentives/Programs`	Programas de incentivo
GET	`/incentives/Workloads`	Cargas de trabalho com IDs e informações do programa
GET	`/incentives/YearPeriods`	Períodos de ano com códigos e intervalos de datas
GET	`/incentives/Statements`	Pesquisar dados de declaração para o parceiro

Anotações

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/noteCategories`	Categorias de observação (pesquisa)
GET	`/tenants/{tenantId}/notes`	Notas de locatário (paginadas)
POST	`/tenants/{tenantId}/notes`	Criar uma nota de locatário
GET	`/partnerTenants/notes`	Anotações por locatário (em lote)

Dados do Partner Center

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/partnerCenter/summary`	Resumo do parceiro (IDs do MPN, sinalizadores, notificações)

Direitos

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/partnerTenants/maxEntitlements`	Máximo de informações de permissões por inquilino (em lote por IDs de inquilinos)
GET	`/tenants/{tenantId}/services/maxEntitlements`	Limite de licenças (contagem máxima de licenças permitidas) por serviço para inquilino
GET	`/entitlements/l1l2l3s`	Todas as combinações de serviço/L1/L2/L3
GET	`/entitlements/l1s`	Status de direito de nível superior (L1)
GET	`/entitlements/services/{serviceId}/l1s/{l1Id}/l2s`	Status L2 por serviço e L1
GET	`/entitlements/services/{serviceId}/l1s/{l1Id}/l2s/{l2Id}/l3s`	Status L3 por serviço/L1/L2
GET	`/tenants/{tenantId}/services/entitlements`	Status de elegibilidade do locatário (multi-serviço)
GET	`/tenants/{tenantId}/services/{serviceId}/entitlements`	Status de direito do locatário (serviço único)
CORREÇÃO	`/tenants/{tenantId}/services/{serviceId}/entitlements`	Atualizar todos os status de uma provisão de serviço

Identidade

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/currentUser`	Perfil de usuário autenticado e sinalizadores de acesso

Serviços e outras consultas

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/countryRegions`	Países/regiões e IDs
GET	`/services`	Todos os tipos de serviço (consulta)
GET	`/services/frp`	Serviços implementados por FRP (preferencial para listas suspensas)

Inquilinos

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/tenants/{tenantId}`	Informações básicas do locatário (tenantId, nome, TPID)
GET	`/tenants/{tenantId}/assignments`	Designações no nível de inquilino/serviço
GET	`/tenants/{tenantId}/subscriptions`	Assinaturas paginadas de tenant (filtros/classificação)
GET	`/partnerTenants`	Lista paginada de locatários com cargas de trabalho atribuídas
GET	`/partnerTenants/contactTypes/{contactTypeId}/contacts`	Contatos listados por tipo de contato entre diferentes locatários
GET	`/partnerTenants/entitlements`	Registros de direitos por locatário (em lote)
GET	`/partnerTenants/notes`	Anotações por locatário (em lote)
GET	`/partnerTenants/{tenantId}`	Detalhes de um único tenant parceiro

Uso atual e mpnids

Método	Endpoint (relativo a /abss/v1.3/api/)	Definição
GET	`/usage/current`	Uso atual para cargas de trabalho reclamadas e não reclamadas
GET	`/admin/mpnids`	Retorna as IDs do MPN registradas na Integração de Primeira Parte

Tipos de contato

Recupera uma lista de tipos de contato junto com suas IDs correspondentes.

GET https://m365partner.microsoft.com/abss/v1.3/api/contactTypes

Tipos de contato: parâmetros de URI

None

Tipos de contato: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Tipos de contato: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Tipos de contato: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

MPNIDs

GET https://m365partner.microsoft.com/abss/v1.3/api/admin/mpnIds

MPNIDs: parâmetros de URI

None

MPNIDs: Cabeçalho de Solicitação

Nome	Required	Tipo	Definição
Authorization	Verdade	cadeia	Token de portador de autorização

MPNIDs: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

MPNIDs: Definições

Nome	Tipo	Formato	Comprimento	Nullable
`<root>`	matriz			Não
`<array item>`	objeto			Não

Países/Regiões

Recupera uma lista de países/regiões junto com suas IDs correspondentes.

GET https://m365partner.microsoft.com/abss/v1.3/api/countryRegions

Países/Regiões: parâmetros de URI

None

Países/regiões: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Países/regiões: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Países/regiões: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Usuário Atual

Recupera os detalhes de perfil e acesso para o usuário do Partner Center autenticado no momento. Isso inclui informações básicas de identidade (nome, email, IDs), detalhes da função de parceiro e sinalizadores para permissões de acesso específicas

GET https://m365partner.microsoft.com/abss/v1.3/api/currentUser

Usuário Atual: parâmetros de URI

None

Usuário Atual: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Usuário Atual: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Usuário Atual: Definições

Nome	Tipo	Formato	Nullable	Enum
`<root>`	objeto		Não
`userName`	cadeia		Yes
`userEmail`	cadeia		Yes
`userId`	cadeia		Yes
`tenantId`	cadeia		Yes
`userType`	inteiro	int32	Não	0, 1, 2, 3, 4
`isFrp`	boolean		Não
`hasWoboAccess`	boolean		Não
`hasPortalAccess`	boolean		Não
`mpnIds`	matriz		Yes
`<array item>`	cadeia		Não

Períodos do ano

Recupera uma lista de períodos de ano disponíveis, cada um com uma ID de período de ano exclusiva, um código de período numérico e um intervalo de datas legível por humanos.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/YearPeriods

Períodos de ano: parâmetros de URI

None

Períodos de ano: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Períodos do ano: respostas

Nome	Definição
200 OK	Solicitação bem-sucedida. O corpo da resposta contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	Solicitação não autenticada. O cliente precisa se autenticar com o serviço de API do parceiro primeiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	Solicitação autenticada, mas recusada, pois o chamador não tem direitos de invocar. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	Recurso não encontrado ou não disponível com determinados parâmetros de entrada. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou as dependências falharam ao atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Períodos de ano: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`yearPeriod`	inteiro	int32	Não
`yearPeriodRange`	cadeia		Yes

Programas

Recupera uma lista de programas junto com suas IDs correspondentes.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/Programs

Programas: Parâmetros de URI

None

Programas: Cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Programas: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Programas: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Workloads

Recupera uma lista de cargas de trabalho, cada uma com ID, nome de exibição e programa associado.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/Workloads

Cargas de trabalho: parâmetros de URI

None

Cargas de trabalho: cabeçalho de requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Cargas de trabalho: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, '

Cargas de trabalho: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`workloadId`	inteiro	int32	Não
`name`	cadeia		Yes
`program`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Statements

Pesquisa os dados de extrato para o Parceiro.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/Statements

Declarações: Parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`PaymentPeriodIds`	CONSULTA	Não	matriz	Não
`Tenants`	CONSULTA	Não	matriz	Não
`ProgramIds`	CONSULTA	Não	matriz	Não

Declarações: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Declarações: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, `text

Declarações: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`programMembershipId`	cadeia	identificador único universal (UUID)	Yes
`partnerName`	cadeia		Yes
`yearPeriod`	objeto		Não
`id`	inteiro	int32	Não
`yearPeriod`	inteiro	int32	Não
`yearPeriodRange`	cadeia		Yes
`transactions`	matriz		Yes
`<array item>`	objeto		Não
`mpnId`	cadeia		Yes
`recordId`	cadeia		Yes
`transactionId`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Yes
`tenantName`	cadeia		Yes
`program`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`workload`	objeto		Não
`workloadId`	inteiro	int32	Não
`name`	cadeia		Yes
`program`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`milestone`	cadeia		Yes
`milestoneDate`	cadeia	date-time	Yes
`atClaimUsage`	número	duplo	Yes
`milestoneUsage`	número	duplo	Não
`payableGrowth`	inteiro	int32	Yes
`previousPaymentUSD`	número	duplo	Yes
`rateUSD`	número	duplo	Yes
`paymentUSD`	número	duplo	Yes
`paymentLocal`	número	duplo	Yes
`localCurrency`	cadeia		Yes
`localCurrencySymbol`	cadeia		Yes
`disputeCaseNumber`	cadeia		Yes
`totalPaidUSD`	número	duplo	Não
`totalPaidLocal`	número	duplo	Não

Categorias de Notas

Recupera uma lista de categorias de notas com uma ID associada.

GET https://m365partner.microsoft.com/abss/v1.3/api/noteCategories

Categorias de Notas: parâmetros de URI

None

Categorias de Observação: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Categorias de Observação: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar isso: Tipos de mídia: application/json, text/plain, text/json

Categorias de Observação: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Categorias

Recupera uma lista de categorias de oportunidade com seus IDs de categoria (por exemplo, E3, E5, Expansão E5).

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories

Categorias: parâmetros de URI

None

Categorias: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Categorias: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain,

Categorias: Definições

Nome	Tipo	Nullable	Definição
`<root>`	matriz	Não
`<array item>`	objeto	Não	Descreve uma categoria específica para oportunidades para parceiros, como E3, E5 etc.
`categoryId`	cadeia	Yes	O ID da categoria para uso por chamadas à API
`categoryName`	cadeia	Yes	O nome amigável da categoria

ID da categoria de oportunidade

Retorna a contagem de oportunidades de categoria, utilização de licença, capacidade ociosa, métricas de locatário, ganhos potenciais e detalhes de categoria para uma categoria específica (por exemplo, E3, E5, Expansão E5).

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}

Identificador da categoria de oportunidade: parâmetros URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia		Não	O ID da categoria de oportunidade para obter o resumo

ID da categoria de oportunidade: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Categoria de ID de Oportunidade: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu cumprir conforme o esperado.

ID da Categoria de Oportunidade: Definições

Nome	Tipo	Nullable	Definição
`<root>`	objeto	Não	Descreve uma categoria específica para oportunidades de parceiro, como E3, E6 etc.
`categoryOpportunityCount`	inteiro
`SeatUtilization`	inteiro
`WhiteSpace`	inteiro
`upsellReadyTenants`	inteiro
`lowUsageTenants`	inteiro
`atRiskTenants`	inteiro
`upcomingRenewalTenants`	inteiro
`incentiveEligibleTenants`	inteiro
`potentialEarnings`	inteiro
`categoryId`	cadeia	Yes	O ID da categoria para uso em chamadas de API.
`categoryName`	cadeia	Yes	O nome amigável da categoria.

Utilização da carga de trabalho

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadUtilization

Utilização da carga de trabalho: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia	Não	A ID da categoria de oportunidade para a qual recuperar dados de utilização.
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para IDs de carga de trabalho.
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para recomendações de carga de trabalho.
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estado de saúde da carga de trabalho.
`lXPClaimFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de reivindicações.
`requirePotentialEarnings`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir ganhos potenciais.
`requireSeatWhitespace`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir espaços em branco em licenças.
`requireOpportunityUnits`	CONSULTA	Não	boolean	Não	Filtro opcional para requerer unidades de oportunidade.
`usageThresholdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para limites de uso.
`tenantSegmentFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para segmentos de locatário.
`tenantCountryFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para países/regiões de locatário.
`lXPTenantStateFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estados de locatário.
`searchTerm`	CONSULTA	Não	cadeia	Não	Termo de pesquisa opcional para filtrar resultados.
`eaRenewalDateFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para a data de renovação do EA.
`mciEligibilityFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para elegibilidade de MCI.
`requireIncentiveEligible`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir qualificação de incentivo.

Utilização de carga de trabalho: cabeçalho de requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Utilização da carga de trabalho: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Utilização da carga de trabalho: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes	ID da categoria para uso por chamadas de API
`categoryName`	cadeia		Yes	Nome amigável da categoria
`workloadId`	inteiro	int32	Não	ID da carga de trabalho
`workloadName`	cadeia		Yes	Nome da carga de trabalho
`workloadUtilization`	número	duplo	Não	Percentual de licenças utilizadas

Espaço em branco da carga de trabalho

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadWhitespace

Workload Whitespace: parâmetros de URI

Nome	Localidade	Required	Tipo	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz
`lXPClaimFilter`	CONSULTA	Não	matriz
`requirePotentialEarnings`	CONSULTA	Não	boolean
`requireSeatWhitespace`	CONSULTA	Não	boolean
`requireOpportunityUnits`	CONSULTA	Não	boolean
`usageThresholdFilter`	CONSULTA	Não	matriz
`tenantSegmentFilter`	CONSULTA	Não	matriz
`tenantCountryFilter`	CONSULTA	Não	matriz
`lXPTenantStateFilter`	CONSULTA	Não	matriz
`searchTerm`	CONSULTA	Não	cadeia
`eaRenewalDateFilter`	CONSULTA	Não	cadeia	Filtro de calendário para resultados.
`mciEligibilityFilter`	CONSULTA	Não	cadeia	Filtro elegível/não elegível para resultados.
`requireIncentiveEligible`	CONSULTA	Não	boolean

Espaço Vazio da Carga de Trabalho: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Espaço em branco da carga de trabalho: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo da resposta contém as informações requeridas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json

Espaço em branco da carga de trabalho: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes	O ID da categoria para uso em chamadas de API.
`categoryName`	cadeia		Yes	O nome amigável da categoria.
`workloadId`	inteiro	int32	Não	A ID da carga de trabalho.
`workloadName`	cadeia		Yes	O nome da carga de trabalho.
`workloadWhitespace`	inteiro	int64	Não

Saúde da Carga de Trabalho

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadHealth

Integridade da carga de trabalho: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia	Não	O ID da categoria de oportunidade para a qual recuperar dados de saúde da carga de trabalho.
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para IDs de carga de trabalho.
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para recomendações de carga de trabalho.
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estado de saúde da carga de trabalho.
`lXPClaimFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de reivindicações.
`requirePotentialEarnings`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir ganhos potenciais.
`requireSeatWhitespace`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir espaços em branco em licenças.
`requireOpportunityUnits`	CONSULTA	Não	boolean	Não	Filtro opcional para requerer unidades de oportunidade.
`usageThresholdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para limites de uso.
`tenantSegmentFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para segmentos de locatário.
`tenantCountryFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para países/regiões de locatário.
`lXPTenantStateFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estados de locatário.
`searchTerm`	CONSULTA	Não	cadeia	Não	Termo de pesquisa opcional para filtrar resultados.
`eaRenewalDateFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para a data de renovação do EA.
`mciEligibilityFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para elegibilidade de MCI.
`requireIncentiveEligible`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir qualificação de incentivo.

Saúde da Carga de Trabalho: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Saúde da Carga de Trabalho: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Saúde da carga de trabalho: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes	O ID da categoria para uso em chamadas de API.
`categoryName`	cadeia		Yes	O nome amigável da categoria.
`workloadHealth`	cadeia		Yes
`healthPercentage`	número	duplo	Não

Estado de Saúde do Locatário

Retorna a distribuição de saúde do inquilino dentro de uma categoria de oportunidade.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/TenantHealth

Saúde do Locatário: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia	Não	ID da categoria de oportunidade para recuperar dados de saúde do locatário
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para IDs de carga de trabalho
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para recomendações de carga de trabalho
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de saúde da carga de trabalho
`lXPClaimFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de reivindicações
`requirePotentialEarnings`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir ganhos potenciais
`requireSeatWhitespace`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir espaço em branco de licença
`requireOpportunityUnits`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir unidades de oportunidade
`usageThresholdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para limites de uso
`tenantSegmentFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para segmentos de cliente
`tenantCountryFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para países/regiões de locatário
`lXPTenantStateFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estados de locatário.
`searchTerm`	CONSULTA	Não	cadeia	Não	Termo de pesquisa opcional para filtragem de resultados
`eaRenewalDateFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para a data de renovação do contrato EA
`mciEligibilityFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para elegibilidade de MCI
`requireIncentiveEligible`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir elegibilidade de incentivo

Saúde do Locatário: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Saúde do locatário: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Saúde do locatário: definições

Nome	Tipo	Formato	Nullable	Enum	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes		ID da categoria para uso por chamadas de API
`categoryName`	cadeia		Yes		Nome amigável da categoria
`tenantHealth`	cadeia		Não	ProntoParaUp-sell, EmRisco, BaixoUso
`healthPercentage`	número	duplo	Não

Recomendações de carga de trabalho

Retorna uma lista de recomendações de carga de trabalho dentro da categoria de oportunidade especificada, com a contagem de recomendações para cada uma.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadRecommendations

Recomendações de carga de trabalho: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia	Não	ID da categoria de oportunidade para recuperar recomendações de carga de trabalho
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para IDs de carga de trabalho
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para recomendações de carga de trabalho
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de saúde da carga de trabalho
`lXPClaimFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de reivindicações
`requirePotentialEarnings`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir ganhos potenciais
`requireSeatWhitespace`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir espaço em branco de licença
`requireOpportunityUnits`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir unidades de oportunidade
`usageThresholdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para limites de uso
`tenantSegmentFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para segmentos de cliente
`tenantCountryFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para locatário /regiões
`lXPTenantStateFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estados de locatário
`searchTerm`	CONSULTA	Não	cadeia	Não	Termo de pesquisa opcional para filtragem de resultados
`eaRenewalDateFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para a data de renovação do contrato EA
`mciEligibilityFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para elegibilidade de MCI
`requireIncentiveEligible`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir elegibilidade de incentivo

Recomendações de carga de trabalho: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Recomendações de carga de trabalho: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Recomendações de carga de trabalho: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes	O ID da categoria para uso em chamadas de API.
`categoryName`	cadeia		Yes	O nome amigável da categoria.
`workloadRecommendation`	cadeia		Yes
`recommendationCount`	inteiro	int32	Não

Ganhos potenciais

Retorna os ganhos potenciais para cada carga de trabalho dentro de uma categoria de oportunidade especificada.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/PotentialEarnings

Ganhos potenciais: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia	Não	A ID da categoria de oportunidade para a qual recuperar possíveis dados de ganhos.
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para IDs de carga de trabalho.
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para recomendações de carga de trabalho.
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estado de saúde da carga de trabalho.
`lXPClaimFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para status de reivindicações.
`requirePotentialEarnings`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir ganhos potenciais.
`requireSeatWhitespace`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir espaços em branco em licenças.
`requireOpportunityUnits`	CONSULTA	Não	boolean	Não	Filtro opcional para requerer unidades de oportunidade.
`usageThresholdFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para limites de uso.
`tenantSegmentFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para segmentos de locatário.
`tenantCountryFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para países/regiões de locatário.
`lXPTenantStateFilter`	CONSULTA	Não	matriz	Não	Filtro opcional para estados de locatário.
`searchTerm`	CONSULTA	Não	cadeia	Não	Termo de pesquisa opcional para filtrar resultados.
`eaRenewalDateFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para a data de renovação do EA.
`mciEligibilityFilter`	CONSULTA	Não	cadeia	Não	Filtro opcional para elegibilidade de MCI.
`requireIncentiveEligible`	CONSULTA	Não	boolean	Não	Filtro opcional para exigir qualificação de incentivo.

Ganhos potenciais: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Ganhos potenciais: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Ganhos potenciais: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes	O ID da categoria para uso em chamadas de API.
`categoryName`	cadeia		Yes	O nome amigável da categoria.
`workloadId`	inteiro	int32	Não	A ID da carga de trabalho.
`workloadName`	cadeia		Yes	O nome da carga de trabalho.
`potentialEarnings`	número	duplo	Não	O potencial de ganhos da carga de trabalho.

Oportunidades de carga de trabalho

Recupera uma lista paginada de cargas de trabalho para uma categoria de oportunidade específica, com filtragem, classificação e paginação opcionais.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/Workloads

Oportunidades de carga de trabalho: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia		Não	O ID da categoria de oportunidade para a qual obter cargas de trabalho.
`page`	CONSULTA	Não	inteiro	int32	Não	O número da página para paginação (opcional).
`pageSize`	CONSULTA	Não	inteiro	int32	Não	O número de itens por página para paginação (opcional).
`lXPWorkloadIdFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para IDs de carga de trabalho.
`lxpWorkloadRecommendationFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para recomendações de carga de trabalho.
`lxpWorkloadHealthFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para estado de saúde da carga de trabalho.
`lXPClaimFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para status de reivindicações.
`requirePotentialEarnings`	CONSULTA	Não	boolean		Não	Filtro opcional para exigir ganhos potenciais.
`requireSeatWhitespace`	CONSULTA	Não	boolean		Não	Filtro opcional para exigir espaços em branco em licenças.
`requireOpportunityUnits`	CONSULTA	Não	boolean		Não	Filtro opcional para requerer unidades de oportunidade.
`usageThresholdFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para limites de uso.
`tenantSegmentFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para segmentos de locatário.
`tenantCountryFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para países/regiões de locatário.
`lXPTenantStateFilter`	CONSULTA	Não	matriz		Não	Filtro opcional para estados de locatário.
`searchTerm`	CONSULTA	Não	cadeia		Não	Termo de pesquisa opcional para filtrar resultados.
`sortColumn`	CONSULTA	Não	cadeia		Não	Nome de coluna opcional para classificar por.
`sortDirection`	CONSULTA	Não	cadeia		Não	Direção de classificação opcional (crescente ou decrescente).
`eaRenewalDateFilter`	CONSULTA	Não	cadeia		Não	Filtro opcional para a data de renovação do EA.
`mciEligibilityFilter`	CONSULTA	Não	cadeia		Não	Filtro opcional para elegibilidade de MCI.
`requireIncentiveEligible`	CONSULTA	Não	boolean		Não	Filtro opcional para exigir qualificação de incentivo.

Oportunidades de carga de trabalho: Cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Oportunidades de carga de trabalho: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Oportunidades de carga de trabalho: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	objeto		Não	Uma classe que representa dados paginados da API.
`rfaId`	inteiro	int32	Yes	O RFAID associado à solicitação, se houver.
`count`	inteiro	int32	Não	O número total de itens disponíveis no conjunto de dados.
`hasMore`	boolean		Não	Indicar se há mais dados a serem recuperados.
`items`	matriz		Yes	Os itens incluídos na página.
`<array item>`	objeto		Não
`categoryId`	cadeia		Yes	O ID da categoria para uso em chamadas de API.
`categoryName`	cadeia		Yes	O nome amigável da categoria.
`workloadId`	inteiro	int32	Não	A ID da carga de trabalho.
`workloadName`	cadeia		Yes	O nome da carga de trabalho.
`tenantId`	cadeia	identificador único universal (UUID)	Não	A ID do Locatário que contém a carga de trabalho.
`tpid`	inteiro	int32	Yes	O TPID para o Locatário
`tenantName`	cadeia		Yes	O nome do locatário que administra a carga de trabalho.
`tenantDomain`	cadeia		Yes	O domínio do locatário
`tenantParentSegment`	cadeia		Yes	Segmento de locatário
`mau`	inteiro	int64	Yes	Uso ativo mensal
`pau`	inteiro	int64	Yes	Uso ativo potencial
`seatWhitespace`	inteiro	int64	Yes	A quantidade calculada de licenças não utilizados disponíveis.
`opportunityUnits`	inteiro	int32	Yes	A quantidade calculada de unidades de oportunidade disponíveis.
`usageThreshold`	cadeia		Yes	Obtém e define o estado do limite de uso.
`usagePercent`	número	duplo	Yes	O percentual de uso.
`tippingPoint`	número	duplo	Yes	O percentual de ponto de inflexão de uso.
`workloadRecommendation`	cadeia		Yes	A recomendação para a carga de trabalho, se houver.
`workloadHealth`	cadeia		Yes	Representa a saúde da carga de trabalho. Ele pode conter um valor de cadeia de caracteres ou ser nulo.
`claimStatus`	cadeia		Não	O status de solicitação associado a uma carga de trabalho de inquilino.
`claimId`	inteiro	int32	Yes	O ID da reivindicação do parceiro na carga de trabalho, se houver.
`claimedByOthers`	boolean		Não	Sinalizador marcado se a carga de trabalho tiver sido reivindicada por outro parceiro.
`startingHWM`	inteiro	int32	Yes	O Highwater Mark no primeiro mês em que a carga de trabalho estava ativa.
`priorHWM`	inteiro	int32	Yes	A Marca de Água Alta para o período/mês anterior.
`cporPotentialEarnings`	número	duplo	Yes	Ganhos potenciais somente do CPOR
`mciPotentialEarnings`	número	duplo	Yes	Os Ganhos Potenciais do Workshop MCI.
`totalPotentialEarnings`	número	duplo	Yes	O total de ganhos potenciais disponíveis associados à carga de trabalho, se houver.
`resourceName`	cadeia		Yes	Nome do link para obter ajuda com essa carga de trabalho, se houver.
`resourceLink`	cadeia		Yes	URL do link de ajuda para a carga de trabalho, se houver.
`claimWorkloadLink`	cadeia		Yes	URL para os usuários reivindicarem a carga de trabalho se ela não for reclamada.
`customerName`	cadeia		Yes	O nome do cliente que possui a carga de trabalho.
`customerParentSegment`	cadeia		Yes	Segmento de cliente
`customerCountry`	cadeia		Yes	O país/região do cliente
`tenantCountry`	cadeia		Yes	O país/região do locatário
`eaRenewalDate`	cadeia	date-time	Yes	A data de renovação do Enterprise Agreement (EA) do cliente
`eligibleMciEngagements`	inteiro	int32	Não	Os compromissos qualificados para essa combinação de locatário, parceiro e carga de trabalho.
`hasEnrolledEngagements`	boolean		Não	Se há engajamentos declarados para essa combinação de locatário, parceiro e carga de trabalho.
`advancedDeploymentGuideName`	cadeia		Yes	O nome de um guia de implantação avançado para essa carga de trabalho, se houver.
`advancedDeploymentGuideLink`	cadeia		Yes	URL para um guia de implantação avançado para essa carga de trabalho, se houver.
`ratePerUnit`	inteiro	int32	Yes	A taxa de compensação por unidade de direitos
`maxCompUnits`	inteiro	int32	Yes	Unidades compensáveis máximas para a carga de trabalho.

Países/Regiões do Locatário – categoria de oportunidade

Obtém uma lista de países/regiões de locatário relevantes para uma categoria de oportunidade específica.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/filters/tenantCountries

Países/Regiões do Locatário – categoria de oportunidade: parâmetros de URI

Nome	Definição
200 OK	Solicitação bem-sucedida. O corpo da resposta contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	Solicitação não autenticada. O cliente precisa se autenticar com o serviço de API do parceiro primeiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	Solicitação autenticada, mas recusada, pois o chamador não tem direitos de invocar. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	Recurso não encontrado ou não disponível com parâmetros de entrada. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou as dependências falharam ao atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Países/Regiões do Locatário – categoria de oportunidade: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Países/Regiões do Locatário – categoria de oportunidade: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Países/Regiões do Locatário – categoria de oportunidade: Definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	cadeia		Não	Nome de um país/região (por exemplo, "United States", "Alemanha")

Segmentos

Retorna uma lista de nomes de segmento de locatário para a categoria de oportunidade especificada.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/filters/segments

Segmentos: Parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
`opportunityCategoryId`	Caminho	Yes	cadeia	Não	ID da categoria de oportunidade

Segmentos: Cabeçalho de requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Segmentos: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Segmentos: Definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	cadeia		Não	Nome do segmento de locatário (por exemplo, "SMC", "Enterprise")

Cargas de trabalho potenciais – oportunidade específica

Retorna uma lista de cargas de trabalho potenciais para uma categoria de oportunidade específica.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/filters/PotentialWorkloads

Cargas de trabalho potenciais – oportunidade específica: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable	Definição
idCategoriaOportunidade	Caminho	Yes	cadeia	Não	ID da categoria de oportunidade para recuperar cargas de trabalho potenciais

Cargas de trabalho potenciais – oportunidade específica: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Cargas de trabalho potenciais – oportunidade específica: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Cargas de trabalho potenciais – oportunidade específica: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não	Contém informações sobre uma carga de trabalho que faz parte dos pontos de extremidade de oportunidade.
`workloadId`	inteiro	int32	Não	A ID da carga de trabalho.
`workloadName`	cadeia		Yes	O nome da carga de trabalho.

Cargas de trabalho potenciais – ID da carga de trabalho

Obtém uma lista de cargas de trabalho potenciais junto com a ID da carga de trabalho associada a cada uma delas.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/PotentialWorkloads

Cargas de trabalho potenciais – ID da carga de trabalho: parâmetros de URI

None

Cargas de trabalho potenciais – ID da carga de trabalho: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Cargas de trabalho potenciais – ID da carga de trabalho: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Cargas de trabalho potenciais – ID da carga de trabalho: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	matriz		Não
`<array item>`	objeto		Não	Contém informações sobre uma carga de trabalho que faz parte dos pontos de extremidade de oportunidade.
`workloadId`	inteiro	int32	Não	A ID da carga de trabalho.
`workloadName`	cadeia		Yes	O nome da carga de trabalho.

Compromissos do MCI

Obtém uma lista de compromissos de MCI.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/MciEngagements

MCI Engagements: parâmetros de URI

Nome	Localidade	Required
`tenantIds`	CONSULTA	Yes
`workloadIds`	CONSULTA	Yes

Compromissos MCI: Cabeçalho de Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Compromissos do MCI: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

McI Engagements: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`workloadId`	inteiro	int32	Não
`engagementName`	cadeia		Yes
`engagementId`	cadeia		Yes
`claimId`	inteiro	int64	Yes
`solutionArea`	cadeia		Yes
`enrolled`	boolean		Não
`eligibilityStartDate`	cadeia	date	Yes
`eligibilityEndDate`	cadeia	date	Yes
`segment`	cadeia		Yes
`area`	cadeia		Yes
`subsidiary`	cadeia		Yes
`potentialEarnings`	número	duplo	Yes

Segmentos – filtros disponíveis

Obtém uma lista de filtros de segmento disponíveis para as IDs de MPN do usuário atual.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/filters/segments

Segmentos – filtros disponíveis: parâmetros de URI

None

Segmentos – filtros disponíveis: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Segmentos – filtros disponíveis: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Segmentos – filtros disponíveis: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	cadeia		Não

Países/Regiões do Locatário – IDs de MPN do usuário atual

Obtém uma lista de países/regiões de inquilinos disponíveis para as IDs de MPN do usuário atual.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/filters/tenantCountries

Países/Regiões do Locatário – IDs de MPN do usuário atual: parâmetros de URI

None

Países/Regiões do Locatário – IDs MPN do usuário atual: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Países/Regiões do Locatário – IDs MPN do Usuário Atual: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Países/Regiões do Inquilino – IDs MPN do usuário atual: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	cadeia		Não

Resumo – Copilot oportunidades

Retorna um resumo das oportunidades de Copilot para o usuário atual.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/summary

Resumo – Oportunidades do Copilot: parâmetros de URI

None

Resumo – Oportunidades do Copilot: Cabeçalho de Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Resumo – Oportunidades do Copilot: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Resumo – Oportunidades do Copilot: Definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`copilotPipelineCount`	inteiro	int32	Não
`penetrationPercent`	número	duplo	Não
`utilizationPercent`	número	duplo	Yes
`expansionReadyCount`	inteiro	int32	Não
`adoptionReadyCount`	inteiro	int32	Não
`atRiskCount`	inteiro	int32	Yes
`blockedCount`	inteiro	int32	Yes
`incentiveEligibleCount`	inteiro	int32	Não
`potentialEarnings`	número	duplo	Não
`acquireCount`	inteiro	Int32	Não
`monetizeCount`	inteiro	Int32	Não
`growCount`	inteiro	Int32	Não
`M365Penetration`	número	duplo	Não

Resumo do Cenário de Direcionamento do Copilot

Retorna um resumo das oportunidades de Copilot por cenário segmentado.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/targetingScenarioSummary

Sumário do cenário de direcionamento do Copilot: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean	Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean	Não
`copilotTargetingScenario`	CONSULTA	Não	matriz	Não

Resumo do cenário de direcionamento Copilot: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Authorization	Verdade	cadeia	Token de portador de autorização

Resumo: Cenário de direcionamento do Copilot: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

resumo do cenário de direcionamento Copilot: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`acquire`	inteiro	int32	Não
`monetize`	inteiro	int32	Não
`grow`	inteiro	int32	Não
`other`	inteiro	int32	Não

Segmento de Inquilino do Copilot

Retorna os segmentos de inquilinos disponíveis para oportunidades no Copilot.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/filters/tenantSegments

Copilot: Segmento de Cliente: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean	Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean	Não
`copilotTargetingScenario`	CONSULTA	Não	matriz	Não

segmento de locatário Copilot: cabeçalho de solicitação

None

segmento de locatário Copilot: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

segmento de locatário Copilot: definições

Nome	Tipo	Nullable
`<root>`	matriz	Não
`<array item>`	cadeia	Não

Copilot

Retorna uma lista de oportunidades de copiloto.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot

Copilot: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`adoptionStatusFilter`	CONSULTA	Não	matriz		Não
`adoptionBlockerFilter`	CONSULTA	Não	matriz		Não
`adoptionReadyOpportunityFilter`	CONSULTA	Não	matriz		Não
`expansionReadyOpportunityFilter`	CONSULTA	Não	matriz		Não
`copilotTargetingScenario`	CONSULTA	Não	matriz		Não
`mciFilter`	CONSULTA	Não	cadeia		Não	Filtro elegível/não elegível para resultados.
`cporClaimFilter`	CONSULTA	Não	matriz		Não
`tenantCountryFilter`	CONSULTA	Não	matriz		Não
`tenantSegmentFilter`	CONSULTA	Não	matriz		Não
`eaRenewalDateFilter`	CONSULTA	Não	cadeia		Não	Filtro de calendário para resultados.
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean		Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean		Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean		Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean		Não
`hasCopilotLicenses`	CONSULTA	Não	boolean		Não
`mciWorkshopNameFilter`	CONSULTA	Não	matriz		Não
`isCpor`	CONSULTA	Não	boolean		Não
`isCsp`	CONSULTA	Não	boolean		Não
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não
`searchTerm`	CONSULTA	Não	cadeia		Não
`sortColumn`	CONSULTA	Não	cadeia		Não
`sortDirection`	CONSULTA	Não	cadeia		Não	Direção de ordenação para resultados.

Copilot: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Copilot: Respostas

	Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Copilot: Definições

Nome	Tipo	Formato	Nullable	Enum	Descrição
`<root>`	objeto		Não		Uma classe que representa dados paginados da API.
`rfaId`	inteiro	int32	Yes		O RFAID associado à solicitação, se houver.
`count`	inteiro	int32	Não		O número total de itens disponíveis no conjunto de dados.
`hasMore`	boolean		Não		Indicar se há mais dados a serem recuperados.
`items`	matriz		Yes		Os itens incluídos na página.
`<array item>`	objeto		Não
`tpid`	inteiro	int32	Yes
`customerName`	cadeia		Yes
`customerRenewalDate`	cadeia	date-time	Yes
`tenantId`	cadeia		Yes
`tenantName`	cadeia		Yes
`tenantCountryRegion`	cadeia		Yes
`tenantHostName`	cadeia		Yes
`tenantSubsegment`	cadeia		Yes
`tenantParentSegment`	cadeia		Yes
`licensedMau`	inteiro	int32	Yes
`pau`	inteiro	int32	Yes
`utilizationPercent`	número	duplo	Yes
`freeMau`	inteiro	int32	Yes
`allMau`	inteiro	int32	Yes
`freeToPaidWhitespace`	número	duplo	Yes
`adoptionReadyOpportunity`	cadeia		Yes
`expansionReadyOpportunity`	cadeia		Yes
`eligibleMciEngagements`	inteiro	int32	Não
`claimStatus`	cadeia		Não	Reivindicado, ReivindicadoPorOutros, NãoReivindicado, NãoDisponível, Inelegível	O status de solicitação associado a uma carga de trabalho de inquilino.
`potentialEarnings`	número	duplo	Yes
`startingHwm`	inteiro	int32	Yes
`priorHwm`	inteiro	int32	Yes
`opportunityUnits`	inteiro	int32	Yes
`ratePerUnit`	inteiro	int32	Yes
`maxCompUnits`	inteiro	int32	Yes
`adoptionStatus`	cadeia		Yes
`mciPotentialEarnings`	número	duplo	Yes
`cporPotentialEarnings`	número	duplo	Yes
`retentionReasons`	cadeia		Yes
`growthReasons`	cadeia		Yes
`cporClaimId`	inteiro	int32	Yes
`advancedDeploymentGuideName`	cadeia		Yes
`advancedDeploymentGuideLink`	cadeia		Yes
`workloadMau`	objeto		Não
`teams`	inteiro	int32	Yes
`outlook`	inteiro	int32	Yes
`word`	inteiro	int32	Yes
`excel`	inteiro	int32	Yes
`powerpoint`	inteiro	int32	Yes
`engage`	inteiro	int32	Yes
`onenote`	inteiro	int32	Yes
`sales`	inteiro	int32	Yes
`claimWorkloadLink`	cadeia		Yes
`claimedByOthers`	boolean		Não
`resourceName`	cadeia		Yes
`resourceLink`	cadeia		Yes
`extensibility`	objeto		Não
`agentsAllUp`	objeto		Não
`total`	número	duplo	Yes
`licensed`	número	duplo	Yes
`unlicensed`	número	duplo	Yes
`agentsCopilotChat`	objeto		Não
`total`	número	duplo	Yes
`licensed`	número	duplo	Yes
`unlicensed`	número	duplo	Yes
`agentsConnectors`	objeto		Não
`total`	número	duplo	Yes
`licensed`	número	duplo	Yes
`unlicensed`	número	duplo	Yes
`agentsPlugin`	objeto		Não
`total`	número	duplo	Yes
`licensed`	número	duplo	Yes
`unlicensed`	número	duplo	Yes
`agentsCustom`	objeto		Não
`total`	número	duplo	Yes
`licensed`	número	duplo	Yes
`unlicensed`	número	duplo	Yes
`copilotTargetingScenario`	cadeia		Não	Adquirir, monetizar, crescer, outros	O status de solicitação associado a uma carga de trabalho de inquilino.
`copilotEligibleAllUpSeats`	inteiro	int32	Yes
`m365CopilotAllUpPenetration`	número	duplo	Yes
`chatPenetration`	número	duplo	Yes
`m365CopilotAllUpWhitespace`	número	duplo	Yes
`chatWhitespace`	número	duplo	Yes
`isCpor`	boolean		Yes
`isCpsp`	boolean		Yes

Penetração de locatário

Retorna o número de locatários com Copilot habilitado e o número de locatários sem Copilot.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/tenantPenetration

Penetração de locatário: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean	Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean	Não

Penetração de locatário: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Penetração de locatário: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Penetração de locatário: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`tenantsWithCopilot`	inteiro	int32	Não
`tenantsWithoutCopilot`	inteiro	int32	Não

Resumo da adoção

Retorna um resumo de classificação de saúde, mostrando o número de locatários em cada estado de saúde.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/adoptionSummary

Resumo sobre a adoção: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean	Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean	Não
`copilotTargetingScenario`	CONSULTA	Não	matriz	Não

Resumo da adoção: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Resumo da adoção: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Resumo da adoção: definições

Nome	Tipo	Nullable	Definição
`<root>`	objeto	Não
`Failure to Launch/Start`	inteiro		Não quebrou 10% MAU/PAU (potencial uso ativo) na história
`Failure to Thrive/Adopt`	inteiro		Não está no caminho certo para atingir 80% MAU/PAU em um ano.
`Healthy`	inteiro		Locatário no caminho certo para atingir 80% de MAU/PAU em um ano.
`Starting`	inteiro		Compra recente e mais dados são necessários
`Failure to Adopt but Last Month Gain`	inteiro		Falhando em prosperar, mas aumento no uso no mês passado
`Healthy but Last Month Drop`	inteiro		Está saudável, mas houve uma queda no uso no mês passado.
`Healthy but Negative Slope`	inteiro		É saudável, mas inclinado para baixo
`Big Gain & Big Drop`	inteiro		Grande ganho e grande queda observado no passado

Resumo de ganhos potenciais da MCI

Retorna uma lista de ganhos potenciais do envolvimento específico do MCI com base nas taxas de programas e na geografia do parceiro.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/mciPotentialEarningsSummary

Resumo de ganhos potenciais do MCI: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean	Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean	Não
`copilotTargetingScenario`	CONSULTA	Não	matriz	Não

Resumo de ganhos potenciais do MCI: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Resumo de ganhos potenciais da MCI: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Resumo de ganhos potenciais da MCI: definições

Nome	Tipo	Nullable
`<root>`	objeto	Não
`Copilot+Power Deployment Accelerator (S)`	inteiro
`Copilot+Power Deployment Accelerator (XS)`	inteiro
`Copilot+Power Envisioning & PoC (M)`	inteiro
`Copilot+Power Envisioning & PoC (S)`	inteiro
`Copilot+Power Envisioning & PoC (XS)`	inteiro

Uso Mensal por Produto - Visão Geral

Recupera dados de uso, divididos por MAU licenciado, MAU sem licença e todo o MAU.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/usageByProductMonthlySnapshot

Instantâneo Mensal de Uso por Produto: Parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`expansionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`adoptionReadyTenantsOnly`	CONSULTA	Não	boolean	Não
`incentiveEligibleTenantsOnly`	CONSULTA	Não	boolean	Não
`hasPotentialEarningsOnly`	CONSULTA	Não	boolean	Não
`copilotTargetingScenario`	CONSULTA	Não	matriz	Não

Instantâneo Mensal de Uso por Produto: Cabeçalho de Requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Instantâneo Mensal por Uso de Produto: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Uso Mensal por Produto: Resumo

Nome	Tipo	Nullable
`<root>`	objeto	Não
`unlicensedMau`	inteiro
`licensedMau`	inteiro
`allMau`	inteiro

Países/Regiões do Locatário – filtragem

Recupera a lista de países/regiões de locatário válidos que podem ser usados para filtragem.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/filters/tenantCountries

Países/Regiões do Locatário – filtragem: parâmetros de URI

None

Países/Regiões do Inquilino – Filtragem: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Países/Regiões do Locatário – filtragem: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Países/Regiões do Locatário – filtragem: Definições

Nome	Tipo	Nullable
`<root>`	matriz	Não
Países/regiões do locatário	cadeia	Não

Status de adoção

Recupera a lista de valores de status de adoção válidos que podem ser usados para filtragem.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/filters/adoptionStatuses

Status de Adoção: Parâmetros de URI

None

Status da adoção: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Status da adoção: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Status da adoção: definições

Nome	Tipo	Nullable
`<root>`	matriz	Não
`Adoption Status`	cadeia	Não

Clientes

Essa resposta fornece um modelo de dados abrangente para cargas de trabalho, clientes e oportunidades, incluindo desempenho, acompanhamento de incentivos e métricas de adoção.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerCenter/customers

Clientes: parâmetros de URI

None

Clientes: Cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Clientes: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Clientes: Definições

Nome	Tipo	Formato	Nullable	Enum
`<root>`	objeto		Não
`workloadDefinitions`	matriz		Yes
`<array item>`	objeto		Não
`id`	cadeia		Yes
`priorityWeight`	inteiro	int32	Não
`customers`	matriz		Yes
`<array item>`	objeto		Não
`customerId`	cadeia		Yes
`customerName`	cadeia		Yes
`domainName`	cadeia		Yes
`tags`	matriz		Yes
`<array item>`	cadeia		Não	Desconhecido, FRP, EDU
`workloads`	matriz		Yes
`<array item>`	objeto		Não
`workloadMpnPair`	objeto		Não
`workloadId`	cadeia		Não	`Unknown`, `ExchangeOnline`, `SharePointOnline`, `MicrosoftTeams`, `Yammer`, `Office365ProPlus`, `MicrosoftIntune`, `AzureActiveDirectoryPremium`, `MicrosoftCloudAppSecurity`, `AzureAdvancedThreatProtection`, `OutlookMobile`, `OATP`, `MDATP`, `TeamsPhoneSystem`, `TeamsAppsAndPlatform`, `TeamsMeetings`, `MicrosoftInformationProtection`, `AADPConditionalAccess`, `InsiderRiskManager`, `VivaConnections`, `VivaInsights`, `VivaLearning`, `VivaTopics`, `AzureActiveDirectoryPremium2`, `TeamsForFrontlineWorkers`, `VivaGoals`, `TeamsRooms`, `Windows365`, `CopilotForMicrosoft365`, `ProjectAndPlanner`
`mpnId`	cadeia		Yes
`workloadName`	cadeia		Yes
`tags`	matriz		Yes
`<array item>`	cadeia		Não	Desconhecido, FRP
`priorHwm`	inteiro	int64	Yes
`hwm`	inteiro	int64	Yes
`month1Hwm`	inteiro	int64	Yes
`activeEntitlements`	inteiro	int32	Não
`qualifiedEntitlements`	inteiro	int32	Não
`usage`	número	duplo	Yes
`complete`	boolean		Não
`dollarIncentivesAvailable`	inteiro	int32	Não
`targetsMet`	inteiro	int32	Não
`totalTargets`	inteiro	int32	Não
`incentiveThresholds`	matriz		Yes
`<array item>`	objeto		Não
`dateAssociated`	cadeia	date-time	Não
`claimId`	cadeia		Yes
`bucketSize`	cadeia		Yes
`usageAtClaim`	número	duplo	Yes
`ratePerUnit`	inteiro	int32	Yes
`maxCompUnits`	inteiro	int32	Yes
`opportunityUnits`	inteiro	int32	Yes
`potentialEarnings`	inteiro	int32	Yes
`associatedOpportunities`	matriz		Yes
`<array item>`	cadeia		Não
`excludedWorkloads`	matriz		Yes
`<array item>`	cadeia		Não	`Unknown`, `ExchangeOnline`, `SharePointOnline`, `MicrosoftTeams`, `Yammer`, `Office365ProPlus`, `MicrosoftIntune`, `AzureActiveDirectoryPremium`, `MicrosoftCloudAppSecurity`, `AzureAdvancedThreatProtection`, `OutlookMobile`, `OATP`, `MDATP`, `TeamsPhoneSystem`, `TeamsAppsAndPlatform`, `TeamsMeetings`, `MicrosoftInformationProtection`, `AADPConditionalAccess`, `InsiderRiskManager`, `VivaConnections`, `VivaInsights`, `VivaLearning`, `VivaTopics`, `AzureActiveDirectoryPremium2`, `TeamsForFrontlineWorkers`, `VivaGoals`, `TeamsRooms`, `Windows365`, `CopilotForMicrosoft365`, `ProjectAndPlanner`
`unclaimedWorkloads`	matriz		Yes
`<array item>`	objeto		Não
`workloadId`	cadeia		Não	`Unknown`, `ExchangeOnline`, `SharePointOnline`, `MicrosoftTeams`, `Yammer`, `Office365ProPlus`, `MicrosoftIntune`, `AzureActiveDirectoryPremium`, `MicrosoftCloudAppSecurity`, `AzureAdvancedThreatProtection`, `OutlookMobile`, `OATP`, `MDATP`, `TeamsPhoneSystem`, `TeamsAppsAndPlatform`, `TeamsMeetings`, `MicrosoftInformationProtection`, `AADPConditionalAccess`, `InsiderRiskManager`, `VivaConnections`, `VivaInsights`, `VivaLearning`, `VivaTopics`, `AzureActiveDirectoryPremium2`, `TeamsForFrontlineWorkers`, `VivaGoals`, `TeamsRooms`, `Windows365`, `CopilotForMicrosoft365`, `ProjectAndPlanner`
`workloadName`	cadeia		Yes
`activeEntitlements`	inteiro	int32	Yes
`qualifiedEntitlements`	inteiro	int32	Yes
`priorHwm`	inteiro	int64	Yes
`hwm`	inteiro	int64	Yes
`month1Hwm`	inteiro	int64	Yes
`compUnits`	inteiro	int64	Yes
`usage`	número	duplo	Yes
`complete`	boolean		Não
`dollarIncentivesAvailable`	inteiro	int32	Não
`targetsMet`	inteiro	int32	Não
`totalTargets`	inteiro	int32	Não
`incentiveThresholds`	matriz		Yes
`<array item>`	objeto		Não
`bucketSize`	cadeia		Yes
`ratePerUnit`	inteiro	int32	Yes
`maxCompUnits`	inteiro	int32	Yes
`opportunityUnits`	inteiro	int32	Yes
`potentialEarnings`	inteiro	int32	Yes
`opportunities`	matriz		Yes
`<array item>`	objeto		Não
`pinnedOpportunities`	objeto		Não
`unclaimedWorkloads`	objeto		Não
`id`	cadeia		Yes
`displayTitle`	cadeia		Yes
`displayDetailsMarkdown`	cadeia		Yes
`displayDetailsPlaceholderValues`	objeto		Yes
`customerCount`	inteiro	int32	Não
`flyoutOpportunity`	boolean		Não
`unreachedMilestones`	objeto		Não
`id`	cadeia		Yes
`displayTitle`	cadeia		Yes
`displayDetailsMarkdown`	cadeia		Yes
`displayDetailsPlaceholderValues`	objeto		Yes
`customerCount`	inteiro	int32	Não
`flyoutOpportunity`	boolean		Não
`nearingMilestones`	objeto		Não
`id`	cadeia		Yes
`displayTitle`	cadeia		Yes
`displayDetailsMarkdown`	cadeia		Yes
`displayDetailsPlaceholderValues`	objeto		Yes
`customerCount`	inteiro	int32	Não
`flyoutOpportunity`	boolean		Não
`dateLastUpdated`	cadeia	date-time	Não
`workloadChartData`	matriz		Yes
`<array item>`	objeto		Não

Resumo – detalhes do parceiro

Retorna detalhes do parceiro, incluindo IDs de MPN, informações de endereço, sinalizadores de recursos, notificações ativas e a presença de sinalizadores de usuário.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerCenter/summary

Resumo – detalhes do parceiro: parâmetros de URI

None

Resumo – detalhes do parceiro: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Resumo – detalhes do parceiro: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Resumo – detalhes do parceiro: definições

Nome	Tipo	Nullable
`<root>`	objeto	Não
`claimCustomersLink`	cadeia	Yes
`enrolledMpns`	matriz	Yes
`<array item>`	objeto	Não
`mpnId`	cadeia	Yes
`addressModel`	objeto	Não
`country`	cadeia	Yes
`city`	cadeia	Yes
`state`	cadeia	Yes
`addressLine1`	cadeia	Yes
`addressLine2`	cadeia	Yes
`postalCode`	cadeia	Yes
`countryRegionLabel`	cadeia	Yes
`featureFlags`	matriz	Yes
`<array item>`	cadeia	Não
`activeNotifications`	matriz	Yes
`<array item>`	objeto	Não
`id`	cadeia	Yes
`titleKey`	cadeia	Yes
`DefinitionsKey`	cadeia	Yes
`linkKey`	cadeia	Yes
`linkUrl`	cadeia	Yes
`hasRequiredRolesForExport`	boolean	Não

Status de aceitação

Retorna a lista de status de aceitação válidos para referências de parceiro, incluindo suas IDs exclusivas e nomes de exibição.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerReferrals/AcceptanceStatuses

Status de aceitação: parâmetros de URI

None

Status de aceitação: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Status de aceitação: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Status de aceitação: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Razões de declínio

Retorna a lista de motivos de recusa para referências de parceiros, incluindo IDs exclusivas e motivos.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerReferrals/DeclineReason

Motivos de declínio: parâmetros de URI

None

Motivos de rejeição: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Motivos de declínio: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Motivos de declínio: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Status de referência

Obtém uma lista de todos os status de referência para uma referência de parceiro.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerReferrals/ReferralStatuses

Status de referência: parâmetros de URI

None

Status da referência: cabeçalho da requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Status de referência: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Status de referência: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Valores de serviços

Retorna a lista de possíveis intervalos de valores de serviço para uma referência.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerReferrals/ServicesValues

Valores de serviços: parâmetros de URI

None

Valores de serviços: cabeçalho de requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Valores de serviços: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Valores de serviços: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Referências de parceiro

Obtém uma lista de recomendações atualmente sendo oferecidas à sua conta, se houver.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerReferrals

Referências de parceiro: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não
`showDeclinedReferrals`	CONSULTA	Não	boolean		Não
`partnerReferralSourceIds`	CONSULTA	Não	matriz		Não
`searchTerm`	CONSULTA	Não	cadeia		Não
`sortColumn`	CONSULTA	Não	cadeia		Não
`sortDirection`	CONSULTA	Não	cadeia		Não	Direção de ordenação dos resultados

Referências de parceiro: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Referências de parceiro: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json

Referências de parceiro: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`count`	inteiro	int32	Não
`hasMore`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Yes
`partnerReferralId`	cadeia	identificador único universal (UUID)	Yes
`created`	cadeia	date-time	Não
`tenantId`	cadeia		Yes
`tenantName`	cadeia		Yes
`tenantDomain`	cadeia		Yes
`referralSource`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`workloads`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`claimed`	boolean		Não
`partnerReferralNumber`	cadeia		Yes
`acceptance`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`declineReason`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`referralStatus`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`valueAddedServicesSold`	boolean		Yes
`servicesEstimatedValue`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`requestorContact`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`primaryContact`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`secondaryContact`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`referralState`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`referralStage`	cadeia		Yes
`outreachStatus`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`engagementStatus`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`engagementUpdateDate`	cadeia	date-time	Yes
`callToAction`	cadeia		Yes

ID de referência do parceiro

Corrige uma indicação aceitando ou recusando a indicação.

PATCH https://m365partner.microsoft.com/abss/v1.3/api/partnerReferrals/{partnerReferralId}

ID de referência do parceiro: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`partnerReferralId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não

ID de referência do parceiro: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

ID de referência do parceiro: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

ID de referência do parceiro: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`id`	inteiro	int32	Yes
`partnerReferralId`	cadeia	identificador único universal (UUID)	Yes
`created`	cadeia	date-time	Não
`tenantId`	cadeia		Yes
`tenantName`	cadeia		Yes
`tenantDomain`	cadeia		Yes
`referralSource`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`workloads`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`claimed`	boolean		Não
`partnerReferralNumber`	cadeia		Yes
`acceptance`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`declineReason`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`referralStatus`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`valueAddedServicesSold`	boolean		Yes
`servicesEstimatedValue`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`requestorContact`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`primaryContact`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`secondaryContact`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`referralState`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`referralStage`	cadeia		Yes
`outreachStatus`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`engagementStatus`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`engagementUpdateDate`	cadeia	date-time	Yes
`callToAction`	cadeia		Yes

Locatários Parceiros

Recupera todos os locatários para os quais seu parceiro tem uma carga de trabalho reivindicada, juntamente com uma lista de cargas de trabalho que você reivindicou para esse locatário.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants

Locatários Parceiros: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não

Inquilinos Parceiros: Cabeçalho de Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Inquilinos dos Parceiros: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Locatários do parceiro: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`count`	inteiro	int32	Não
`hasMore`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`tenantId`	cadeia		Yes
`name`	cadeia		Yes
`tpid`	inteiro	int32	Yes
`claimedWorkloads`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

ID do locatário – cargas de trabalho reivindicadas

Recupera detalhes sobre um único cliente para o qual seu parceiro possui uma carga de trabalho específica.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants/{tenantId}

ID do locatário – cargas de trabalho declaradas: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não

ID do locatário – cargas de trabalho reivindicadas: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

ID do locatário – cargas de trabalho declaradas: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

ID do locatário – cargas de trabalho declaradas: Definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`tenantId`	cadeia		Yes
`name`	cadeia		Yes
`tpid`	inteiro	int32	Yes
`claimedWorkloads`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Direitos Máximos

Informações de direito máximo de uso recuperadas para vários inquilinos. Limitado a 25 IDs de locatário por chamada.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants/maxEntitlements

Direitos máximos: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`tenantIds`	CONSULTA	Yes	matriz	Não

Máximo de direitos: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Direitos máximos: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Direitos máximos: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`moreRecords`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`serviceId`	inteiro	int32	Não
`maxEntitledSeatCount`	inteiro	int32	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não

Desempenho do parceiro

Retorna dados de desempenho do parceiro MCI, incluindo detalhes de envolvimento, marcos, métricas de alcance e KPIs específicos da solução.

GET https://m365partner.microsoft.com/abss/v1.3/api/mci/partnerPerformance

Desempenho do parceiro: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Descrição
`engagementNameFilters`	CONSULTA	Não	matriz		Não	Filtros para nomes de participação
`partnerAreaFilters`	CONSULTA	Não	matriz		Não	Filtros para zonas de parcerias
`milestoneFilters`	CONSULTA	Não	matriz		Não	Filtros para marcos temporais
`stageFilter`	CONSULTA	Não	cadeia		Não	Filtros para Etapa
`consentFlag`	CONSULTA	Não	cadeia		Não	Filtrar o sinalizador de consentimento
`page`	CONSULTA	Não	inteiro	int32	Não	Número da página
`pageSize`	CONSULTA	Não	inteiro	int32	Não	Tamanho da página
`searchTerm`	CONSULTA	Não	cadeia		Não	Termo de pesquisa
`sortColumn`	CONSULTA	Não	cadeia		Não	Classificar por uma coluna específica
`sortDirection`	CONSULTA	Não	cadeia		Não	Direção da Ordenação
`mciPerformanceTabs`	CONSULTA	Não	cadeia

Desempenho do parceiro: cabeçalho de solicitação de URI

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Desempenho do parceiro: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Desempenho do parceiro: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`partnerPerformanceDetails`	objeto		Não
`count`	inteiro	int32	Não
`hasMore`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`stage`	cadeia		Yes
`tpidName`	cadeia		Yes
`tpid`	inteiro	int32	Yes
`tenantName`	cadeia		Yes
`tenantID`	cadeia		Yes
`partnerArea`	cadeia		Yes
`solutionPlay`	cadeia		Yes
`claimID`	inteiro	int32	Yes
`engagementName`	cadeia		Yes
`dateInitiated`	cadeia	date-time	Yes
`poeCompletionDate`	cadeia	date-time	Yes
`monthCount`	número	duplo	Yes
`monthsSinceCompletion`	número	duplo	Yes
`milestone`	cadeia		Yes
`claimTarget`	inteiro	int32	Yes
`claimWinFlag`	cadeia		Yes
`claimAttainment`	número	duplo	Yes
`claimRevisedAttainment`	número	duplo	Yes
`revenueAttainment`	número	duplo	Yes
`quarterlyRevenueTarget`	número	duplo	Yes
`seatsAttainment`	número	duplo	Yes
`quarterlySeatsTarget`	número	duplo	Yes
`m365CopilotAdjRevAttainment`	número	duplo	Yes
`m365CopilotAdjRevRevisedAttainment`	número	duplo	Yes
`quarterlyM365CopilotAdjRevRevisedTarget`	número	duplo	Yes
`quarterlyM365CopilotAdjRevTarget`	número	duplo	Yes
`copilotChatMAUAttainment`	número	duplo	Yes
`copilotChatMAURevisedAttainment`	número	duplo	Yes
`quarterlyCopilotChatMAUTarget`	número	duplo	Yes
`quarterlyCopilotChatMAURevisedTarget`	número	duplo	Yes
`copilotStudioACRAttainment`	número	duplo	Yes
`copilotStudioACRRevisedAttainment`	número	duplo	Yes
`quarterlyCopilotStudioACRTarget`	número	duplo	Yes
`quarterlyCopilotStudioACRRevisedTarget`	número	duplo	Yes
`powerPlatformAdjRevAttainment`	número	duplo	Yes
`powerPlatformAdjRevRevisedAttainment`	número	duplo	Yes
`quarterlyPowerPlatformAdjRevRevisedTarget`	número	duplo	Yes
`quarterlyPowerPlatformAdjRevTarget`	número	duplo	Yes
`totalAttainment`	número	duplo	Yes
`consentFlag`	cadeia		Yes
`repeatCustomerFlag`	cadeia		Yes
`availablePartnerAreas`	matriz		Yes
`<array item>`	cadeia		Não
`availableEngagementNames`	matriz		Yes
`<array item>`	cadeia		Não
`availableMilestones`	matriz		Yes
`<array item>`	cadeia		Não
`availableStages`	matriz		Yes
`<array item>`	cadeia		Não

Soluções de desempenho de parceiros

Retorna dados de desempenho do parceiro MCI para uma solução específica, incluindo detalhes de envolvimento, marcos, métricas de obtenção e valores de filtro disponíveis.

GET https://m365partner.microsoft.com/abss/v1.3/api/mci/partnerPerformance/solutions/{mcisolution}

Soluções de desempenho de parceiros: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Descrição
`mciSolution`	Caminho	Yes	cadeia		Não	Filtro SolutionPlay/Tab. Lista de soluções: MciCopilot, MciTeams, MciSecurity, MciCloud
`engagementNameFilters`	CONSULTA	Não	matriz		Não	Filtros para nomes de participação
`partnerAreaFilters`	CONSULTA	Não	matriz		Não	Filtros para zonas de parcerias
`milestoneFilters`	CONSULTA	Não	matriz		Não	Filtros para marcos temporais
`stageFilter`	CONSULTA	Não	cadeia		Não	Filtros para Etapa
`consentFlag`	CONSULTA	Não	cadeia		Não	Filtrar o sinalizador de consentimento
`page`	CONSULTA	Não	inteiro	int32	Não	Número da página
`pageSize`	CONSULTA	Não	inteiro	int32	Não	Tamanho da página
`searchTerm`	CONSULTA	Não	cadeia		Não	Termo de pesquisa
`sortColumn`	CONSULTA	Não	cadeia		Não	Classificar por uma coluna específica
`sortDirection`	CONSULTA	Não	cadeia		Não	Direção da Ordenação

Soluções de desempenho dos parceiros: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Soluções de desempenho de parceiros: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Soluções de desempenho de parceiros: definições

Nome	Tipo	Formato
`<root>`	objeto
`partnerPerformanceDetails`	objeto
`count`	inteiro	int32
`hasMore`	boolean
`items`	matriz
`<array item>`	objeto
`stage`	cadeia
`tpidName`	cadeia
`tpid`	inteiro	int32
`tenantName`	cadeia
`tenantID`	cadeia
`partnerArea`	cadeia
`solutionPlay`	cadeia
`claimID`	inteiro	int32
`engagementName`	cadeia
`dateInitiated`	cadeia	date-time
`poeCompletionDate`	cadeia	date-time
`monthCount`	número	duplo
`monthsSinceCompletion`	número	duplo
`milestone`	cadeia
`claimTarget`	inteiro	int32
`claimWinFlag`	cadeia
`claimAttainment`	número	duplo
`claimRevisedAttainment`	número	duplo
`revenueAttainment`	número	duplo
`quarterlyRevenueTarget`	número	duplo
`seatsAttainment`	número	duplo
`quarterlySeatsTarget`	número	duplo
`m365CopilotAdjRevAttainment`	número	duplo
`m365CopilotAdjRevRevisedAttainment`	número	duplo
`quarterlyM365CopilotAdjRevRevisedTarget`	número	duplo
`quarterlyM365CopilotAdjRevTarget`	número	duplo
`copilotChatMAUAttainment`	número	duplo
`copilotChatMAURevisedAttainment`	número	duplo
`quarterlyCopilotChatMAUTarget`	número	duplo
`quarterlyCopilotChatMAURevisedTarget`	número	duplo
`copilotStudioACRAttainment`	número	duplo
`copilotStudioACRRevisedAttainment`	número	duplo
`quarterlyCopilotStudioACRTarget`	número	duplo
`quarterlyCopilotStudioACRRevisedTarget`	número	duplo
`powerPlatformAdjRevAttainment`	número	duplo
`powerPlatformAdjRevRevisedAttainment`	número	duplo
`quarterlyPowerPlatformAdjRevRevisedTarget`	número	duplo
`quarterlyPowerPlatformAdjRevTarget`	número	duplo
`totalAttainment`	número	duplo
`consentFlag`	cadeia
`repeatCustomerFlag`	cadeia
`availablePartnerAreas`	matriz
`<array item>`	cadeia
`availableEngagementNames`	matriz
`<array item>`	cadeia
`availableMilestones`	matriz
`<array item>`	cadeia
`availableStages`	matriz
`<array item>`	cadeia

Resumo do desempenho do MCI

Retorna um resumo da qualificação de desempenho da MCI e dos resultados de engajamento por jogo de solução.

GET https://m365partner.microsoft.com/abss/v1.3/api/mci/partnerPerformance/summary

Resumo do desempenho do MCI: parâmetros de URI

None

Resumo de Performance do MCI: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Resumo do desempenho do MCI: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Resumo do desempenho do MCI: definições

Nome	Tipo	Formato	Nullable	Descrição
`<root>`	objeto		Não	Descreve informações resumidas de desempenho para um parceiro específico
`copilotDeploy`	objeto		Não
`eligibility`	cadeia		Yes	O status da elegibilidade
`claimsPercentage`	cadeia		Yes	A porcentagem de envolvimentos com reivindicações
`passingCount`	inteiro	int32	Yes	O número de compromissos aprovados
`failingCount`	inteiro	int32	Yes	O número de atividades falhas
`totalEngagements`	inteiro	int32	Yes	Número total de participações
`qualifiedEngagements`	inteiro	int32	Yes	Número de engajamentos qualificados
`copilotEnvision`	objeto		Não
`eligibility`	cadeia		Yes	O status da elegibilidade
`claimsPercentage`	cadeia		Yes	A porcentagem de envolvimentos com reivindicações
`passingCount`	inteiro	int32	Yes	O número de compromissos aprovados
`failingCount`	inteiro	int32	Yes	O número de atividades falhas
`totalEngagements`	inteiro	int32	Yes	Número total de participações
`qualifiedEngagements`	inteiro	int32	Yes	Número de engajamentos qualificados
`teamPhoneDeploy`	objeto		Não
`eligibility`	cadeia		Yes	O status da elegibilidade
`claimsPercentage`	cadeia		Yes	A porcentagem de envolvimentos com reivindicações
`passingCount`	inteiro	int32	Yes	O número de compromissos aprovados
`failingCount`	inteiro	int32	Yes	O número de atividades falhas
`totalEngagements`	inteiro	int32	Yes	Número total de participações
`qualifiedEngagements`	inteiro	int32	Yes	Número de engajamentos qualificados
`teamPhoneEnvision`	objeto		Não
`eligibility`	cadeia		Yes	O status da elegibilidade
`claimsPercentage`	cadeia		Yes	A porcentagem de envolvimentos com reivindicações
`passingCount`	inteiro	int32	Yes	O número de compromissos aprovados
`failingCount`	inteiro	int32	Yes	O número de atividades falhas
`totalEngagements`	inteiro	int32	Yes	Número total de participações
`qualifiedEngagements`	inteiro	int32	Yes	Número de engajamentos qualificados
`cloudEndpointEnvision`	objeto		Não
`eligibility`	cadeia		Yes	O status da elegibilidade
`claimsPercentage`	cadeia		Yes	A porcentagem de envolvimentos com reivindicações
`passingCount`	inteiro	int32	Yes	O número de compromissos aprovados
`failingCount`	inteiro	int32	Yes	O número de atividades falhas
`totalEngagements`	inteiro	int32	Yes	Número total de participações
`qualifiedEngagements`	inteiro	int32	Yes	Número de engajamentos qualificados
`secureProductivityEnvision`	objeto		Não
`eligibility`	cadeia		Yes	O status da elegibilidade
`claimsPercentage`	cadeia		Yes	A porcentagem de envolvimentos com reivindicações
`passingCount`	inteiro	int32	Yes	O número de compromissos aprovados
`failingCount`	inteiro	int32	Yes	O número de atividades falhas
`totalEngagements`	inteiro	int32	Yes	Número total de participações
`qualifiedEngagements`	inteiro	int32	Yes	Número de engajamentos qualificados

Contatos

Recupera todos os contatos associados a um tipo de contato específico.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants/contactTypes/{contactTypeId}/contacts

Contatos: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantIds`	CONSULTA	Yes	matriz		Não
`contactTypeId`	Caminho	Yes	inteiro	int32	Não
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não

Contatos: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Contatos: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Contatos: Definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	objeto		Não
`<array item>`	objeto		Não
`rfaId`	inteiro	int32	Yes	O RFAID associado à solicitação, se houver
`count`	inteiro	int32	Não	O número total de itens disponíveis no conjunto de dados
`hasMore`	boolean		Não	Indicador caso haja mais dados a serem recuperados
`items`	matriz		Yes	Os itens incluídos na página
`<array item>`	objeto		Não
`contactId`	cadeia	identificador único universal (UUID)	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`email`	cadeia		Yes
`phone`	cadeia		Yes
`managerName`	cadeia		Yes
`managerEmail`	cadeia		Yes
`title`	cadeia		Yes
`evidence`	cadeia		Yes
`surveyEligible`	boolean		Yes
`note`	cadeia		Yes
`created`	cadeia	date-time	Não
`createdBy`	cadeia		Yes
`modified`	cadeia	date-time	Não
`modifiedBy`	cadeia		Yes
`timeZone`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`countryRegion`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`adminType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`surveyLanguage`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`contactType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`services`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Não
`tenantName`	cadeia		Yes

Direitos

Recupera registros de direitos de uso para IDs de locatário especificadas, incluindo detalhes como intenção de serviço, níveis de hierarquia de direitos (L1–L3), contagens de direitos, propriedade, datas de ação alvo/próxima ação, anotações relacionadas e associações de locatário.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants/entitlements

Direitos: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
IDs de inquilino	CONSULTA	Yes	matriz	Não

Permissões: Cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Direitos: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: "aplicativo

Direitos: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`moreRecords`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`serviceIntentId`	cadeia	identificador único universal (UUID)	Yes
`l1`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l2`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l3`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`entitlementsCount`	inteiro	int32	Não
`targetDate`	cadeia	date-time	Yes
`owner`	cadeia		Yes
`nextActionDate`	cadeia	date-time	Yes
`notes`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Yes
`tenantId`	cadeia	identificador único universal (UUID)	Não

Anotações

Recupera anotações associadas a locatários de parceiros.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants/notes

Observações: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`tenantIds`	CONSULTA	Yes	matriz		Não
`orderByCreated`	CONSULTA	Não	cadeia		Não	Direção de ordenação para resultados.
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não

Observações: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Notas: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Notas: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`moreRecords`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`noteId`	cadeia	identificador único universal (UUID)	Yes
`text`	cadeia		Yes
`author`	cadeia		Yes
`created`	cadeia	date-time	Yes
`noteCategory`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`serviceIds`	matriz		Yes
`<array item>`	inteiro	int32	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não

Fontes de referência

Retorna uma lista de todas as fontes de referência disponíveis, cada uma identificada por uma ID numérica exclusiva e um nome descritivo.

GET https://m365partner.microsoft.com/abss/v1.3/api/referralSources

Fontes de referência: parâmetros de URI

None

Fontes de referência: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Fontes de referência: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Fontes de referência: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Services

Procure serviços, uma lista de todos os tipos de serviço.

GET https://m365partner.microsoft.com/abss/v1.3/api/services

Serviços: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`searchTerm`	CONSULTA	Não	cadeia	Não

Serviços: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Serviços: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Serviços: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

FRP (FastTrack Ready Partner)

Esse ponto de extremidade retorna um subconjunto de serviços que são implementados por parceiros. Como regra geral, esses são os dados que você deve usar para preencher listas suspensas e itens semelhantes que representam cargas de trabalho que você irá implementar. No entanto, o endpoint de serviços principais está disponível para referência, pois você pode ver valores para outros serviços em contatos ou permissões.

GET https://m365partner.microsoft.com/abss/v1.3/api/services/frp

FastTrack Ready Partner: parâmetros de URI

Nome	Localidade	Required	Tipo	Nullable
`searchTerm`	CONSULTA	Não	cadeia	Não

Parceiro pronto do FastTrack: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Parceiro Pronto para FastTrack: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json

Parceiro Pronto para FastTrack: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Tipos de habilidades

Esse endpoint retorna uma lista de tipos potenciais de habilidades para uso com contatos.

GET https://m365partner.microsoft.com/abss/v1.3/api/skillTypes

Tipos de habilidade: parâmetros de URI

None

Tipos de competências: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Tipos de habilidade: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Tipos de habilidade: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Idiomas da Pesquisa

Este "endpoint" retorna uma lista de potenciais idiomas de pesquisa para uso com contatos.

GET https://m365partner.microsoft.com/abss/v1.3/api/surveyLanguages

Linguagens de Pesquisa: parâmetros de URI

None

Idiomas da Pesquisa: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Idiomas da Pesquisa: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Tipos de mídia: application/json, text/plain, text/json

Idiomas da Pesquisa: Definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Direitos – vários serviços

Obtém os registros de status de direito de um locatário para vários serviços.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/services/entitlements

Direitos – vários serviços: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`serviceIds`	CONSULTA	Não	matriz		Não

Direitos – vários serviços: cabeçalho de solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Direitos – vários serviços: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Direitos – vários serviços: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`serviceIntentId`	cadeia	identificador único universal (UUID)	Yes
`l1`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l2`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l3`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`entitlementsCount`	inteiro	int32	Não
`targetDate`	cadeia	date-time	Yes
`owner`	cadeia		Yes
`nextActionDate`	cadeia	date-time	Yes
`notes`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Yes

Direitos – serviço único

Obtém os registros de status de habilitação de um locatário para serviço único.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/services/{serviceId}/entitlements

Direitos – serviço único: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`serviceId`	Caminho	Yes	inteiro	int32	Não

Direitos – serviço único: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Direitos – serviço único: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Direitos – serviço único: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`serviceIntentId`	cadeia	identificador único universal (UUID)	Yes
`l1`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l2`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l3`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`entitlementsCount`	inteiro	int32	Não
`targetDate`	cadeia	date-time	Yes
`owner`	cadeia		Yes
`nextActionDate`	cadeia	date-time	Yes
`notes`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Yes

Direitos – serviços específicos

Atualiza todos os status para um direito de serviço específico.

PATCH https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/services/{serviceId}/entitlements

Direitos – serviços específicos: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`serviceId`	Caminho	Yes	inteiro	int32	Não

Direitos – serviços específicos: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Direitos – serviços específicos: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Direitos – serviços específicos: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`serviceIntentId`	cadeia	identificador único universal (UUID)	Yes
`l1`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l2`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`l3`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`entitlementsCount`	inteiro	int32	Não
`targetDate`	cadeia	date-time	Yes
`owner`	cadeia		Yes
`nextActionDate`	cadeia	date-time	Yes
`notes`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Yes

Contatos – vários locatários

Recupera informações de contato para vários locatários. Limitado a 25 IDs de locatário por chamada.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts

Contatos – vários locatários: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`rfaId`	CONSULTA	Não	inteiro	int32	Não
`partnerReferralId`	CONSULTA	Não	cadeia	identificador único universal (UUID)	Não
`partnerReferralNumber`	CONSULTA	Não	cadeia		Não
`contactTypeId`	Caminho	Yes	inteiro	int32	Não
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não

Contatos – múltiplos locatários: cabeçalho de requisição

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Contatos – vários locatários: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Contatos – vários locatários: definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	objeto		Não	Uma classe que representa dados paginados da API.
`rfaId`	inteiro	int32	Yes	O RFAID associado à solicitação, se houver.
`count`	inteiro	int32	Não	O número total de itens disponíveis no conjunto de dados.
`hasMore`	boolean		Não	Indicar se há mais dados a serem recuperados.
`items`	matriz		Yes	Os itens incluídos na página.
`<array item>`	objeto		Não
`contactId`	cadeia	identificador único universal (UUID)	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`email`	cadeia		Yes
`phone`	cadeia		Yes
`managerName`	cadeia		Yes
`managerEmail`	cadeia		Yes
`title`	cadeia		Yes
`evidence`	cadeia		Yes
`surveyEligible`	boolean		Yes
`note`	cadeia		Yes
`created`	cadeia	date-time	Não
`createdBy`	cadeia		Yes
`modified`	cadeia	date-time	Não
`modifiedBy`	cadeia		Yes
`timeZone`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`countryRegion`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`adminType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`surveyLanguage`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`contactType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`services`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Contatos – inquilino específico ou tipo de contato

Cria um novo contato sob um locatário e tipo de contato especificados.

POST https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts

Contatos – locatário específico ou tipo de contato: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`contactTypeId`	Caminho	Yes	inteiro	int32	Não

Contatos – locatário ou tipo de contato específico: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Contatos – inquilino ou tipo de contato específico: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Contatos – inquilino ou tipo de contato específico: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`contactId`	cadeia	identificador único universal (UUID)	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`email`	cadeia		Yes
`phone`	cadeia		Yes
`managerName`	cadeia		Yes
`managerEmail`	cadeia		Yes
`title`	cadeia		Yes
`isEngaged`	boolean		Yes
`isFastTrackContact`	boolean		Yes
`evidence`	cadeia		Yes
`surveyEligible`	boolean		Yes
`approvedSurvey`	cadeia		Yes
`note`	cadeia		Yes
`created`	cadeia	date-time	Não
`createdBy`	cadeia		Yes
`modified`	cadeia	date-time	Não
`modifiedBy`	cadeia		Yes
`timeZone`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`countryRegion`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`adminType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`surveyLanguage`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`contactType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`skillTypes`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`services`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

ID de contato – atualizar detalhes do contato

Atualiza os detalhes de um contato específico (como nome, email, função, status de participação, configurações de pesquisa e serviços ou habilidades associados) para um determinado locatário e tipo de contato.

PATCH https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts/{contactId}

ID de contato – atualizar detalhes do contato: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`contactId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`contactTypeId`	Caminho	Yes	inteiro	int32	Não

ID de contato – atualizar detalhes do contato: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

ID de contato – atualizar detalhes do contato: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

ID de contato – atualizar detalhes do contato: Definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`contactId`	cadeia	identificador único universal (UUID)	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`email`	cadeia		Yes
`phone`	cadeia		Yes
`managerName`	cadeia		Yes
`managerEmail`	cadeia		Yes
`title`	cadeia		Yes
`isEngaged`	boolean		Yes
`isFastTrackContact`	boolean		Yes
`evidence`	cadeia		Yes
`surveyEligible`	boolean		Yes
`approvedSurvey`	cadeia		Yes
`note`	cadeia		Yes
`created`	cadeia	date-time	Não
`createdBy`	cadeia		Yes
`modified`	cadeia	date-time	Não
`modifiedBy`	cadeia		Yes
`timeZone`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`countryRegion`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`adminType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`surveyLanguage`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes
`contactType`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`skillTypes`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`services`	matriz		Yes
`<array item>`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

ID de contato – excluir um contato

Exclui um contato de um locatário.

DELETE https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/contactTypes/{contactTypeId}/contacts/{contactId}

ID de contato – excluir um contato: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`contactTypeId`	Caminho	Yes	inteiro	int32	Não
`contactId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não

ID de contato – excluir um contato: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

ID de contato – excluir um contato: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Notas – obter contato com o locatário

Obtém os contatos de um locatário.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/notes

Notas – obter contato do locatário: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`noteCategoryId`	CONSULTA	Yes	inteiro	int32	Não
`rfaId`	CONSULTA	Não	inteiro	int32	Não
`partnerReferralId`	CONSULTA	Não	cadeia	identificador único universal (UUID)	Não
`partnerReferralNumber`	CONSULTA	Não	cadeia		Não
`orderByCreated`	CONSULTA	Não	cadeia		Não	Direção de ordenação para resultados.
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não

Anotações – obter contato do locatário: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Notas – obter contato do locatário: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Notas – obter contato com o locatário: Definições

Nome	Tipo	Formato	Nullable	Definição
`<root>`	objeto		Não
`rfaId`	inteiro	int32	Yes	O RFAID associado à solicitação, se houver.
`count`	inteiro	int32	Não	O número total de itens disponíveis no conjunto de dados.
`hasMore`	boolean		Não	Indicar se há mais dados a serem recuperados.
`items`	matriz		Yes	Os itens incluídos na página.
`<array item>`	objeto		Não
`text`	cadeia		Yes
`author`	cadeia		Yes
`created`	cadeia	date-time	Yes
`noteCategory`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes
`tenantId`	cadeia	identificador único universal (UUID)	Não
`tenantName`	cadeia		Yes

Anotações – criar uma nova anotação

Cria uma nova anotação para um locatário especificado.

POST https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/notes

Observações – criar uma nova observação: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não

Anotações – criar uma nova nota: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Anotações – criar uma nova observação: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Anotações – criar uma nova observação: Definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`text`	cadeia		Yes
`author`	cadeia		Yes
`created`	cadeia	date-time	Yes
`noteCategory`	objeto		Não
`id`	inteiro	int32	Não
`name`	cadeia		Yes

Direitos de Uso Máximos – contagem de licenças

Obtém os registros de status de dados de contagem de licenças de um locatário para vários serviços.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/services/maxEntitlements

Max Entitlements – contagem de licenças: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`serviceIds`	CONSULTA	Não	matriz		Não

Máximo de direitos – contagem de licenças: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Limite de direitos – total de licenças: confirmações

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Máximo de direitos – contagem de licenças: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`tenantId`	cadeia	identificador único universal (UUID)	Não
`serviceId`	inteiro	int32	Não
`maxEntitledSeatCount`	inteiro	int32	Não

ID do locatário

Obtém algumas informações básicas sobre o locatário fornecido.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}

ID do locatário: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não

ID do locatário: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

ID do locatário: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

ID do locatário: definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`tenantId`	cadeia		Yes
`name`	cadeia		Yes
`tpid`	inteiro	int32	Yes

Assignments

Obtém as atribuições de um inquilino em um nível de inquilino e de serviço.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/assignments

Atribuições: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não

Atribuições: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Atribuições: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Atribuições: Definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`email`	cadeia	email	Não
`name`	cadeia		Não
`isPrimary`	boolean		Não
`primaryServices`	matriz
`<array item>`	objeto		Não
`id` (serviço)	inteiro	int32	Não
`name` (serviço)	cadeia		Não
`additionalServices`	matriz
`<array item>`	objeto		Não
`id` (serviço)	inteiro	int32	Não
`name` (serviço)	cadeia		Não

Subscriptions

Retorna uma lista de assinaturas de locatários.

GET https://m365partner.microsoft.com/abss/v1.3/api/tenants/{tenantId}/subscriptions

Assinaturas: parâmetros de URI

Nome	Localidade	Required	Tipo	Formato	Nullable	Definição
`tenantId`	Caminho	Yes	cadeia	identificador único universal (UUID)	Não
`searchTerm`	CONSULTA	Não	cadeia		Não
`sortDirection`	CONSULTA	Não	cadeia		Não	Direção de ordenação para resultados.
`sortColumn`	CONSULTA	Não	inteiro	int32	Não
`page`	CONSULTA	Não	inteiro	int32	Não
`pageSize`	CONSULTA	Não	inteiro	int32	Não

Assinaturas: Cabeçalho da Solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Assinaturas: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Assinaturas: Definições

Nome	Tipo	Formato	Nullable
`<root>`	objeto		Não
`count`	inteiro	int32	Não
`hasMore`	boolean		Não
`items`	matriz		Yes
`<array item>`	objeto		Não
`skuName`	cadeia		Yes
`status`	cadeia		Yes
`subscriptionCurrentStateEndDate`	cadeia	date-time	Yes
`includedQuantity`	inteiro	int32	Yes
`subscriptionId`	cadeia		Yes
`subscriptionStartDate`	cadeia	date-time	Yes
`subscriptionEndDate`	cadeia	date-time	Yes
`workloadNames`	matriz		Yes
`<array item>`	cadeia		Não

Fusos horários

Procure contatos, uma lista de fusos horários.

GET https://m365partner.microsoft.com/abss/v1.3/api/timezones

Fusos horários: parâmetros de URI

None

Fusos horários: cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Fusos horários: respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Fusos horários: definições

Nome	Tipo	Formato	Nullable
`<root>`	matriz		Não
`<array item>`	objeto		Não
`id`	cadeia	identificador único universal (UUID)	Não
`name`	cadeia		Yes

Atual

Recupera o uso atual de todas as cargas de trabalho reivindicadas e não reivindicadas para locatários com pelo menos uma reivindicação sua.

GET https://m365partner.microsoft.com/abss/v1.3/api/usage/current

Parâmetros URI atuais

None

Atual: Cabeçalho da solicitação

Nome	Required	Tipo	Definição
Autorização	Verdade	cadeia	Token de portador de autorização

Atual: Respostas

Nome	Definição
200 OK	A solicitação foi bem-sucedida. O corpo das respostas contém as informações solicitadas. Tipos de mídia: application/json, text/plain, text/json
401 Não autorizado	A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Tipos de mídia: application/json, text/plain, text/json
403 Proibido	A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Tipos de mídia: application/json, text/plain, text/json
404 Não Encontrado	O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Tipos de mídia: application/json, text/plain, text/json
500 Erro interno do servidor	O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente: Tipos de mídia: application/json, text/plain, text/json

Atual: Definições

Nome	Tipo	Formato	Nullable	Enum	Definição
`<root>`	objeto		Não
`customers`	matriz		Yes		Lista de clientes associados ao parceiro atual e seus detalhes de carga de trabalho.
`<array item>`	objeto		Não
`customerId`	cadeia	identificador único universal (UUID)	Não		ID do locatário do cliente
`customerName`	cadeia		Yes		Nome do cliente
`domainName`	cadeia		Yes		Nome de domínio primário para o cliente.
`tags`	matriz		Yes		Etiquetas descritivas do tipo de cliente.
`<array item>`	cadeia		Não	Desconhecido, FRP, EDU
`workloads`	matriz		Yes		Lista de cargas de trabalho às quais seu MPN tem direito.
`<array item>`	objeto		Não
`workloadId`	cadeia		Não	Desconhecido, ExchangeOnline, SharePointOnline, MicrosoftTeams, Yammer, Office365ProPlus, MicrosoftIntune, AzureActiveDirectoryPremium, MicrosoftCloudAppSecurity, AzureAdvancedThreatProtection, OutlookMobile, OATP, MDATP, TeamsPhoneSystem, TeamsAppsAndPlatform, TeamsMeetings, MicrosoftInformationProtection, AADPConditionalAccess, InsiderRiskManager, VivaConnections, VivaInsights, VivaLearning, VivaTopics, AzureActiveDirectoryPremium2, TeamsForFrontlineWorkers, VivaGoals, TeamsRooms, Windows365, CopilotForMicrosoft365, ProjectAndPlanner
`workloadName`	cadeia		Yes		O nome da carga de trabalho.
`priorHwm`	inteiro	int64	Yes		O ponto máximo para a carga de trabalho no período anterior.
`hwm`	inteiro	int64	Yes		Novo recorde atual.
`month1Hwm`	inteiro	int64	Yes		O ponto alto para o primeiro mês da reivindicação.
`activeEntitlements`	inteiro	int32	Não		Direitos ativos atuais para a carga de trabalho.
`qualifiedEntitlements`	inteiro	int32	Não		Os direitos qualificados atuais atribuídos ao parceiro.
`usage`	número	duplo	Yes		Percentual de uso para a carga de trabalho.
`ratePerUnit`	inteiro	int32	Yes		A taxa de compensação por unidade de direitos
`maxCompUnits`	inteiro	int32	Yes		Unidades compensáveis máximas para a carga de trabalho.
`opportunityUnits`	inteiro	int32	Yes		Unidades de oportunidade para as cargas de trabalho.
`potentialEarnings`	inteiro	int32	Yes		Ganhos potenciais disponíveis para a carga de trabalho.
`mpnId`	cadeia		Yes		O MPNID do parceiro que reivindicou a carga de trabalho.
`tags`	matriz		Yes		Lista de etiquetas associadas à carga de tarefa.
`<array item>`	cadeia		Não	Desconhecido, FRP
`dateAssociated`	cadeia	date-time	Não		Data em que a carga de trabalho foi associada ao parceiro.
`claimId`	cadeia		Yes		ID da declaração de carga de trabalho do parceiro.
`usageAtClaim`	número	duplo	Yes		O percentual de uso no momento da declaração.
`excludedWorkloads`	matriz		Yes		Lista de cargas de trabalho indisponíveis para o parceiro.
`<array item>`	cadeia		Não	Desconhecido, ExchangeOnline, SharePointOnline, MicrosoftTeams, Yammer, Office365ProPlus, MicrosoftIntune, AzureActiveDirectoryPremium, MicrosoftCloudAppSecurity, AzureAdvancedThreatProtection, OutlookMobile, OATP, MDATP, TeamsPhoneSystem, TeamsAppsAndPlatform, TeamsMeetings, MicrosoftInformationProtection, AADPConditionalAccess, InsiderRiskManager, VivaConnections, VivaInsights, VivaLearning, VivaTopics, AzureActiveDirectoryPremium2, TeamsForFrontlineWorkers, VivaGoals, TeamsRooms, Windows365, CopilotForMicrosoft365, ProjectAndPlanner
`unclaimedWorkloads`	matriz		Yes		Lista de cargas de trabalho atualmente não reivindicadas para o cliente.
`<array item>`	objeto		Não
`workloadId`	cadeia		Não	Desconhecido, ExchangeOnline, SharePointOnline, MicrosoftTeams, Yammer, Office365ProPlus, MicrosoftIntune, AzureActiveDirectoryPremium, MicrosoftCloudAppSecurity, AzureAdvancedThreatProtection, OutlookMobile, OATP, MDATP, TeamsPhoneSystem, TeamsAppsAndPlatform, TeamsMeetings, MicrosoftInformationProtection, AADPConditionalAccess, InsiderRiskManager, VivaConnections, VivaInsights, VivaLearning, VivaTopics, AzureActiveDirectoryPremium2, TeamsForFrontlineWorkers, VivaGoals, TeamsRooms, Windows365, CopilotForMicrosoft365, ProjectAndPlanner
`workloadName`	cadeia		Yes		O nome da carga de trabalho.
`priorHwm`	inteiro	int64	Yes		O ponto máximo para a carga de trabalho no período anterior.
`hwm`	inteiro	int64	Yes		O ponto máximo atual para o
`month1Hwm`	inteiro	int64	Yes		O ponto alto para o primeiro mês da reivindicação.
`activeEntitlements`	inteiro	int32	Não		Direitos ativos atuais para a carga de trabalho.
`qualifiedEntitlements`	inteiro	int32	Não		Os direitos qualificados atuais atribuídos ao parceiro.
`usage`	número	duplo	Yes		Percentual de uso para a carga de trabalho.
`ratePerUnit`	inteiro	int32	Yes		A taxa de compensação por unidade de direitos
`maxCompUnits`	inteiro	int32	Yes		Unidades compensáveis máximas para a carga de trabalho.
`opportunityUnits`	inteiro	int32	Yes		Unidades de oportunidade para as cargas de trabalho.
`potentialEarnings`	inteiro	int32	Yes		Ganhos potenciais disponíveis para a carga de trabalho.
`mpnId`	cadeia		Yes		O MPNID do parceiro que reivindicou a carga de trabalho.
`tags`	matriz		Yes		Lista de etiquetas associadas à carga de tarefa.
`<array item>`	cadeia		Não	Desconhecido, FRP
`dateAssociated`	cadeia	date-time	Não		Data em que a carga de trabalho foi associada ao parceiro.
`claimId`	cadeia		Yes		ID da declaração de carga de trabalho do parceiro.
`usageAtClaim`	número	duplo	Yes		O percentual de uso no momento da declaração.
`excludedWorkloads`	matriz		Yes		Lista de cargas de trabalho indisponíveis para o parceiro.
`<array item>`	cadeia		Não	`Unknown`, `ExchangeOnline`, `SharePointOnline`, `MicrosoftTeams`, `Yammer`, `Office365ProPlus`, `MicrosoftIntune`, `AzureActiveDirectoryPremium`, `MicrosoftCloudAppSecurity`, `AzureAdvancedThreatProtection`, `OutlookMobile`, `OATP`, `MDATP`, `TeamsPhoneSystem`, `TeamsAppsAndPlatform`, `TeamsMeetings`, `MicrosoftInformationProtection`, `AADPConditionalAccess`, `InsiderRiskManager`, `VivaConnections`, `VivaInsights`, `VivaLearning`, `VivaTopics`, `AzureActiveDirectoryPremium2`, `TeamsForFrontlineWorkers`, `VivaGoals`, `TeamsRooms`, `Windows365`, `CopilotForMicrosoft365`, `ProjectAndPlanner`
`unclaimedWorkloads`	matriz		Yes		Lista de cargas de trabalho atualmente não reivindicadas para o cliente.
`<array item>`	objeto		Não
`workloadId`	cadeia		Não	`Unknown`, `ExchangeOnline`, `SharePointOnline`, `MicrosoftTeams`, `Yammer`, `Office365ProPlus`, `MicrosoftIntune`, `AzureActiveDirectoryPremium`, `MicrosoftCloudAppSecurity`, `AzureAdvancedThreatProtection`, `OutlookMobile`, `OATP`, `MDATP`, `TeamsPhoneSystem`, `TeamsAppsAndPlatform`, `TeamsMeetings`, `MicrosoftInformationProtection`, `AADPConditionalAccess`, `InsiderRiskManager`, `VivaConnections`, `VivaInsights`, `VivaLearning`, `VivaTopics`, `AzureActiveDirectoryPremium2`, `TeamsForFrontlineWorkers`, `VivaGoals`, `TeamsRooms`, `Windows365`, `CopilotForMicrosoft365`, `ProjectAndPlanner`
`workloadName`	cadeia		Yes		O nome da carga de trabalho.
`priorHwm`	inteiro	int64	Yes		O ponto máximo para a carga de trabalho no período anterior.
`hwm`	inteiro	int64	Yes
`month1Hwm`	inteiro	int64	Yes		O ponto alto para o primeiro mês da reivindicação.
`activeEntitlements`	inteiro	int32	Não		Direitos ativos atuais para a carga de trabalho.
`qualifiedEntitlements`	inteiro	int32	Não		Os direitos qualificados atuais atribuídos ao parceiro.
`usage`	número	duplo	Yes		Percentual de uso para a carga de trabalho.
`ratePerUnit`	inteiro	int32	Yes		A taxa de compensação por unidade de direitos.
`maxCompUnits`	inteiro	int32	Yes		Unidades compensáveis máximas para a carga de trabalho.
`opportunityUnits`	inteiro	int32	Yes		Unidades de oportunidade para as cargas de trabalho.
`potentialEarnings`	inteiro	int32	Yes		Ganhos potenciais disponíveis para a carga de trabalho.
`dateLastUpdated`	cadeia	date-time	Não		Última vez em que os dados de uso atuais foram atualizados na fonte de dados.

Comentários

Esta página foi útil?

Last updated on 2026-04-13