OneNote Consumer (Independent Publisher) (Preview)
![](https://connectoricons-prod.azureedge.net/u/shgogna/version-mismatches-special-train/1.0.1670.3520/onenotepersonalip/icon.png)
Microsoft OneNote is your digital notebook. One cross-functional notebook for all your notetaking needs.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
[email protected] |
Connector Metadata | |
---|---|
Publisher | Troy Taylor |
Website | https://docs.microsoft.com/en-us/graph/api/resources/onenote-api-overview?view=graph-rest-1.0 |
Privacy policy | https://privacy.microsoft.com/en-us/privacystatement |
Categories | Content and Files |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create notebook |
Creates a new OneNote notebook. |
Create page |
Create a new page in the specified section |
Create section |
Create a new section in the specified notebook. |
Get my notebooks |
Retrieves my notebooks. |
Get notebook |
Retrieves a specific notebook |
List pages |
Retrieves a list of pages from the specified section |
List sections |
Retrieves a list of sections from the specified notebook. |
Create notebook
Creates a new OneNote notebook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Display Name
|
displayName | True | string |
The display name. |
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
ID
|
id | string |
The unique identifier. |
Self
|
self | string |
The self URL address. |
Display Name
|
displayName | string |
The display name. |
User Role
|
userRole | string |
The user role. |
Is Shared
|
isShared | boolean |
Whether is shared. |
Sections URL
|
sectionsUrl | string |
The sections URL address. |
Section Groups URL
|
sectionGroupsUrl | string |
The section groups URL address. |
HREF
|
links.oneNoteClientUrl.href | string |
The HREF attribute. |
HREF
|
links.oneNoteWebUrl.href | string |
The HREF attribute. |
Create page
Create a new page in the specified section
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Section ID
|
section-id | True | string |
The section unique identifier. |
Content Type
|
Content-Type | True | string |
The content type. |
body
|
body | True | string |
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
ID
|
id | string |
The unique identifier. |
Self
|
self | string |
The self URL address. |
Created Date-Time
|
createdDateTime | string |
When created date-time. |
Title
|
title | string |
The title. |
Created By App ID
|
createdByAppId | string |
The created by app unique identifier. |
Content URL
|
contentUrl | string |
The content URL address. |
Last Modified Date-Time
|
lastModifiedDateTime | string |
When last modified date-time. |
HREF
|
links.oneNoteClientUrl.href | string |
The HREF attribute. |
HREF
|
links.oneNoteWebUrl.href | string |
The HREF attribute. |
Create section
Create a new section in the specified notebook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Notebook ID
|
notebook-id | True | string |
The notebook unique identifier. |
Display Name
|
displayName | True | string |
The display name. |
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
ID
|
id | string |
The unique identifier. |
Self
|
self | string |
The self URL address. |
Created Date-Time
|
createdDateTime | string |
When created date-time. |
Display Name
|
displayName | string |
The display name. |
Last Modified Date-Time
|
lastModifiedDateTime | string |
When last modified date-time. |
Is Default
|
isDefault | boolean |
Whether is default. |
Pages URL
|
pagesUrl | string |
The pages URL address. |
ID
|
createdBy.user.id | string |
The unique identifier. |
Display Name
|
createdBy.user.displayName | string |
The display name. |
ID
|
lastModifiedBy.user.id | string |
The unique identifier. |
Display Name
|
lastModifiedBy.user.displayName | string |
The display name. |
Get my notebooks
Retrieves my notebooks.
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
Value
|
value | array of object | |
ID
|
value.id | string |
The unique identifier. |
Self
|
value.self | string |
The self URL address. |
Created Date-Time
|
value.createdDateTime | string |
When created date-time. |
Display Name
|
value.displayName | string |
The display name. |
Last Modified Date-Time
|
value.lastModifiedDateTime | string |
When last modified date-time. |
Is Default
|
value.isDefault | boolean |
Whether is default. |
User Role
|
value.userRole | string |
The user role. |
Is Shared
|
value.isShared | boolean |
Whether is shared. |
Sections URL
|
value.sectionsUrl | string |
The sections URL address. |
Section Groups URL
|
value.sectionGroupsUrl | string |
The section groups URL address. |
ID
|
value.createdBy.user.id | string |
The unique identifier. |
Display Name
|
value.createdBy.user.displayName | string |
The display name. |
ID
|
value.lastModifiedBy.user.id | string |
The unique identifier. |
Display Name
|
value.lastModifiedBy.user.displayName | string |
The display name. |
HREF
|
value.links.oneNoteClientUrl.href | string |
The HREF attribute. |
HREF
|
value.links.oneNoteWebUrl.href | string |
The HREF attribute. |
Get notebook
Retrieves a specific notebook
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Notebook ID
|
notebook-id | True | string |
The notebook unique identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
ID
|
id | string |
The unique identifier. |
Self
|
self | string |
The self URL address. |
Created Date-Time
|
createdDateTime | string |
When created date-time. |
Display Name
|
displayName | string |
The display name. |
Last Modified Date-Time
|
lastModifiedDateTime | string |
When last modified date-time. |
Is Default
|
isDefault | boolean |
Whether is default. |
User Role
|
userRole | string |
The user role. |
Is Shared
|
isShared | boolean |
Whether is shared. |
Sections URL
|
sectionsUrl | string |
The sections URL address. |
Section Groups URL
|
sectionGroupsUrl | string |
The section groups URL address. |
ID
|
createdBy.user.id | string |
The unique identifier. |
Display Name
|
createdBy.user.displayName | string |
The display name. |
ID
|
lastModifiedBy.user.id | string |
The unique identifier. |
Display Name
|
lastModifiedBy.user.displayName | string |
The display name. |
HREF
|
links.oneNoteClientUrl.href | string |
The HREF attribute. |
HREF
|
links.oneNoteWebUrl.href | string |
The HREF attribute. |
List pages
Retrieves a list of pages from the specified section
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Section ID
|
section-id | True | string |
The section unique identifier. |
Filter
|
$filter | string |
The filter. |
|
Expand
|
$expand | string |
The expand parameter. |
|
Order By
|
$orderby | string |
The order by. |
|
Search
|
$search | string |
The search. |
|
Select
|
$select | string |
The select. |
|
Skip
|
$skip | integer |
The skip count. |
|
Top
|
$top | integer |
The top. |
|
Count
|
$count | boolean |
The count. |
|
Skip Token
|
$skiptoken | string |
The skip token. |
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
Value
|
value | array of object | |
ID
|
value.id | string |
The unique identifier. |
Self
|
value.self | string |
The self URL address. |
Created Date-Time
|
value.createdDateTime | string |
When created date-time. |
Title
|
value.title | string |
The title. |
Created By App ID
|
value.createdByAppId | string |
The created by app unique identifier. |
Content URL
|
value.contentUrl | string |
The content URL address. |
Last Modified Date-Time
|
value.lastModifiedDateTime | string |
When last modified date-time. |
HREF
|
value.links.oneNoteClientUrl.href | string |
The HREF attribute. |
HREF
|
value.links.oneNoteWebUrl.href | string |
The HREF attribute. |
Parent Section OData Context
|
[email protected] | string |
The parent section OData context. |
Parent Section
|
value.parentSection | string |
The parent section. |
List sections
Retrieves a list of sections from the specified notebook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Notebook ID
|
notebook-id | True | string |
The notebook unique identifier. |
Filter
|
$filter | string |
The filter. |
|
Expand
|
$expand | string |
The expand parameter. |
|
Order By
|
$orderby | string |
The order by. |
|
Search
|
$search | string |
The search. |
|
Select
|
$select | string |
The select. |
|
Skip
|
$skip | integer |
The skip count. |
|
Top
|
$top | integer |
The top. |
|
Count
|
$count | boolean |
The count. |
|
Skip Token
|
$skiptoken | string |
The skip token. |
Returns
Name | Path | Type | Description |
---|---|---|---|
@odata.context
|
@odata.context | string |
The OData Context. |
Value
|
value | array of object | |
ID
|
value.id | string |
The unique identifier. |
Self
|
value.self | string |
The self URL address. |
Created Date-Time
|
value.createdDateTime | string |
When created date-time. |
Display Name
|
value.displayName | string |
The display name. |
Last Modified Date-Time
|
value.lastModifiedDateTime | string |
When last modified date-time. |
Is Default
|
value.isDefault | boolean |
Whether is default. |
Pages URL
|
value.pagesUrl | string |
The pages URL address. |
ID
|
value.createdBy.user.id | string |
The unique identifier. |
Display Name
|
value.createdBy.user.displayName | string |
The display name. |
ID
|
value.lastModifiedBy.user.id | string |
The unique identifier. |
Display Name
|
value.lastModifiedBy.user.displayName | string |
The display name. |
Parent Notebook OData Context
|
[email protected] | string |
The parent notebook OData context. |
ID
|
value.parentNotebook.id | string |
The unique identifier. |
Display Name
|
value.parentNotebook.displayName | string |
The display name. |
Self
|
value.parentNotebook.self | string |
The self address. |
Parent Section Group OData Context
|
[email protected] | string |
The parent section group OData context. |
Parent Section Group
|
value.parentSectionGroup | string |
The parent section group. |