Skip to content

Latest commit

 

History

History
140 lines (114 loc) · 4.61 KB

notebook-get.md

File metadata and controls

140 lines (114 loc) · 4.61 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
Get notebook
Retrieve the properties and relationships of a notebook object.
jewan-microsoft
medium
onenote
apiPageType

Get notebook

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve the properties and relationships of a notebook object.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

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

Optional query parameters

This method supports the select and expand OData Query Parameters to help customize the response.

Valid expand values for notebooks are sections and sectionGroups.

Request headers

Name Type Description
Authorization string Bearer {token}. Required.
Accept string application/json

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a notebook object in the response body.

Example

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.

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"
    }
  }
}