笔记本:getRecentNotebooks
本文内容
命名空间:microsoft.graph
获取登录用户访问的 recentNotebook 实例列表。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限 。
权限类型
权限(从最低特权到最高特权)
委派(工作或学校帐户)
Notes.Create、Notes.Read、Notes.ReadWrite、Notes.Read.All、Notes.ReadWrite.All
委派(个人 Microsoft 帐户)
Notes.Create、Notes.Read、Notes.ReadWrite
应用程序
Notes.Read.All、Notes.ReadWrite.All
HTTP 请求
GET /me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=includePersonalNotebooks-value)
GET /users/{id | userPrincipalName}/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=includePersonalNotebooks-value)
用户的 {id | userPrincipalName} 必须与用于发出请求的授权令牌中编码的用户一致。
函数参数
参数
类型
Description
includePersonalNotebooks
Boolean
添加用户拥有的笔记本。 若要添加用户拥有的笔记本,请设置为 true;否则,设置为 false。 如果不添加 includePersonalNotebooks 参数,请求会返回 400 错误响应。
名称
说明
Authorization
Bearer {code}
请求正文
请勿提供此方法的请求正文。
响应
如果成功响应,则返回 200 OK,其中包含 recentNotebooks 的 JSON 集合。
示例
以下示例演示如何调用此 API。
请求
下面为请求示例。
GET https://graph.microsoft.com/v1.0/me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=true)
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var getRecentNotebooks = await graphClient.Me.Onenote.Notebooks
.GetRecentNotebooks(true)
.Request()
.GetAsync();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
let getRecentNotebooks = await client.api('/me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=true)')
.get();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=true)"]]];
[urlRequest setHTTPMethod:@"GET"];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
NSError *jsonError = nil;
MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
MSGraphRecentNotebook *recentNotebook = [[MSGraphRecentNotebook alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];
}];
[meDataTask execute];
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
NotebookGetRecentNotebooksCollectionPage getRecentNotebooks = graphClient.me().onenote().notebooks()
.getRecentNotebooks(NotebookGetRecentNotebooksParameterSet
.newBuilder()
.withIncludePersonalNotebooks(true)
.build())
.buildRequest()
.get();
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
notebookId := "notebook-id"
result, err := graphClient.Me().Onenote().NotebooksById(¬ebookId).Get()
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.Notes
# A UPN can also be used as -UserId.
Get-MgUserOnenoteNotebook -UserId $userId -NotebookId $notebookId
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档 。
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-type: application/json
Content-Length: 1110
{
"value":[
{
"displayName":"Personal Notebook","lastAccessedTime":"timestamp","links":{
"oneNoteClientUrl":{
"href":"onenote:href-value"
},"oneNoteWebUrl":{
"href":"href-value"
}
},"sourceService":"OneDrive"
},{
"displayName":"Team Shared Notebook","lastAccessedTime":"timestamp","links":{
"oneNoteClientUrl":{
"href":"onenote:href-value"
},"oneNoteWebUrl":{
"href":"href-value"
}
},"sourceService":"OneDriveForBusiness"
}
]
}