site 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

site 资源提供 SharePoint 网站的元数据和关系。

方法

方法 REST 路径
创建 POST /sites
Get GET /sites/{site-id}
获取根网站 GET /sites/root
根据路径获取网站 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/{site-id}/pageTemplates/microsoft.graph.pageTemplate
列出根网站 GET /sites?filter=root ne null&select=siteCollection,webUrl
列出跨地理位置的网站 GET /site/getAllSites
列出网站的子网站 GET /sites/{site-id}/sites
搜索网站 GET /sites?search={query}
存档网站 POST /sites/{site-id}/archive
取消存档网站 POST /sites/{site-id}/unarchive
关注网站 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
List columns 获取 /sites/{site-id}/columns
创建列 发布 /sites/{site-id}/columns
创建文档处理作业 POST /sites/{site-id}/documentProcessingJobs
列举操作 GET /sites/{site-id}/operations
获取作状态 GET /sites/getOperationStatus (operationId='{siteOperationId}')
获取网站设置 GET /sites/{site-id}/settings
获取增量 GET /sites/delta
开放扩展
创建开放扩展 POST /sites/{site-id}/extensions
获取开放扩展 GET /sites/{site-id}/extensions
更新开放扩展 PATCH /sites/{site-id}/extensions
删除开放扩展 DELETE /sites/{site-id}/extensions

属性

属性 类型 说明
createdDateTime DateTimeOffset 创建网站的日期和时间。 只读。 继承自 baseItem
description String 网站的描述性文本。 继承自 baseItem
displayName String 网站的完整标题。 只读。
eTag String 站点的 ETag。 只读。 继承自 baseItem
id String 网站 的唯一标识符 。 只读。 继承自 baseItem
lastModifiedDateTime DateTimeOffset 上次修改网站的日期和时间。 只读。 继承自 baseItem
区域设置 String 网站的语言设置。
lockState siteLockState 站点的状态。 可能的值为:unlocked、、lockedReadOnlylockedNoAccesslockedNoAdditionsunknownFutureValue
name String 站点的名称。 继承自 baseItem
ownerIdentityToResolve identityInput 仅在创建网站时提供的网站所有者。
root root 如果存在,请在网站集中提供根网站。 只读。
settings siteSettings 此网站上的设置。 只读。
shareByEmailEnabled 布尔值 确定是否可以通过电子邮件共享网站及其内容。
sharepointIds sharepointIds 返回对 SharePoint REST 兼容性有用的标识符。 只读。
siteCollection siteCollection 提供有关网站的网站集的详细信息。 仅在根站点上可用。 只读。
template siteTemplateType 指定应用于网站的模板。 可能的值包括 sitepagepublishinggroupstsunknownFutureValue
webUrl String 只能在创建网站时提供的网站 URL。 只读。 继承自 baseItem

id 属性

site 由一个唯一 ID 标识,此唯一 ID 由以下值组成:

  • 网站集主机名称 (contoso.sharepoint.com)
  • 网站集的唯一 ID (GUID)
  • 网站的唯一 ID (GUID)

root 标识符经常用于引用给定目标的根网站,如下所示:

  • /sites/root:租户根网站。
  • /groups/{group-id}/sites/root:该组的团队网站。

关系

关系 类型 说明
分析 itemAnalytics 有关此网站上发生的视图活动的分析。
columns columnDefinition 集合 可以在此网站下方的列表中重复使用的列定义集合。
contentModels contentModel 集合 应用于此网站的内容模型集合。
contentTypes contentType 集合 为此网站定义的内容类型集合。
drive drive 此网站的默认驱动器(文档库)。
documentProcessingJobs documentProcessingJob 集合 此站点上运行的文档处理作业。
drives drive 集合 网站下方的驱动器集合(文档库)。
extensions 扩展集合 为此网站定义的开放扩展的集合。 可为 Null。
externalColumns columnDefinition 集合 从当前网站的父层次结构中的网站引用的网站中可用的列定义的集合。
items baseItem 集合 用于处理此网站中包含的任何项目。 无法枚举此集合。
lists 列表 集合 此网站下方的列表集合。
operations richLongRunningOperation 集合 站点长时间运行操作的集合。
pages baseSitePage 集合 此网站上 baseSitePages 列表中的页面集合。
pageTemplates pageTemplate 集合 此网站上的页面模板集合。
permissions permission 集合 与网站关联的权限。 可为空。
recycleBin recycleBin 此网站中 回收BinItem 资源的集合的容器。
sites 网站 网站下方的子网站的集合。
termStore microsoft.graph.termStore.store 此站点下的术语库。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

site 资源派生自 baseItem,并继承此资源的属性。

{
  "displayName": "string",
  "id": "string",
  "locale": "String",
  "lockState": "String",
  "ownerIdentityToResolve": {"@odata.type": "microsoft.graph.identityInput"},
  "root": { "@odata.type": "microsoft.graph.root" },
  "settings": { "@odata.type": "microsoft.graph.sitesettings" },
  "shareByEmailEnabled": "Boolean",
  "sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
  "siteCollection": {"@odata.type": "microsoft.graph.siteCollection"},
  "template": "String",

  /* relationships */
  "analytics": { "@odata.type": "microsoft.graph.itemAnalytics" },
  "columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
  "contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
  "extensions": [ { "@odata.type": "microsoft.graph.extension" }],
  "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"
}