Table of contents
TOC
折叠目录
展开目录
上次更新日期: 2018/7/10

OneNote 服务根 URL 为 OneNote API 的所有调用使用以下格式。

https://www.onenote.com/api/{version}/{location}/notes/


URL 中的 version 部分表示要使用的 OneNote API 的版本。

  • v1.0 用于稳定的生产代码。
  • 用于试用正在开发的功能。beta Beta 版中的特性和功能可能会有所更改,因此,不应将其用于生产代码。


URL 中的 location 部分表示要访问的笔记本的位置。

OneDrive 上的笔记本电脑(消费者)
针对当前用户可以访问的 OneNote 内容(拥有和共享)使用 me

OneDrive for Business 上的笔记本
对于当前用户拥有的 OneNote 内容,使用 me

针对(URL 中)指定的用户与当前用户共享的 OneNote 内容使用 users/{id}。 使用 Azure AD Graph API 可获取用户 ID。

SharePoint 网站笔记本
Team 网站和其他 SharePoint 网站可以在其文档库中包含 OneNote 笔记本。

对于当前用户登录的租户网站上的 OneNote 内容,使用 myOrganization/siteCollections/{id}/sites/{id}。 仅支持当前租户,使用 myOrganization 关键字访问。 了解如何获得网站 ID

Office 365 组笔记本
Office 365 组是 Office 365 互连体验的一部分。 组成员可以共享笔记本、文件和电子邮件。

对当前用户所属指定组中的 OneNote 内容使用 myOrganization/groups/{id}。 Office 365 组(返回统一 groupType)是唯一受支持的组类型。 使用 Azure AD Graph API 可获取组 ID。


使用 FromUrl 方法获取网站集和网站 ID

可以使用 FromUrl 方法获取指定绝对网站 URL 的网站集和网站 ID。 应该仅在需要时进行此调用,然后存储这些值以供将来使用。

站点 URL 的格式取决于配置,例如 https://domain.sharepoint.com/site-ahttps://domain.com/sites/site-a

示例请求:

GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')
Authorization: Bearer {token}
Accept: application/json

响应示例:

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.SiteMetadata",
  "siteCollectionId":"09d1a587-a84b-4264-3d15-669429be8cc5",
  "siteId":"d9e4d5c8-683f-4363-89ae-18c4e3da91e9"
}

使用 FromUrl 并使用 SharePoint 网站的笔记本的要求:

  • 只能在具有默认文档库的站点上创建 OneNote 笔记本、节组、节和页面。 (某些网站模板不会创建默认文档库。)但是,GET 请求会从网站上的所有文档库返回 OneNote 内容。
  • OneNote 服务根 URL 是不可变的,这意味着不能使用 SharePoint REST API 网站路径然后向其添加 notes 端点。
  • 代其调用的用户必须是该站点的成员。
  • FromUrl 仅适用于已编制索引的站点。 为新站点建立索引可能需要几个小时。
© 2018 Microsoft