Referência de API REST de controle e configurações de colaboração

Os desenvolvedores podem usar o controle colaboração e configurações da API REST para gerenciar configurações, iniciar, mapear e recuperar atividades de colaboração com suas próprias entidades de modelo de negócios.

Observação

Atualmente, os controles de colaboração estão disponíveis apenas na versão prévia do desenvolvedor público.

Este artigo fornece referência para a API REST da solução de controle de colaboração.

Operações REST: Colaboração – API Personalizada

Operação	Descrição
Mapa de Colaboração de Associação	Associa uma entidade colaborativa a uma sessão de colaboração.
Iniciar sessão de colaboração	Cria um registro de sessão de colaboração vinculado a uma entidade empresarial, contexto de aplicativo e metadados opcionais.
Desassociar mapa de colaboração	Desassocia uma entidade mapeada da sessão de colaboração fornecida.
Recuperar mapas de colaboração	Obtém uma lista de mapas de colaboração para uma sessão de um tipo de entidade específico.
Recuperar sessão de colaboração	Obtém um registro de sessão de colaboração com base nos parâmetros fornecidos.
Atualizar mapa de colaboração	Atualizações um registro de mapa de colaboração e seus metadados, se fornecidos.
Atualizar sessão de colaboração	Atualizações um registro de sessão de colaboração e, opcionalmente, seus metadados.

Operações REST: Colaboração – APIs OData Padrão

Operação	Descrição
Obter mapa de colaboração por Id	Obtém os detalhes de um registro de mapa de colaboração.
Obter metadados de colaboração	Obtém uma lista dos registros de metadados de colaboração para um determinado mapa de colaboração ou um nome de entidade raiz de colaboração.
Obter raiz de colaboração	Lista todas as sessões de colaboração criadas.

Operações REST: Configurações – APIs personalizadas

Operação	Descrição
Criar e atualizar configurações	Cria ou atualiza uma configuração que corresponde ao caminho do grupo e ao nome da definição de configurações.
Recuperar configurações nulas	Retorna uma lista de definições de configurações que não têm um valor.
Recuperar Configurações	Retorna uma lista de configurações ou configurações específicas em grupos.

Operações REST: Configurações – APIs OData padrão

Operação	Descrição
Definição de Configurações de Exclusão	Exclui uma definição de configurações.
Grupo Excluir Configurações	Exclui um grupo de configurações.
Tipo de Configurações de Exclusão	Exclua um tipo de configurações.
Valor de Configurações de Exclusão	Exclui um valor de configurações.
Obter definições de configurações	Lista definições de configurações.
Obter grupos de configurações	Lista grupos de configurações.
Obter tipos de configurações	Lista tipos de configurações.
Obter valor de configurações	Lista valores de configurações.
Definição de configurações de patch	Atualizações uma definição de configurações.
Grupo De Configurações de Patch	Atualizações um grupo de configurações.
Tipo de Configurações de Patch	Atualizações um tipo de configurações.
Valor de Configurações de Patch	Atualizações um valor de configuração.
Definição de Configurações de Post	Cria uma nova definição de configurações.
Grupo De Configurações de Post	Cria um grupo de configurações.
Tipo de Configurações de Post	Cria um tipo de configurações.
Valor de Configurações de Post	Cria um novo valor de configuração.