Utilizar a API de cenários empresariais no Microsoft Graph (pré-visualização)
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 empresariais permite a criação e gestão de cenários empresariais que configuram e gerem a integração de dados no Microsoft Graph.
Estrutura de um cenário empresarial
Um cenário empresarial é representado pela entidade businessScenario . Um recurso businessScenario especifica informações gerais sobre o cenário, as aplicações que utilizam esse cenário e as configurações para entidades que as aplicações podem gerir para suportar o cenário. As aplicações podem identificar a instância de businessScenario pela propriedade uniqueName com um formato de nome de domínio inverso.
Entidades disponíveis em cenários empresariais
A API de cenários empresariais foi concebida para permitir que os serviços do Microsoft Graph o expandam para suportar cenários específicos do serviço específicos dos clientes.
Atualmente, o Planner expandiu a API. A API suporta dados de cenários personalizados para o Planner na entidade businessScenarioTask .
Observação
Tem um cenário que requer a introdução de dados personalizados como entidades para outro serviço do Microsoft 365? Sugira a funcionalidade ou vote nos pedidos de funcionalidade existentes.
Criar um cenário empresarial
Os cenários empresariais podem ser criados por aplicações com a permissão BusinessScenarioConfig.ReadWrite.OwnedBydelegada . A criação de um cenário empresarial requer especificar um nome a apresentar e um nome exclusivo. O nome exclusivo deve estar no formato DNS inverso para evitar conflitos entre cenários independentes. O formato DNS inverso utiliza o nome de domínio que o criador do cenário possui e inverte-o. Por exemplo, se um programador proprietário apps.contoso.com criar um cenário, o nome exclusivo do cenário deve começar com com.contoso.apps. Em seguida, podem ser adicionados mais segmentos para diferenciar cenários ou grupos de cenários; por exemplo, com.contoso.apps.customerSupport.ticketManagement. O nome exclusivo do cenário tem de ser distinto de todos os outros cenários implementados num inquilino.
Para obter mais informações, consulte Criar businessScenario.
Configurar comportamentos para entidades
Cada serviço suportado através de cenários empresariais fornece configurações no cenário. As aplicações precisam de ter permissão BusinessScenarioConfig.Read.OwnedBy para poder aceder a estas configurações e a BusinessScenarioConfig.ReadWrite.OwnedBy permissão para as poder alterar. Cada configuração é específica para o serviço. Para obter mais detalhes, veja os seguintes tópicos específicos do serviço:
- O Planner fornece as seguintes configurações:
Criar e gerir dados para um cenário empresarial
Cada serviço suportado através de cenários empresariais fornece acesso aos dados num cenário. As aplicações têm de ser listadas como proprietárias num cenário para trabalhar com os dados no cenário. As aplicações também precisam de ter permissão BusinessScenarioData.Read.OwnedBy para poder ler os dados e a BusinessScenarioData.ReadWrite.OwnedBy permissão para criar novos dados ou modificar dados criados anteriormente. Para obter mais detalhes, veja os seguintes tópicos específicos do serviço:
- Planner, com as seguintes entidades suportadas:
Eliminar um cenário empresarial
As aplicações proprietárias de um cenário empresarial podem eliminar o cenário se tiverem permissão BusinessScenarioConfig.ReadWrite.OwnedBy . Eliminar o cenário também remove todos os dados associados ao cenário.
Para obter mais informações, consulte Eliminar businessScenario.
Casos de uso comuns
| Casos de uso | Recursos REST | Confira também |
|---|---|---|
| Criar, ler, atualizar e eliminar cenários empresariais | businessScenario | Métodos de businessScenario |
| Configurar cenários empresariais para o Planner | plannerPlanConfigurationplannerTaskConfiguration | Métodos de plannerPlanConfigurationdo plannerTaskConfiguration |
| Criar, ler, atualizar e eliminar tarefas de cenário empresarial no Planner | businessScenarioTask | businessScenarioTask |
Próximas etapas
A API de cenários empresariais permite que as aplicações modelem e integrem processos empresariais de trabalho reais com um serviço do Microsoft 365 através do 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.