Show / Hide Table of Contents

Notes.ReadWrite.All

Allows the app to read, share, and modify OneNote notebooks that the signed-in user has access to in the organization.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D DELETE /groups/{id}/onenote/pages/{id}
V1 A,D DELETE /me/onenote/pages/{id}
V1 A,D DELETE /sites/{id}/onenote/pages/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/onenote/pages/{id}
V1 A,D GET /groups/{id}/onenote/notebooks
V1 A,D GET /groups/{id}/onenote/notebooks/{id}
V1 A,D GET /groups/{id}/onenote/notebooks/{id}/sectionGroups
V1 A,D GET /groups/{id}/onenote/notebooks/{id}/sections
V1 A,D GET /groups/{id}/onenote/operations/{id}
V1 A,D GET /groups/{id}/onenote/pages
V1 A,D GET /groups/{id}/onenote/resources/{id}/content
V1 A,D GET /groups/{id}/onenote/sectionGroups
V1 A,D GET /groups/{id}/onenote/sectionGroups/{id}
V1 A,D GET /groups/{id}/onenote/sectionGroups/{id}/sectionGroups
V1 A,D GET /groups/{id}/onenote/sectionGroups/{id}/sections
V1 A,D GET /groups/{id}/onenote/sections
V1 A,D GET /groups/{id}/onenote/sections/{id}
V1 A,D GET /groups/{id}/onenote/sections/{id}/pages
V1 A,D GET /me/onenote/notebooks
V1 A,D GET /me/onenote/notebooks/{id}
V1 A,D GET /me/onenote/notebooks/{id}/sectionGroups
V1 A,D GET /me/onenote/notebooks/{id}/sections
V1 A,D GET /me/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=includePersonalNotebooks-value)
V1 A,D GET /me/onenote/operations/{id}
V1 A,D GET /me/onenote/pages
V1 A,D GET /me/onenote/pages/{id}
V1 A,D GET /me/onenote/resources/{id}/content
V1 A,D GET /me/onenote/sectionGroups
V1 A,D GET /me/onenote/sectionGroups/{id}
V1 A,D GET /me/onenote/sectionGroups/{id}/sectionGroups
V1 A,D GET /me/onenote/sectionGroups/{id}/sections
V1 A,D GET /me/onenote/sections
V1 A,D GET /me/onenote/sections/{id}
V1 A,D GET /me/onenote/sections/{id}/pages
V1 A,D GET /sites/{id}/onenote/notebooks
V1 A,D GET /sites/{id}/onenote/notebooks/{id}
V1 A,D GET /sites/{id}/onenote/notebooks/{id}/sectionGroups
V1 A,D GET /sites/{id}/onenote/notebooks/{id}/sections
V1 A,D GET /sites/{id}/onenote/operations/{id}
V1 A,D GET /sites/{id}/onenote/pages
V1 A,D GET /sites/{id}/onenote/resources/{id}/content
V1 A,D GET /sites/{id}/onenote/sectionGroups
V1 A,D GET /sites/{id}/onenote/sectionGroups/{id}
V1 A,D GET /sites/{id}/onenote/sectionGroups/{id}/sectionGroups
V1 A,D GET /sites/{id}/onenote/sectionGroups/{id}/sections
V1 A,D GET /sites/{id}/onenote/sections
V1 A,D GET /sites/{id}/onenote/sections/{id}
V1 A,D GET /sites/{id}/onenote/sections/{id}/pages
V1 A,D GET /users/{id | userPrincipalName}/onenote/notebooks
V1 A,D GET /users/{id | userPrincipalName}/onenote/notebooks/{id}
V1 A,D GET /users/{id | userPrincipalName}/onenote/notebooks/{id}/sectionGroups
V1 A,D GET /users/{id | userPrincipalName}/onenote/notebooks/{id}/sections
V1 A,D GET /users/{id | userPrincipalName}/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks=includePersonalNotebooks-value)
V1 A,D GET /users/{id | userPrincipalName}/onenote/operations/{id}
V1 A,D GET /users/{id | userPrincipalName}/onenote/pages
V1 A,D GET /users/{id | userPrincipalName}/onenote/resources/{id}/content
V1 A,D GET /users/{id | userPrincipalName}/onenote/sectionGroups
V1 A,D GET /users/{id | userPrincipalName}/onenote/sectionGroups/{id}
V1 A,D GET /users/{id | userPrincipalName}/onenote/sectionGroups/{id}/sectionGroups
V1 A,D GET /users/{id | userPrincipalName}/onenote/sectionGroups/{id}/sections
V1 A,D GET /users/{id | userPrincipalName}/onenote/sections
V1 A,D GET /users/{id | userPrincipalName}/onenote/sections/{id}
V1 A,D GET /users/{id | userPrincipalName}/onenote/sections/{id}/pages
V1 A,D PATCH /groups/{id}/onenote/pages/{id}/content
V1 A,D PATCH /me/onenote/pages/{id}/content
V1 A,D PATCH /sites/{id}/onenote/pages/{id}/content
V1 A,D PATCH /users/{id | userPrincipalName}/onenote/pages/{id}/content
V1 A POST /education/classes/{class-id}/assignments/{assignment-id}/submissions/{submission-id}/submit
V1 A POST /education/classes/{class-id}/assignments/{assignment-id}/submissions/{submission-id}/unsubmit
V1 A POST /education/classes/{id}/assignments/{id}/submissions/{id}/reassign
V1 A,D POST /groups/{id}/onenote/notebooks
V1 A,D POST /groups/{id}/onenote/notebooks/{id}/copyNotebook
V1 A,D POST /groups/{id}/onenote/notebooks/{id}/sectionGroups
V1 A,D POST /groups/{id}/onenote/notebooks/{id}/sections
V1 A,D POST /groups/{id}/onenote/notebooks/GetNotebookFromWebUrl
V1 A,D POST /groups/{id}/onenote/pages
V1 A,D POST /groups/{id}/onenote/pages/{id}/copyToSection
V1 A,D POST /groups/{id}/onenote/sectionGroups/{id}/sectionGroups
V1 A,D POST /groups/{id}/onenote/sectionGroups/{id}/sections
V1 A,D POST /groups/{id}/onenote/sections/{id}/copyToNotebook
V1 A,D POST /groups/{id}/onenote/sections/{id}/copyToSectionGroup
V1 A,D POST /groups/{id}/onenote/sections/{id}/pages
V1 A,D POST /me/onenote/notebooks
V1 A,D POST /me/onenote/notebooks/{id}/copyNotebook
V1 A,D POST /me/onenote/notebooks/{id}/sectionGroups
V1 A,D POST /me/onenote/notebooks/{id}/sections
V1 A,D POST /me/onenote/notebooks/GetNotebookFromWebUrl
V1 A,D POST /me/onenote/pages
V1 A,D POST /me/onenote/pages/{id}/copyToSection
V1 A,D POST /me/onenote/sectionGroups/{id}/sectionGroups
V1 A,D POST /me/onenote/sectionGroups/{id}/sections
V1 A,D POST /me/onenote/sections/{id}/copyToNotebook
V1 A,D POST /me/onenote/sections/{id}/copyToSectionGroup
V1 A,D POST /me/onenote/sections/{id}/pages
V1 A,D POST /sites/{id}/onenote/notebooks
V1 A,D POST /sites/{id}/onenote/notebooks/{id}/copyNotebook
V1 A,D POST /sites/{id}/onenote/notebooks/{id}/sectionGroups
V1 A,D POST /sites/{id}/onenote/notebooks/{id}/sections
V1 A,D POST /sites/{id}/onenote/notebooks/GetNotebookFromWebUrl
V1 A,D POST /sites/{id}/onenote/pages
V1 A,D POST /sites/{id}/onenote/pages/{id}/copyToSection
V1 A,D POST /sites/{id}/onenote/sectionGroups/{id}/sectionGroups
V1 A,D POST /sites/{id}/onenote/sectionGroups/{id}/sections
V1 A,D POST /sites/{id}/onenote/sections/{id}/copyToNotebook
V1 A,D POST /sites/{id}/onenote/sections/{id}/copyToSectionGroup
V1 A,D POST /sites/{id}/onenote/sections/{id}/pages
V1 A,D POST /users/{id | userPrincipalName}/onenote/notebooks
V1 A,D POST /users/{id | userPrincipalName}/onenote/notebooks/{id}/copyNotebook
V1 A,D POST /users/{id | userPrincipalName}/onenote/notebooks/{id}/sectionGroups
V1 A,D POST /users/{id | userPrincipalName}/onenote/notebooks/{id}/sections
V1 A,D POST /users/{id | userPrincipalName}/onenote/notebooks/GetNotebookFromWebUrl
V1 A,D POST /users/{id | userPrincipalName}/onenote/pages
V1 A,D POST /users/{id | userPrincipalName}/onenote/pages/{id}/copyToSection
V1 A,D POST /users/{id | userPrincipalName}/onenote/sectionGroups/{id}/sectionGroups
V1 A,D POST /users/{id | userPrincipalName}/onenote/sectionGroups/{id}/sections
V1 A,D POST /users/{id | userPrincipalName}/onenote/sections/{id}/copyToNotebook
V1 A,D POST /users/{id | userPrincipalName}/onenote/sections/{id}/copyToSectionGroup
V1 A,D POST /users/{id | userPrincipalName}/onenote/sections/{id}/pages

Delegate Permission

Id 64ac0503-b4fa-45d9-b544-71a463f05da0
Consent Type User
Display String Read and write all OneNote notebooks that user can access
Description Allows the app to read, share, and modify OneNote notebooks that the signed-in user has access to in the organization.

Application Permission

Id 0c458cef-11f3-48c2-a568-c66751c238c0
Display String Read and write all OneNote notebooks
Description Allows the app to read all the OneNote notebooks in your organization, without a signed-in user.

Resources

educationSubmission

Property Type Description
id String Unique identifier for the submission.
reassignedBy identitySet User who moved the status of this submission to reassigned.
reassignedDateTime DateTimeOffset Moment in time when the submission was reassigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
recipient educationSubmissionRecipient Who this submission is assigned to.
resourcesFolderUrl String Folder where all file resources for this submission need to be stored.
returnedBy identitySet User who moved the status of this submission to returned.
returnedDateTime DateTimeOffset Moment in time when the submission was returned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
status string Read-only. Possible values are: working, submitted, released, returned, and reassigned. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value(s) in this evolvable enum: reassigned.
submittedBy identitySet User who moved the resource into the submitted state.
submittedDateTime DateTimeOffset Moment in time when the submission was moved into the submitted state. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
unsubmittedBy identitySet User who moved the resource from submitted into the working state.
unsubmittedDateTime DateTimeOffset Moment in time when the submission was moved from submitted into the working state. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

notebook

Property Type Description
createdBy identitySet Identity of the user, device, and application which created the item. Read-only.
createdDateTime DateTimeOffset The date and time when the notebook was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
displayName String The name of the notebook.
id String The unique identifier of the notebook. Read-only.
isDefault Boolean Indicates whether this is the user's default notebook. Read-only.
isShared Boolean Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
lastModifiedBy identitySet Identity of the user, device, and application which created the item. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
links NotebookLinks Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it's installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
sectionGroupsUrl String The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sectionsUrl String The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
self String The endpoint where you can get details about the notebook. Read-only.
userRole onenoteUserRole Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.

onenoteOperation

Property Type Description
createdDateTime DateTimeOffset The start time of the operation.
error onenoteOperationError The error returned by the operation.
id string The operation id. Read-only.
lastActionDateTime DateTimeOffset The time of the last action of the operation.
percentComplete string The operation percent complete if the operation is still in running status.
resourceId string The resource id.
resourceLocation string The resource URI for the object. For example, the resource URI for a copied page or section.
status operationStatus The current status of the operation: NotStarted, Running, Completed, Failed.

onenotePage

Property Type Description
content Stream The page's HTML content.
contentUrl String The URL for the page's HTML content. Read-only.
createdByAppId String The unique identifier of the application that created the page. Read-only.
createdDateTime DateTimeOffset The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
id String The unique identifier of the page. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
level Int32 The indentation level of the page. Read-only.
links pageLinks Links for opening the page. The oneNoteClientURL link opens the page in the OneNote native client if it 's installed. The oneNoteWebUrl link opens the page in OneNote on the web. Read-only.
order Int32 The order of the page within its parent section. Read-only.
self String The endpoint where you can get details about the page. Read-only.
title String The title of the page.

onenoteResource

Property Type Description
content Edm.Stream
contentUrl String

onenoteSection

Property Type Description
createdBy identitySet Identity of the user, device, and application which created the item. Read-only.
createdDateTime DateTimeOffset The date and time when the section was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
id String The unique identifier of the section. Read-only.
isDefault Boolean Indicates whether this is the user's default section. Read-only.
lastModifiedBy identitySet Identity of the user, device, and application which created the item. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the section was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
links sectionLinks Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it's installed. The oneNoteWebURL link opens the section in OneNote on the web.
displayName String The name of the section.
pagesUrl String The pages endpoint where you can get details for all the pages in the section. Read-only.
self String The endpoint where you can get details about the section. Read-only.

page

Property Type Description
content Stream The page's HTML content.
contentUrl String The URL for the page's HTML content. Read-only.
createdByAppId String The unique identifier of the application that created the page. Read-only.
createdDateTime DateTimeOffset The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
id String The unique identifier of the page. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
level Int32 The indentation level of the page. Read-only.
links PageLinks Links for opening the page. The oneNoteClientURL link opens the page in the OneNote native client if it 's installed. The oneNoteWebUrl link opens the page in OneNote on the web. Read-only.
order Int32 The order of the page within its parent section. Read-only.
self String The endpoint where you can get details about the page. Read-only.
title String The title of the page.

patchContentCommand

Property Type Description
action onenotePatchActionType The action to perform on the target element. The possible values are: replace, append, delete, insert, or prepend.
content String A string of well-formed HTML to add to the page, and any image or file binary data. If the content contains binary data, the request must be sent using the multipart/form-data content type with a "Commands" part.
position onenotePatchInsertPosition The location to add the supplied content, relative to the target element. The possible values are: after (default) or before.
target String The element to update. Must be the #<data-id> or the generated <id> of the element, or the body or title keyword.

recentNotebook

Property Type Description
displayName String The name of the notebook.
lastAccessedTime DateTimeOffset The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
links recentNotebookLinks Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote client, if it's installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
sourceService onenoteSourceService The backend store where the Notebook resides, either OneDriveForBusiness or OneDrive.

oneNoteResource

Property Type Description
content Stream The content stream
contentUrl String (url) The URL for downloading the content

section

Property Type Description
createdBy identitySet Identity of the user, device, and application which created the item. Read-only.
createdDateTime DateTimeOffset The date and time when the section was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
displayName String The name of the section.
id String The unique identifier of the section. Read-only.
isDefault Boolean Indicates whether this is the user's default section. Read-only.
lastModifiedBy identitySet Identity of the user, device, and application which created the item. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the section was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
links SectionLinks Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it's installed. The oneNoteWebURL link opens the section in OneNote on the web.
pagesUrl String The pages endpoint where you can get details for all the pages in the section. Read-only.
self String The endpoint where you can get details about the section. Read-only.

sectionGroup

Property Type Description
createdBy identitySet Identity of the user, device, and application which created the item. Read-only.
createdDateTime DateTimeOffset The date and time when the section group was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
displayName String The name of the section group.
id String The unique identifier of the section group. Read-only.
lastModifiedBy identitySet Identity of the user, device, and application which created the item. Read-only.
lastModifiedDateTime DateTimeOffset The date and time when the section group was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
sectionGroupsUrl String The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sectionsUrl String The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
self String The endpoint where you can get details about the section group. Read-only.
In This Article
Back to top Created by merill | Submit feedback