笔记本:getNotebookFromWebUrl

命名空间:microsoft.graph

重要

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

使用笔记本对象的 URL 路径检索 属性和关系。

该位置可以是 Microsoft 365 上的用户笔记本、组笔记本或 Microsoft 365 上 SharePoint 网站托管的团队笔记本。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Notes.Create Notes.Read、Notes.Read.All、Notes.ReadWrite、Notes.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Notes.Read.All Notes.ReadWrite.All

HTTP 请求

POST /me/onenote/notebooks/GetNotebookFromWebUrl
POST /users/{id | userPrincipalName}/onenote/notebooks/GetNotebookFromWebUrl
POST /groups/{id}/onenote/notebooks/GetNotebookFromWebUrl
POST /sites/{id}/onenote/notebooks/GetNotebookFromWebUrl

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。
接受 string application/json

请求正文

在请求正文中,提供要检索的笔记本的完整 URL 路径的 JSON 表示形式。

属性 类型 说明
webUrl String 要检索的笔记本的 URL 路径。 它还可以包含“onenote:”前缀。

响应

如果成功,此方法在 200 OK 响应正文中返回响应代码和 笔记本 对象。

示例

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/me/onenote/notebooks/GetNotebookFromWebUrl
Content-type: application/json

{"webUrl":"webUrl value"}
响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json; odata.metadata=minimal
Content-Length: 544

{
    "isDefault": true,
    "userRole": "userRole-value",
    "isShared": true,
    "sectionsUrl": "sectionUrl-value",
    "sectionGroupsUrl": "sectionGroupUrl-value",
    "links": {
        "oneNoteClientUrl": {
            "href": "href-value"
        },
        "oneNoteWebUrl": {
            "href": "href-value"
        }
    },
    "id": "id-value",
    "self": "self-value",
}