Compartilhar via

Atualizar sitePage

  • Artigo

Namespace: microsoft.graph

Atualize as propriedades de um objeto sitePage .

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

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Sites.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sites.ReadWrite.All Indisponível.

Solicitação HTTP

PATCH /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage

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 apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Esses campos e serão usados em solicitações de atualização.

Propriedade Tipo Descrição
description Cadeia de caracteres Descrição da página do site. Opcional.
miniaturaWebUrl Cadeia de caracteres Url da imagem da miniatura da página do site. Opcional.
title Cadeia de caracteres Título da página do site. Opcional.
showComments Booliano Booliano para determinar se deve ou não mostrar comentários na parte inferior da página. Opcional.
showRecommendedPages Booliano Booliano para determinar se deve ou não mostrar páginas recomendadas na parte inferior da página. Opcional.
promotionKind PagePromotionType Tipo de promoção da página do SharePoint. Opcional. Só há suporte para promover uma página (por exemplo, de page para newsPost). Não há suporte para o demote.
titleArea titleArea Área de título na página do site. Opcional.
canvasLayout canvasLayout O layout do conteúdo em uma página, incluindo seções horizontais e seção vertical. Um conteúdo de todo o layout da página precisa ser fornecido, a função de atualização não dá suporte a atualizações parciais. Opcional.

Notas: :

  1. Para garantir a análise bem-sucedida do corpo da solicitação, o @odata.type=#microsoft.graph.sitePage deve ser incluído no corpo da solicitação.
  2. Se você estiver usando a resposta da operação Obter página do site para atualizar uma página do site, recomendamos que você adicione o cabeçalho Accept: application/json;odata.metadata=noneHTTP . Isso removerá todos os metadados OData da resposta. Você também pode remover manualmente todos os metadados OData.
  3. Somente a Web Part listada na seção Web Parts com suporte tem suporte ao atualizar uma página do site usando o Microsoft API do Graph. A tentativa de adicionar web parts sem suporte resultará em uma falha ou exceção.

Web Parts com suporte

Há dois tipos de web parts que podem ser adicionados a um sitePage: standardWebParts e textWebPart. A tabela a seguir lista as Web Parts com suporte para web parts padrão.

# Web Part Tipo
1 Bing Mapas e377ea37-9047-43b9-8cdb-a761be2f8e09
2 Botão 0f087d7f-520e-42b7-89c0-496aaf979d58
3 Chamar para a ação df8e44e7-edd5-46d5-90da-aca1539313b8
4 Divisor 2161a1c6-db61-4731-b97c-3cdb303f7cbb
5 Inserção de documento b7dd04e1-19ce-4b24-9132-b60a1c2b910d
6 Image d1d91016-032f-456d-98a4-721247c305e8
7 Galeria de Imagens af8be689-990e-492a-81f7-ba3e4cd3ed9c
8 Visualização de link 6410b3b6-d440-4663-8744-378976dc041e
9 Organograma e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b
10 Pessoas 7f718435-ee4d-431c-bdbf-9c4ff326f46e
11 Ligações rápidas c70391ea-0b10-4ee9-b2b4-006d3fcad0cd
12 Espaçador 8654b779-4886-46d4-8ffb-b5ed960ee986
13 Inserção do Youtube 544dd15b-cf3c-441b-96da-004d5a8cea1d

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto sitePage atualizado no corpo da resposta.

Exemplos

Solicitação

Veja a seguir um exemplo de uma solicitação.

PATCH https://graph.microsoft.com/v1.0/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "title": "sample",
  "showComments": true,
  "showRecommendedPages": false
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7",
  "name": "sample.aspx",
  "webUrl": "https://contoso.sharepoint.com/SitePages/sample.aspx",
  "title": "sample",
  "pageLayout": "article",
  "showComments": true,
  "showRecommendedPages": false,
  "createdBy": {
    "user": {
      "displayName": "Rahul Mittal",
      "email": "rahmit@contoso.com"
    }
  },
  "lastModifiedBy": {
    "user": {
      "displayName": "Rahul Mittal",
      "email": "rahmit@contoso.com"
    }
  },
  "publishingState": {
    "level": "draft",
    "versionId": "0.1"
  },
  "titleArea": {
    "enableGradientEffect": true,
    "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg",
    "layout": "colorBlock",
    "showAuthor": true,
    "showPublishedDate": false,
    "showTextBlockAboveTitle": false,
    "textAboveTitle": "TEXT ABOVE TITLE",
    "textAlignment": "left",
    "title": "sample",
    "imageSourceType": 2
  }
}