Compartilhar via


Criar esquema

Espaço de nomes: microsoft.graph.externalConnectors

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.

Crie um esquema novo ou atualize um esquema existente para uma ligação do Microsoft Search.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All

Solicitação HTTP

PATCH /external/connections/{id}/schema

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.
Preferir: responder-assíncrono Utilize esta opção para fazer com que o pedido seja executado de forma assíncrona. Opcional.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON de um objeto de esquema .

Quando regista um esquema de item personalizado, o objeto de esquematem de ter a propriedade tipo base definida como microsoft.graph.externalItem e tem de conter a propriedade propriedades . O objeto de propriedadestem de conter, pelo menos, uma propriedade, até um máximo de 128.

Resposta

Se for bem-sucedido, este método devolve um 202 Accepted código de resposta e um URL no cabeçalho de Location resposta que pode ser utilizado para obter o estado da operação.

Nota: Pode demorar entre 5 e 15 minutos para que o esquema seja criado. Recomendamos que utilize o URL no cabeçalho da Location resposta para obter o estado da operação.

Exemplos

Solicitação

O exemplo seguinte mostra um pedido para registar um novo ou atualizar um esquema personalizado existente de forma assíncrona.

PATCH https://graph.microsoft.com/beta/external/connections/contosohr/schema
Content-type: application/json

{
  "baseType": "microsoft.graph.externalItem",
  "properties": [
    {
      "name": "ticketTitle",
      "type": "string",
      "isSearchable": "true",
      "isRetrievable": "true",
      "labels": [
        "title"
      ]
    },
    {
      "name": "priority",
      "type": "string",
      "isQueryable": "true",
      "isRetrievable": "true",
      "isSearchable": "false"
    },
    {
      "name": "assignee",
      "type": "string",
      "isRetrievable": "true"
    }
  ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/beta/external/connections/contosohr/operations/616bfeed-666f-4ce0-8cd9-058939010bfc