Use a API de cenários de negócios no Microsoft Graph para se integrar ao Planner (versão prévia)

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 de tarefas Planner com políticas controladas por cenários, em um destino especificado.

Planner configuração

Os aplicativos podem configurar Planner entidades de duas maneiras quando usam a API de cenários de negócios. O seguinte lista as maneiras com suporte:

• A configuração do plano que define os elementos dos planos criados para hospedar tarefas de cenário
• A configuração de tarefa que controla como as tarefas criadas se comportam para usuários e aplicativos

Configuração do plano

A configuração do plano é representada pela entidade plannerPlanConfiguration . Na configuração do plano, o aplicativo pode configurar os buckets que aparecem no plano, a ordem desses buckets, bem como o título do plano e o nome dos buckets. Cada bucket é identificado por uma ID externa que pode ser usada quando você cria ou atualiza tarefas para colocá-las no bucket correto. Os buckets configurados na configuração do plano não especificam nenhum nome a ser usado, em vez disso, essas informações fazem parte dos nomes localizados. A configuração do plano também especifica nomes localizados para o plano e os buckets, bem como o código de idioma padrão. Atualmente, os itens criados usam o idioma padrão.

Configuração da tarefa

A configuração da tarefa é representada pela entidade plannerTaskConfiguration . Na configuração da tarefa, o aplicativo pode configurar as políticas que restringem o acesso aos aplicativos e usuários que usam as tarefas gerenciadas pelo cenário. As políticas são agrupadas por funções. Cada função identifica um grupo de chamadores e cada grupo pode ter regras diferentes especificadas para eles. As regras que se aplicam a uma chamada específica são escolhidas na ordem a seguir. Somente as primeiras regras especificadas se aplicam quando uma solicitação modifica uma tarefa.

• taskAssignees: aplica-se se a tarefa de destino for atribuída ao usuário que faz a chamada.
• groupOwners: aplica-se se o usuário que faz a chamada for um proprietário do contêiner em que o plano da tarefa de destino está.
• groupMembers: aplica-se se o usuário que faz a chamada for um membro do contêiner em que o plano da tarefa está.
• applications: aplica-se se o chamador for permissões de aplicativo, portanto, a chamada não está associada a um usuário.
• defaultRules: aplica-se quando nenhuma das outras condições corresponde.

Nota: Essas regras restringem o que o chamador pode fazer, mas não podem permitir que o chamador execute operações às quais, de outra forma, não seriam permitidas.

Cada função especifica uma regra padrão e regras para ações e campos específicos na tarefa. A regra padrão deve ser allow ou block. Se uma ação ou campo não tiver uma regra definida para ela, a regra padrão será usada para mantê-la irrestrita para allow, ou impedida de ser usada para block. Tenha em mente que isso se aplica quando novas propriedades e ações estão disponíveis para serem configuradas, mas a configuração do cenário ainda não está atualizada para especificar regras para elas.

Para obter mais informações sobre como usar regras, consulte Configurando regras de tarefa em Planner.

Como direcionar tarefas

As tarefas criadas são colocadas em planos com base no destino especificado quando são criadas. Na versão atual, um grupo pode ser direcionado. A tarefa é colocada no plano associado ao cenário nesse grupo. Se o grupo não tiver um plano para o cenário, um novo plano será criado com base na configuração do plano.

Metadados de tarefa e comportamento

Como parte das tarefas, as propriedades do cenário são necessárias. Essas propriedades incluem a ID externa da tarefa, que é necessária para ser especificada para cada tarefa. Esse valor deve ser exclusivo dentro do locatário. Se você criar uma segunda tarefa com a mesma ID externa, ela fará com que a primeira tarefa seja retornada sem modificações. Você também pode usar a ID externa como uma chave alternativa ao trabalhar com tarefas. Além disso, você pode especificar uma ID de contexto para cada tarefa. Esse valor pode ser usado para consultar as tarefas com a mesma ID de contexto, permitindo que os aplicativos agrupam tarefas entre planos.