获取笔记本

  • 项目

命名空间：microsoft.graph

重要

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

检索 笔记本 对象的属性和关系。

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

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

权限

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

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

HTTP 请求

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

可选的查询参数

此方法支持 select 和 expandOData 查询参数 来帮助自定义响应。

笔记本的有效 expand 值为 sections 和 sectionGroups。

请求标头

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

请求正文

请勿提供此方法的请求正文。

响应

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

示例

请求

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

GET https://graph.microsoft.com/beta/me/onenote/notebooks/{id}
响应

以下示例显示了相应的响应。 注意：为简洁起见，此处所示的响应对象已截断。 将从实际调用中返回所有属性。

HTTP/1.1 200 OK
Content-type: application/json

{
  "isDefault": true,
  "userRole": {
  },
  "id": "8fcb5dbc-d5aa-4681-8e31-b001d5168d79",
  "isShared": true,
  "sectionsUrl": "sectionsUrl-value",
  "sectionGroupsUrl": "sectionGroupsUrl-value",
  "links": {
    "oneNoteClientUrl": {
      "href": "href-value"
    },
    "oneNoteWebUrl": {
      "href": "href-value"
    }
  }
}