Criar ou atualizar esquema

Namespace: microsoft.graph.externalConnectors

Crie um novo esquema ou atualize um esquema existente para uma conexão de Pesquisa da Microsoft.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
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.

Corpo da solicitação

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

Quando você registra um esquema de item personalizado, o objeto de esquemadeve ter a propriedade baseType definida microsoft.graph.externalItem como e deve conter a propriedade properties . O objeto propertiesdeve conter pelo menos uma propriedade, até no máximo 128.

Resposta

Se for bem-sucedido, esse método retornará um código de 202 Accepted resposta e uma URL no cabeçalho de Location resposta que podem ser usados para obter o status da operação.

Observação: Pode levar entre 5 e 15 minutos para que o esquema seja criado. Recomendamos que você use a URL no cabeçalho de Location resposta para obter o status da operação.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação para registrar um novo esquema personalizado ou atualizar um existente de forma assíncrona.

PATCH https://graph.microsoft.com/v1.0/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/v1.0/external/connections/contosohr/operations/616bfeed-666f-4ce0-8cd9-058939010bfc