获取笔记本

命名空间：microsoft.graph

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

此 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 响应正文中返回响应代码和 笔记本 对象。

示例

请求

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

HTTP

GET https://graph.microsoft.com/v1.0/me/onenote/notebooks/1-e13f257d-78c6-46cf-ae8c-13686517ac5f

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Onenote.Notebooks["{notebook-id}"].GetAsync();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users onenote notebooks get --user-id {user-id} --notebook-id {notebook-id}

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



notebooks, err := graphClient.Me().Onenote().Notebooks().ByNotebookId("notebook-id").Get(context.Background(), nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Notebook result = graphClient.me().onenote().notebooks().byNotebookId("{notebook-id}").get();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let notebook = await client.api('/me/onenote/notebooks/1-e13f257d-78c6-46cf-ae8c-13686517ac5f')
	.get();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->onenote()->notebooks()->byNotebookId('notebook-id')->get()->wait();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Notes

# A UPN can also be used as -UserId.
Get-MgUserOnenoteNotebook -UserId $userId -NotebookId $notebookId

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.me.onenote.notebooks.by_notebook_id('notebook-id').get()

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

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

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

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