Share via


Criar uma página na lista de páginas do site de um site

Namespace: microsoft.graph

Crie uma nova página do site na lista de páginas do site em um site.

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

POST /sites/{site-id}/pages

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 do recurso sitePage a ser criado.

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 criar um sitePage, 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 criar 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 201 e o objeto sitePage criado.

Exemplo

O exemplo a seguir mostra como criar uma nova página.

Solicitação

POST /sites/{site-id}/pages
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "name": "test.aspx",
  "title": "test",
  "pageLayout": "article",
  "showComments": true,
  "showRecommendedPages": false,
  "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",
    "imageSourceType": 2,
    "title": "sample1"
  },
  "canvasLayout": {
    "horizontalSections": [
      {
        "layout": "oneThirdRightColumn",
        "id": "1",
        "emphasis": "none",
        "columns": [
          {
            "id": "1",
            "width": 8,
            "webparts": [
              {
                "id": "6f9230af-2a98-4952-b205-9ede4f9ef548",
                "innerHtml": "<p><b>Hello!</b></p>"
              }
            ]
          },
          {
            "id": "2",
            "width": 4,
            "webparts": [
              {
                "id": "73d07dde-3474-4545-badb-f28ba239e0e1",
                "webPartType": "d1d91016-032f-456d-98a4-721247c305e8",
                "data": {
                  "dataVersion": "1.9",
                  "description": "Show an image on your page",
                  "title": "Image",
                  "properties": {
                    "imageSourceType": 2,
                    "altText": "",
                    "overlayText": "",
                    "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8",
                    "webid": "f3989670-cd37-4514-8ccb-0f7c2cbe5314",
                    "listid": "bdb41041-eb06-474e-ac29-87093386bb14",
                    "uniqueid": "d9f94b40-78ba-48d0-a39f-3cb23c2fe7eb",
                    "imgWidth": 4288,
                    "imgHeight": 2848,
                    "fixAspectRatio": false,
                    "captionText": "",
                    "alignment": "Center"
                  },
                  "serverProcessedContent": {
                    "imageSources": [
                      {
                        "key": "imageSource",
                        "value": "/_LAYOUTS/IMAGES/VISUALTEMPLATEIMAGE1.JPG"
                      }
                    ],
                    "customMetadata": [
                      {
                        "key": "imageSource",
                        "value": {
                          "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8",
                          "webid": "f3989670-cd37-4514-8ccb-0f7c2cbe5314",
                          "listid": "bdb41041-eb06-474e-ac29-87093386bb14",
                          "uniqueid": "d9f94b40-78ba-48d0-a39f-3cb23c2fe7eb",
                          "width": "4288",
                          "height": "2848"
                        }
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Resposta

Se for bem-sucedido, esse método retornará um sitePage no corpo da resposta para a página criada.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.type": "microsoft.graph.sitePage",
    "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7",
    "name": "test.aspx",
    "webUrl": "https://contoso.sharepoint.com/SitePages/test.aspx",
    "title": "test",
    "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": "checkout",
      "versionId": "0.1",
      "checkedOutBy": {
        "user": {
          "displayName": "Rahul Mittal",
          "email": "rahmit@contoso.com"
        }
      }
    },
    "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": "sample4",
        "imageSourceType": 2
    }
}

Observação: O objeto Response será truncado para mais clareza. As propriedades padrão serão retornadas da chamada real.