Update schemaExtension

Namespace: microsoft.graph

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.

Atualizar propriedades na definição do schemaExtension especificado. Atualizações aditivas na extensão só podem ser feitas quando a extensão estiver no InDevelopment status ou Available . Isso significa que propriedades personalizadas ou tipos de recursos de destino não podem ser removidos da definição, mas novas propriedades personalizadas podem ser adicionadas e a descrição da extensão alterada.

A atualização se aplica a todos os recursos incluídos na propriedade targetTypes da extensão. Esses recursos estão entre os tipos de recursos de suporte.

Para fluxos delegados, o usuário conectado pode atualizar uma extensão de esquema, desde que a propriedade owner da extensão esteja definida como o appId de um aplicativo que o usuário conectado possui. Esse aplicativo pode ser aquele que criou inicialmente a extensão ou algum outro aplicativo pertencente ao usuário conectado.

Esses critérios para a propriedade owner permitem que um usuário conectado faça atualizações por meio de outros aplicativos que não possui, como o Microsoft Graph Explorer. Ao usar o Graph Explorer para atualizar um recurso schemaExtension, inclua a propriedade owner no corpo da solicitação PATCH.

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) Application.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Application.ReadWrite.All e Directory.ReadWrite.All Indisponível.

Solicitação HTTP

PATCH /schemaExtensions/{id}

Cabeçalhos de solicitação opcionais

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade. Para obter o melhor desempenho, não inclua valores existentes que não foram alterados.

Propriedade Tipo Descrição
description String Descrição da extensão de esquema.
properties Coleção extensionSchemaProperty A coleção de tipos e nomes de propriedades que compõem a definição da extensão de esquema. Somente alterações aditivas são permitidas.
status String O estado do ciclo de vida da extensão de esquema. O estado inicial na criação é InDevelopment. As transições de estados possíveis são de InDevelopment para Available e Available para Deprecated.
targetTypes Coleção de cadeias de caracteres O conjunto de tipos do Microsoft Graph (que podem suportar extensões) ao qual a extensão de esquema pode ser aplicada. Somente alterações aditivas são permitidas.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No Content. A tentativa de executar essa solicitação de um aplicativo que você não possui (e sem definir a propriedade owner como o appId de um aplicativo que você possui) retorna um 403 Forbidden código de resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação. Você deve incluir a propriedade owner se estiver executando a solicitação de um aplicativo que não é seu. Nesse caso, defina a propriedade owner como o appId de um aplicativo que você possui.

PATCH https://graph.microsoft.com/beta/schemaExtensions/exto6x7sfft_courses
Content-type: application/json

{
    "owner": "ef4cb9a8-97c3-4ca7-854b-5cb5ced376fa",
    "properties": [
        {
            "name": "courseId",
            "type": "Integer"
        },
        {
            "name": "courseName",
            "type": "String"
        },
        {
            "name": "courseType",
            "type": "String"
        },
        {
            "name": "courseSupervisors",
            "type": "String"
        }
    ]
}

Resposta

HTTP/1.1 204 No Content