OneNote （Business）
OneNote 是来自Microsoft的笔记记录应用，使你可以轻松地跨所有设备同步创意、草图和笔记！ 使用启用了 OneDrive for Business 连接到 Office 365 帐户，以跟踪新分区、创建笔记等。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 标准 | 所有 Power Automate 区域 |
| 逻辑应用程序 | 标准 | 所有 逻辑应用区域 |
| Power Apps | 标准 | 所有 Power Apps 区域 |
| Power Automate | 标准 | 所有 Power Automate 区域 |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://products.office.com/onenote/digital-note-taking-app |
若要使用此集成，需要访问存储在 OneDrive For Business 上的 OneNote 笔记本。 若要建立连接，请选择“ 登录”。 系统将提示你提供已启用 OneDrive for Business 的 O365 帐户，请按照屏幕的其余部分创建连接。
已知问题和限制
- 使用连接时，如果看不到预期的笔记本列表，请检查创建连接的帐户，然后重试。 如果在使用连接器时看到错误，可能会查找 错误代码 以了解详细信息。
- 此集成需要连接到具有“UserRemoteAPIs”权限的帐户。 如果看到此错误：“错误：用户无权访问请求的资源”，则帐户可能没有正确的权限。 SharePoint 管理员可以通过浏览到网站集并打开网站设置来控制权限级别。 选择“网站权限”，然后选择“权限级别”以查看该级别包含的权限（如使用远程接口）。 如果属于某个级别的用户没有所需的权限，请通过选中权限框来修改级别，或者创建新的权限级别并将其分配给用户。
- 连接器当前不支持创建页面作的显式输入参数 Page Title。 这是 OneNote API 实现带来的限制。 但是，可以使用标题/标题>标记将标题指定为 HTML <><中页面内容的一部分。
-
笔记本分区。 如果要为 Notebook Section 参数提供自定义值，请使用 API URL 格式指定它。 API URL 模式：
https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{siteCollectionsId}/sites/{SiteId}/notes/sections/{SectionId}/pages. 有关详细信息，可以查看 OneNote API 文档。 - 以下区域不支持在“快速笔记”作中创建页面：
- 逻辑应用：
- Azure 政府
- Azure 中国区域
- Power Automate 和 Power Apps：
- 美国政府 (GCC)
- 美国政府 (GCC High)
- 由世纪互联运营的中国云
- 逻辑应用：
- Power Apps 不支持“获取页面内容”作，但 Power Automate 支持此作。
注释
笔记本名称中不允许使用以下字符：*“：<>？/|%
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
| 触发器轮询的频率 | 1 | 1200 秒 |
操作
| 删除页面 |
删除页面。 |
| 在快速笔记中创建页面 |
在“快速说明”部分创建新页面。 |
| 在笔记本中创建分区 |
在笔记本中创建分区。 |
| 在节中创建页面 |
在指定节中创建新页面。 |
| 更新页面内容 |
更新 HTML 页面内容。 |
| 获取最近使用的笔记本 |
获取最近的笔记本。 |
| 获取特定部分的页面 |
获取特定部分的页面。 |
| 获取笔记本中的分区 |
获取特定笔记本中的分区。 |
| 获取页面内容 |
获取 HTML 页面内容。 |
删除页面
删除页面。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
笔记本分区
|
sectionId | True | string |
节页的 API URL。 |
|
页 ID
|
pageId | True | string |
页面的唯一 ID。 |
在快速笔记中创建页面
在笔记本中创建分区
在笔记本中创建分区。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
新节的名称
|
name | string |
新节的名称。 |
返回
在节中创建页面
在指定节中创建新页面。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
笔记本分区
|
sectionId | True | string |
节页的 API URL。 |
|
页面内容
|
pageContent | True | html |
页面内容。 |
返回
- Body
- Page
更新页面内容
更新 HTML 页面内容。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
笔记本分区
|
sectionId | True | string |
节页的 API URL。 |
|
页 ID
|
pageId | True | string |
页面的唯一 ID。 |
|
目标
|
target | string |
要更新的元素。 |
|
|
Action
|
action | string |
要对目标元素执行的作。 |
|
|
位置
|
position | string |
添加提供的内容的位置。 |
|
|
Content
|
content | html |
新内容。 |
返回
页面 HTML 内容
- response
- string
获取最近使用的笔记本
获取特定部分的页面
获取特定部分的页面。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
笔记本分区
|
sectionId | True | string |
节页的 API URL。 |
返回
获取笔记本中的分区
获取特定笔记本中的分区。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of SectionListItem |
获取页面内容
获取 HTML 页面内容。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
笔记本分区
|
sectionId | True | string |
节页的 API URL。 |
|
页 ID
|
pageId | True | string |
页面的唯一 ID。 |
返回
页面 HTML 内容
- response
- string
触发器
| 创建新分区时 |
将新分区添加到笔记本时触发流。 |
| 创建新分区组时 |
将新分区组添加到笔记本时触发流。 |
| 在节中创建新页面时 |
将新页面添加到节时触发流。 |
创建新分区时
将新分区添加到笔记本时触发流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
返回
新部分的响应。
- Body
- NewSectionResponse
创建新分区组时
将新分区组添加到笔记本时触发流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
返回
新分区组的响应。
在节中创建新页面时
将新页面添加到节时触发流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
笔记本密钥
|
notebookKey | True | string |
标识笔记本的密钥。 请注意，这是特定于 API 的，不能手动键入。 |
|
笔记本分区
|
sectionId | True | string |
节页的 API URL。 |
返回
新页面的响应。
- Body
- NewPageResponse
定义
CreateSectionInNotebookResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
OData 上下文
|
@odata.context | string |
OData 上下文。 |
|
按名称创建
|
createdBy | string |
此部分按名称创建。 |
|
创建时间
|
createdTime | date-time |
此部分创建时间。 |
|
在笔记本对象 ID 中创建分区
|
id | string | |
|
默认节标志
|
isDefault | boolean |
指示这是默认部分的标志。 |
|
上次修改者
|
lastModifiedBy | string |
上次按名称修改。 |
|
上次修改时间
|
lastModifiedTime | date-time |
上次修改此部分的时间。 |
|
桌面客户端 href
|
links.oneNoteClientUrl.href | string |
OneNote 桌面客户端 href。 |
|
Web 客户端 href
|
links.oneNoteWebUrl.href | string |
OneNote Web 客户端 href。 |
|
节名称
|
name | string |
节的名称。 |
|
页面 URL
|
pagesUrl | string |
页面的 URL。 |
|
用于在笔记本中创建分区的 URL
|
self | string |
用于在笔记本组中创建分区的 URL。 |
页
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
页面标题
|
title | string |
页面的标题。 |
|
链接
|
links | Link |
与 OneNote 页面关联的链接。 |
|
内容 URL
|
contentUrl | string |
页面内容的 URL。 |
|
上次修改日期
|
lastModifiedTime | date-time |
页面的最后一个修改日期。 |
|
创建日期
|
createdTime | date-time |
创建页面的日期。 |
|
Id
|
id | string |
页面的唯一标识符。 |
Notebook
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文件名
|
FileName | string | |
|
Key
|
Key | string |
ParentNotebook
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
父笔记本密钥
|
id | string |
父笔记本的唯一标识符。 |
|
父笔记本名称
|
name | string |
父笔记本的名称。 |
|
父笔记本 URL
|
self | string |
指向父笔记本的 URL 链接。 |
Link
与 OneNote 页面关联的链接。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
oneNoteClientUrl
|
oneNoteClientUrl | OneNoteClientUrl | |
|
oneNoteWebUrl
|
oneNoteWebUrl | OneNoteWebUrl |
OneNoteClientUrl
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
OneNote 客户端 URL
|
href | string |
使用 OneNote Windows 客户端指向笔记本的链接。 |
OneNoteWebUrl
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
OneNote Web URL
|
href | string |
使用 OneNote Web 客户端指向笔记本的链接。 |
SectionListItem
节列表项中包含的字段。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
节名称
|
name | string |
节的名称。 |
|
节键
|
pagesUrl | string |
用于引用此部分的键;也是页面的 URL。 |
|
节标识符
|
id | string |
节的唯一标识符。 |
SectionResponse
节中包含的字段。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Creator
|
createdBy | string |
部分的创建者。 |
|
创建日期
|
createdTime | date-time |
节的创建日期和时间。 |
|
节标识符
|
id | string |
节的唯一标识符。 |
|
上次修改者
|
lastModifiedBy | string |
上次修改节的用户。 |
|
上次修改日期
|
lastModifiedTime | date-time |
节的上次修改日期和时间。 |
|
节名称
|
name | string |
节的名称。 |
|
页面 URL
|
pagesUrl | string |
此部分中页面的 URL。 |
|
parentNotebook
|
parentNotebook | ParentNotebook | |
|
网址
|
self | string |
此部分的 URL。 |
SectionGroupResponse
节组中包括的字段。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
创建日期
|
createdTime | date-time |
分区组的创建日期和时间。 |
|
Creator
|
createdBy | string |
分区组的创建者。 |
|
标识符
|
id | string |
节组的唯一标识符。 |
|
上次修饰符
|
lastModifiedBy | string |
上次修改分区组的用户。 |
|
上次修改日期
|
lastModifiedTime | date-time |
节组的最后一次修改日期和时间。 |
|
Name
|
name | string |
节组的名称。 |
|
节 URL
|
sectionsUrl | string |
此分区组中各节的 URL。 |
|
分区组 URL
|
self | string |
此分区组的 URL。 |
NewSectionResponse
新部分的响应。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
章节
|
value | array of SectionResponse |
一个对象数组，每个对象表示一个特定节。 |
NewSectionGroupResponse
新分区组的响应。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
节组
|
value | array of SectionGroupResponse |
一个对象数组，每个对象表示一个特定的节组。 |
NewPageResponse
新页面的响应。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
页
|
value | array of Page |
一个对象数组，每个对象表示一个特定页面。 |
GetPagesInSectionResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
OData 上下文
|
@odata.context | string |
OData 上下文。 |
|
节值对象中的页面
|
value | array of object |
value |
|
内容 URL
|
value.contentUrl | string |
内容 URL。 |
|
由应用 ID 创建
|
value.createdByAppId | string |
应用 ID 创建的。 |
|
创建时间
|
value.createdTime | date-time |
此响应的创建时间。 |
|
响应的唯一标识符
|
value.id | string |
此响应的唯一标识符。 |
|
上次修改时间
|
value.lastModifiedTime | date-time |
此对象的上次修改时间。 |
|
OneNote 桌面客户端 href
|
value.links.oneNoteClientUrl.href | string |
OneNote 桌面客户端 href。 |
|
OneNote Web 客户端 href
|
value.links.oneNoteWebUrl.href | string |
OneNote Web 客户端 href。 |
|
父节唯一标识符
|
value.parentSection.id | string |
此对象父节的唯一标识符。 |
|
父节名称
|
value.parentSection.name | string | |
|
节父部分中的页面
|
value.parentSection.self | string |
节父节中页面的 URL。 |
|
父节 OData 上下文
|
value.parentSection@odata.context | string |
父节 OData 上下文。 |
|
“分区”组中的页面
|
value.self | string |
“分区中的页面”组的 URL。 |
|
页面标题
|
value.title | string |
页面标题。 |
字符串
这是基本数据类型“string”。