Поделиться через

Обновление sitePage

  • Статья

Пространство имен: microsoft.graph

Обновление свойств объекта sitePage .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Sites.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Для приложений Sites.ReadWrite.All Недоступно.

HTTP-запрос

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

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

Укажите в тексте запроса только значения обновляемых свойств. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств.

В следующей таблице указаны свойства, которые можно обновить.

Эти поля и будут использоваться в запросах на обновление.

Свойство Тип Описание
description String Описание страницы сайта. Необязательный параметр.
thumbnailWebUrl String URL-адрес эскиза страницы сайта. Необязательный параметр.
title String Заголовок страницы сайта. Необязательный параметр.
showComments Логический Логическое значение, чтобы определить, следует ли отображать комментарии в нижней части страницы. Необязательный параметр.
showRecommendedPages Логический Логическое значение, чтобы определить, следует ли отображать рекомендуемые страницы в нижней части страницы. Необязательный параметр.
promotionKind PagePromotionType Тип продвижения страницы SharePoint. Необязательный параметр. Поддерживается только повышение уровня страницы (например, с до pagenewsPost). Понижение не поддерживается.
titleArea titleArea Область заголовка на странице сайта. Необязательный параметр.
canvasLayout canvasLayout Макет содержимого на странице, включая горизонтальные разделы и вертикальные разделы. Необходимо предоставить содержимое всего макета страницы. Функция обновления не поддерживает частичные обновления. Необязательный параметр.

Примечания: :

  1. Чтобы обеспечить успешное синтаксический анализ текста запроса, @odata.type=#microsoft.graph.sitePage необходимо включить в текст запроса.
  2. Если вы используете ответ от операции Get sitepage для обновления sitePage, рекомендуется добавить заголовок Accept: application/json;odata.metadata=noneHTTP . При этом все метаданные OData будут удалены из ответа. Вы также можете вручную удалить все метаданные OData.
  3. При обновлении sitePage с помощью microsoft API Graph поддерживается только веб-часть, указанная в разделе Поддерживаемые веб-части. Попытка добавить неподдерживаемые веб-части приведет к сбою или исключению.

Поддерживаемые веб-части

Существует два типа веб-частей, которые можно добавить в sitePage: standardWebParts и textWebPart. В следующей таблице перечислены поддерживаемые веб-части для стандартных веб-частей.

# Веб-часть Тип
1 Карты Bing 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 Image 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 544dd15b-cf3c-441b-96da-004d5a8cea1d

Отклик

В случае успешного выполнения этот метод возвращает код отклика 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
  }
}