使用 Microsoft Graph 中的 SharePoint 网站
Microsoft Graph 中的 SharePoint API 支持以下核心情形:
- 访问 SharePoint 网站、列表 和 驱动器(文档库)
- 支持对 site 资源进行只读访问(无法创建新网站)
- 支持对 lists、listItems 和 driveItems 进行读写访问
- 用 SharePoint ID、URL 或相对路径表示的 Address 资源
SharePoint API 公开了三种主要资源类型:
下面的示例展示了 listItem 资源。
{
"fields": {
"Title": "Access card",
"Employee": "Ryan Gregg",
"EmployeeId": "10",
"CardSerial": "01235492",
"Alias": "RGregg",
"ID": 1,
"ContentType": "Item",
"Modified": "2016-09-19T23:15:25-07:00",
"Created": "2016-09-19T23:15:25-07:00"
},
"createdBy": {
"user": {
"id": "b757fdcb-0271-4807-b243-504139e4ba04",
"displayName": "Ryan Gregg"
}
},
"createdDateTime": "2016-09-20T06:15:25Z",
"eTag": "48e941c3-9515-4c48-9760-c07c90c79d48,1",
"id": "4",
"lastModifiedBy": {
"user": {
"id": "b757fdcb-0271-4807-b243-504139e4ba04",
"displayName": "Ryan Gregg"
}
},
"lastModifiedDateTime": "2016-09-20T06:15:25Z",
}
资源通过三种不同的方式公开数据:
- 属性(如 id 和 name)公开简单值。
- Facet(如 fields 和 createdBy)公开复杂值。
- 引用(如 items)指向其他资源的集合。
可以使用 expand 查询参数展开 URL 中的引用;例如 ?expand=fields。
可以使用 select 查询参数请求特定属性和 facet;例如 ?select=id,name。
默认情况下,虽然大部分属性和 Facet 都会返回,但所有引用都会被隐藏。
为了提高效率,建议将 select 和 expand 指定为仅返回你关注的数据。
SharePoint API 根资源
以下示例与 https://graph.microsoft.com/v1.0 有关。
| 路径 | 说明 |
|---|---|
| /sites/root | 组织的默认网站。 |
| /sites/{site-id} | 通过其 ID 访问特定网站。 |
| /sites/{site-id}/drive | 访问给定网站的默认驱动器(文档库)。 |
| /sites/{site-id}/drives | 枚举网站下的驱动器(文档库)。 |
| /sites/{site-id}/sites | 枚举网站下的子网站。 |
| /sites/{site-id}/lists | 枚举网站下的列表。 |
| /sites/{site-id}/lists/{list-id}/items | 枚举列表下的 listItem。 |
| /groups/{group-id}/sites/root | 访问组的团队网站。 |
还可以使用 SharePoint 主机名,后面加上冒号和网站的相对路径,来为网站寻址。可以选择将另一个冒号置于末尾,转回为资源模型寻址。
| Path | 说明 |
|---|---|
| /sites/contoso.sharepoint.com:/teams/hr | 与 https://contoso.sharepoint.com/teams/hr 相关联的网站 |
| /sites/contoso.sharepoint.com:/teams/hr:/drive | 访问此网站的默认驱动器。 |
现有 SharePoint 开发人员须知
Microsoft Graph SharePoint API 与 CSOM API 有几个主要区别。
网站 资源映射到 SPWeb。
网站集中的根网站 (SPWeb) 具有 siteCollection facet,其中包含有关 SPSite 的信息。
由于网站 ID 只在其网站集中是唯一的,因此按 ID 为网站寻址需要提供网站集标识符和网站标识符。
GET https://graph.microsoft.com/v1.0/sites/{hostname},{spsite-id},{spweb-id}/
仅使用主机名构造的 URL 将指向默认网站集中的根网站 (SPWeb)。
GET https://graph.microsoft.com/v1.0/sites/{hostname}
仅使用主机名和 siteCollection (SPSite) ID 构造的 URL 将指向给定网站集中的根网站 (SPWeb)。
GET https://graph.microsoft.com/v1.0/sites/{hostname},{spsite-id}
仅使用 siteCollection (SPSite) ID 构造的 URL 将指向给定网站集中的根网站 (SPWeb)。
GET https://graph.microsoft.com/v1.0/sites/{spsite-id}
最近更新
了解此 API 集的最新功能和更新。
反馈
提交和查看相关反馈