支持的 REST 操作

适用于:OneDrive 上的消费者笔记本 | Office 365 上的企业级笔记本

本文列出了 OneNote API 适用的 REST 操作。

重要

API 控制台服务不再可用。 有关详细信息,请参阅我们是 Sunsetting 经典 API 控制台

页面操作

GET /pages

获取所有页面。

GET /pages?search

搜索页面。 (仅限消费者 OneDrive

GET /sections/{id}/pages

获取特定分区中的所有页面。

GET /sections/{id}/pages?pagelevel

获取某个分区中页面的缩进级别和顺序。 GET /pages/{id}?pagelevel 也支持。

GET /pages/{id}

获取特定页面。

GET /pages/{id}/preview

获取特定页面的文本和图像预览内容。

GET /pages/{id}/content

获取特定页面的 HTML 内容。

POST /pages

在默认分区创建一个页面。 (仅限 OneDrive 或 OneDrive for Business 上的个人笔记本

POST /pages?sectionName

在默认笔记本的命名分区创建一个页面。 (仅限 OneDrive 或 OneDrive for Business 上的个人笔记本

POST /sections/{id}/pages

在特定的分区创建一个页面。

POST /pages/{id}/copyToSection

将页面复制到分区 (仅限 Office 365

PATCH /pages/{id}/content

更新页面的 HTML 内容。

DELETE /pages/{id}

删除特定页面。

警告

使用 OneNote API 删除页面是永久性的。 已删除的页面无法恢复。


详细了解更多关于 GET 请求 (包括支持的查询字符串选项)以及如何创建页面更新页面内容复制页面的信息。

分区操作

GET /sections

获取所有分区。

GET /notebooks/{id}/sections

获取特定笔记本中的所有分区。

GET /sectionGroups/{id}/sections

获取特定分区组中的所有分区。

GET /sections/{id}

获取特定节。

POST /notebooks/{id}/sections

在特定笔记本中创建一个分区。

POST /sectionGroups/{id}/sections

在特定的分区组中创建一个分区。

PATCH /sections/{id}

更改分区的名称。 在消息正文中使用 application/json 内容类型发送新的名称,如下所示: { "name": "New section name" }

POST /sections/{id}/copyToNotebook

将分区复制到笔记本。 (仅限 Office 365

POST /sections/{id}/copyToSectionGroup

将分区复制到分区组 (仅限 Office 365

GET /sections/{id}/permissions

获取分区的权限。 (仅限 Office 365

GET /sections/{id}/permissions/{id}

获取分区的特定权限。 (仅限 Office 365

POST /sections/{id}/permissions

为分区创建或更新一项权限。 (仅限 Office 365

DELETE /sections/{id}/permissions/{id}

删除分区的一项权限。 (仅限 Office 365


详细了解更多关于 GET请求 (包括支持的查询字符串选项)以及如何复制分区的信息。

分区组操作

GET /sectionGroups

获取所有分区组。

GET /notebooks/{id}/sectionGroups

获取特定笔记本中的所有分区组。

GET /sectionGroups/{id}/sectionGroups

获取特定分区组中的所有分区组。

GET /sectionGroups/{id}

获取特定节组。

POST /notebooks/{id}/sectionGroups

在特定笔记本中创建一个分区组。

POST /sectionGroups/{id}/sectionGroups

在特定的分区组中创建一个分区组。

GET /sectiongroups/{id}/permissions

获取分区组的权限。 (仅限 Office 365

GET /permissions/{id}

|||UNTRANSLATED_CONTENT_START|||Get a specific permission for the section group.|||UNTRANSLATED_CONTENT_END||| (仅限 Office 365

POST /permissions

为分区组创建或更新一项权限。 (仅限 Office 365

DELETE /permissions/{id}

删除分区组的一项权限。 (仅限 Office 365


详细了解更多关于 GET请求 (包括支持的查询字符串选项)的信息。

笔记本操作

GET /notebooks

获取所有笔记本。

GET /notebooks/{id}

获取特定笔记本。

POST /notebooks

创建一个笔记本。

POST /notebooks/{id}/copyNotebook

复制笔记本。 (仅限 Office 365

GET /notebooks/{id}/permissions

获取笔记本的权限。 (仅限 Office 365

GET /permissions/{id}

获取笔记本的特定权限。 (仅限 Office 365

POST /permissions

为笔记本创建或更新一项权限。 (仅限 Office 365

DELETE /permissions/{id}

删除笔记本的一项权限。 (仅限 Office 365


详细了解更多关于 GET请求 (包括支持的查询字符串选项)以及如何复制笔记本的信息。

备注

使用 classNotebooks 端点处理班级笔记本以及 staffNotebooks 端点处理员工笔记本

资源操作

GET /resources/{id}/content

获取图像或文件资源的二进制内容。


详细了解更多关于 GET 请求以及如何向页面添加图像和文件的信息。

另请参阅