Usar a API de cenários de negócios no Microsoft Graph (versão prévia)

  • Artigo

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

A API de cenários de negócios permite a criação e o gerenciamento de cenários de negócios que configuram e gerenciam a integração de dados ao Microsoft Graph.

Estrutura de um cenário de negócios

Um cenário de negócios é representado pela entidade businessScenario . Um recurso businessScenario especifica informações gerais sobre o cenário, os aplicativos que usam esse cenário e configurações para entidades que os aplicativos podem gerenciar para dar suporte ao cenário. Os aplicativos podem identificar a instância do businessScenario pela propriedade uniqueName usando um formato de nome de domínio reverso.

Entidades disponíveis em cenários de negócios

A API de cenários de negócios foi projetada para permitir que os serviços do Microsoft Graph a estendam para dar suporte a cenários específicos do serviço específicos para os clientes.

Atualmente, Planner estendeu a API. A API dá suporte a dados de cenário personalizados para Planner na entidade businessScenarioTask.

Observação

Você tem um cenário que requer trazer dados personalizados como entidades para outro serviço do Microsoft 365? Sugira o recurso ou vote em solicitações de recurso existentes.

Criando um cenário de negócios

Cenários de negócios podem ser criados por aplicativos usando a permissão BusinessScenarioConfig.ReadWrite.OwnedBydelegada . A criação de um cenário de negócios requer a especificação de um nome de exibição e um nome exclusivo. O nome exclusivo deve estar no formato DNS reverso para evitar conflitos entre cenários independentes. O formato DNS reverso usa o nome de domínio que o criador do cenário possui e o inverte. Por exemplo, se um desenvolvedor que possui apps.contoso.com cria um cenário, o nome exclusivo do cenário deve começar com com.contoso.apps. Em seguida, outros segmentos podem ser adicionados a cenários diferenciados ou grupos de cenários; por exemplo, com.contoso.apps.customerSupport.ticketManagement. O nome exclusivo do cenário deve ser distinto de todos os outros cenários implantados em um locatário.

Para obter mais informações, consulte Criar businessScenario.

Configurando comportamentos para entidades

Cada serviço com suporte por meio de cenários de negócios fornece configurações no cenário. Os aplicativos precisam ter a BusinessScenarioConfig.Read.OwnedBy permissão para poder acessar essas configurações e a BusinessScenarioConfig.ReadWrite.OwnedBy permissão para poder alterá-las. Cada configuração é específica para o serviço. Para obter mais detalhes, confira os seguintes tópicos específicos do serviço:

Criando e gerenciando dados para um cenário de negócios

Cada serviço com suporte por meio de cenários de negócios fornece acesso aos dados em um cenário. Os aplicativos precisam ser listados como proprietários em um cenário para trabalhar com os dados no cenário. Os aplicativos também precisam ter a BusinessScenarioData.Read.OwnedBy permissão para poder ler os dados e a BusinessScenarioData.ReadWrite.OwnedBy permissão para poder criar novos dados ou modificar dados criados anteriormente. Para obter mais detalhes, confira os seguintes tópicos específicos do serviço:

Excluindo um cenário de negócios

Aplicativos que possuem um cenário de negócios podem excluir o cenário se tiverem a BusinessScenarioConfig.ReadWrite.OwnedBy permissão. Excluir o cenário remove todos os dados associados ao cenário também.

Para obter mais informações, consulte Excluir businessScenario.

Casos de uso comuns

Casos de uso Recursos REST Confira também
Criar, ler, atualizar e excluir cenários de negócios businessScenario Métodos de businessScenario
Configurar cenários de negócios para Planner plannerPlanConfigurationplannerTaskConfiguration Métodos de plannerPlanConfigurationMethods of plannerTaskConfiguration
Criar, ler, atualizar e excluir tarefas de cenário de negócios no Planner businessScenarioTask businessScenarioTask

Próximas etapas

A API de cenários de negócios permite que os aplicativos modelem e integrem processos de negócios de trabalho reais com um serviço do Microsoft 365 no Microsoft Graph. Para saber mais:

  • Examine os métodos e as propriedades dos recursos mais úteis para o seu cenário.
  • Experimente a API no Explorador do Graph.