通过

更新 sitePage

  • 项目

命名空间：microsoft.graph

更新 sitePage 对象的属性。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） Sites.ReadWrite.All 不可用。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 Sites.ReadWrite.All 不可用。

HTTP 请求

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

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中， 仅 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值，或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

这些字段和 用于更新请求。

属性 类型 说明
说明 String 网站页面的说明。 可选。
thumbnailWebUrl String 网站页面缩略图的 URL。 可选。
title String 网站页的标题。 可选。
showComments 布尔值 布尔值，用于确定是否在页面底部显示批注。 可选。
showRecommendedPages 布尔值 布尔值，用于确定是否在页面底部显示建议的页面。 可选。
promotionKind PagePromotionType SharePoint 页面的促销类型。 可选。 仅支持将页面提升 (例如从 page 提升到 newsPost) 。 不支持降级。
titleArea titleArea 网站页面上的标题区域。 可选。
canvasLayout canvasLayout 页面中内容的布局，包括水平分区和垂直部分。 需要提供整个页面布局的内容，update 函数不支持部分更新。 可选。

备注： ：

  1. 若要确保成功分析请求正文， @odata.type=#microsoft.graph.sitePage 必须在请求正文中包含 。
  2. 如果使用 Get sitepage 操作的响应来更新 sitePage，建议添加 HTTP 标头 Accept: application/json;odata.metadata=none。 这将从响应中删除所有 OData 元数据。 还可以手动删除所有 OData 元数据。
  3. 使用 Microsoft 图形 API 更新 sitePage 时，仅支持“支持的 Web 部件”部分中列出的 Web 部件。 尝试添加不受支持的 Web 部件将导致失败或异常。

支持的 Web 部件

有两种类型的 Web 部件可以添加到 sitePage： standardWebParts 和 textWebPart。 下表列出了标准 Web 部件支持的 Web 部件。

# Web 部件 类型
1 必应地图 e377ea37-9047-43b9-8cdb-a761be2f8e09
2 按钮 0f087d7f-520e-42b7-89c0-496aaf979d58
3 行动号召 df8e44e7-edd5-46d5-90da-aca1539313b8
4 分 2161a1c6-db61-4731-b97c-3cdb303f7cbb
5 文档嵌入 b7dd04e1-19ce-4b24-9132-b60a1c2b910d
6 图像 d1d91016-032f-456d-98a4-721247c305e8
7 映像库 af8be689-990e-492a-81f7-ba3e4cd3ed9c
8 链接预览 6410b3b6-d440-4663-8744-378976dc041e
9 组织结构图 e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b
10 人员 7f718435-ee4d-431c-bdbf-9c4ff326f46e
11 快速链接 c70391ea-0b10-4ee9-b2b4-006d3fcad0cd
12 间隔 8654b779-4886-46d4-8ffb-b5ed960ee986
13 Youtube Embed 544dd15b-cf3c-441b-96da-004d5a8cea1d
14 标题区域 cbe7b0a9-3504-44dd-a3a3-0e5cacd07788

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和更新的 sitePage 对象。

示例

请求

请求示例如下所示。

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
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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
  }
}