Тип ресурса site
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Ресурс site предоставляет метаданные и связи для сайта SharePoint.
Методы
Метод | Путь REST |
---|---|
Получение корневого сайта | GET /sites/root |
Получение сайта | GET /sites/{site-id} |
Получение сайта по пути | GET /sites/{hostname}:/{site-path} |
Получение сайта для группы | GET /groups/{group-id}/sites/root |
Получение аналитики | GET /sites/{site-id}/analytics |
Получение действий по интервалу | GET /sites/{site-id}/getActivitiesByInterval |
Перечисление страниц | GET /sites/{site-id}/pages |
Перечисление корневых сайтов | GET /sites?filter=root ne null&select=siteCollection,webUrl |
Перечисление сайтов по географическим регионам | GET /site/getAllSites |
Поиск сайтов | GET /sites?search={query} |
Отслеживание сайта | POST /users/{user-id}/followedSites/add |
Прекращение отслеживания сайта | POST /users/{user-id}/followedSites/remove |
Перечисление отслеживаемых сайтов | GET /me/followedSites |
Получение разрешения | GET /sites/{site-id}/permissions/{permission-id} |
Список разрешений | GET /sites/{site-id}/permissions |
Создание разрешений | POST /sites/{site-id}/permissions |
Удаление разрешения | DELETE /sites/{site-id}/permissions/{permission-id} |
Обновление разрешения | PATCH /sites/{site-id}/permissions/{permission-id} |
Перечисление типов контента | GET /sites/{site-id}/contentTypes |
Создание contentType | POST /sites/{site-id}/contentTypes |
Перечисление столбцов | GET /sites/{site-id}/columns |
Создание столбца | POST /sites/{site-id}/columns |
Операции со списком | GET /sites/{site-id}/operations |
Получение параметров сайта | GET /sites/{site-id}/settings |
Свойства
Свойство | Тип | Описание |
---|---|---|
id | string | Уникальный идентификатор элемента. Только для чтения. |
createdDateTime | DateTimeOffset | Дата и время создания элемента. Только для чтения. |
description | string | Текст с описанием сайта. |
eTag | string | ETag для элемента. Только для чтения. |
displayName | string | Полное название сайта. Только для чтения. |
lastModifiedDateTime | DateTimeOffset | Дата и время последнего изменения элемента. Только для чтения. |
name | string | Имя или название элемента. |
root | root | Если это свойство присутствует, оно указывает на то, что сайт — корневой в семействе веб-сайтов. Только для чтения. |
settings | siteSettings | Параметры на этом сайте. Только для чтения. |
sharepointIds | sharepointIds | Возвращает идентификаторы, использующиеся для обеспечения совместимости с SharePoint REST. Только для чтения. |
siteCollection | siteCollection | Предоставляет сведения о семействе веб-сайтов сайта. Доступно только на корневом сайте. Только для чтения. |
webUrl | строка (url-адрес) | URL-адрес для отображения элемента в браузере. Только для чтения. |
Свойство id
Ресурс site идентифицируется посредством уникального идентификатора, при создании которого используются следующие значения:
- имя узла семейства веб-сайтов (contoso.sharepoint.com);
- уникальный идентификатор семейства веб-сайтов (GUID);
- уникальный идентификатор сайта (GUID).
Идентификатор root
всегда ссылается на корневой сайт указанного целевого объекта, как показано ниже.
/sites/root
. Корневой сайт клиента./groups/{group-id}/sites/root
. Сайт группы для ресурса group.
Связи
Связь | Тип | Описание |
---|---|---|
analytics | Ресурс itemAnalytics | Аналитические данные о действиях просмотра, выполненных на этом сайте. |
columns | Collection(columnDefinition) | Коллекция определений столбцов, которые можно повторно использовать в разных списках на этом сайте. |
contentTypes | Collection(contentType) | Коллекция типов контента, определенных для этого сайта. |
drive | drive | Диск по умолчанию (библиотека документов) для этого сайта. |
drives | Collection(drive) | Коллекция дисков (библиотек документов) на этом сайте. |
items | Collection(baseItem) | Используется для адресации любого элемента, содержащегося на этом сайте. Вам не удастся выполнить перечисление этой коллекции. |
lists | Collection(list) | Коллекция списков на этом сайте. |
operations | Коллекция richLongRunningOperation | Коллекция длительных операций для сайта. |
pages | Collection(baseSitePage) | Коллекция страниц в списке baseSitePages на этом сайте. |
permissions | Collection(permission) | Разрешения, связанные с сайтом. Допускается значение NULL. |
sites | Collection(site) | Коллекция дочерних сайтов этого сайта. |
termStore | microsoft.graph.termStore.store | TermStore на этом сайте. |
externalColumns | Collection(columnDefinition) | Коллекция определений столбцов, доступных на сайте, на которые ссылаются сайты в родительской иерархии текущего сайта. |
Представление JSON
Ниже указано представление ресурса в формате JSON.
Ресурс site является производным от ресурса baseItem и наследует его свойства.
{
"displayName": "string",
"id": "string",
"root": { "@odata.type": "microsoft.graph.root" },
"settings": { "@odata.type": "microsoft.graph.sitesettings" },
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"siteCollection": {"@odata.type": "microsoft.graph.siteCollection"},
/* relationships */
"analytics": { "@odata.type": "microsoft.graph.itemAnalytics" },
"columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
"contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
"externalColumns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
"drive": { "@odata.type": "microsoft.graph.drive" },
"drives": [ { "@odata.type": "microsoft.graph.drive" }],
"items": [ { "@odata.type": "microsoft.graph.baseItem" }],
"lists": [ { "@odata.type": "microsoft.graph.list" }],
"permissions": [ { "@odata.type": "microsoft.graph.permission" }],
"sites": [ { "@odata.type": "microsoft.graph.site"} ],
"termStore": { "@odata.type": "microsoft.graph.termStore.store" },
/* inherited from baseItem */
"createdDateTime": "datetime",
"description": "string",
"eTag": "string",
"lastModifiedDateTime": "datetime",
"name": "string",
"webUrl": "url"
}