Connectors Reference

OneNote (Business)

OneNote is a note taking app from Microsoft that makes it easy to sync your ideas, sketches and notes across all your devices! Connect to your Office 365 account with OneDrive for Business enabled to track new sections, create notes and more.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

CreateSectionInNotebook (string notebookKey, CreateSectionRequest body)

Create section in a notebook

CreatePageInSection (string notebookKey, string sectionId, string pageContent)

Create page in a section

GetPagesInSection (string notebookKey, string sectionId)

Get pages for a specific section

CreatePageInQuickNotes (string pageContent)

Create a page in Quick Notes

GetPageContent (string notebookKey, string sectionId, string pageId, [internal]boolean preAuthenticated)

Get page content

GetNotebooks ()

Get notebooks

GetSectionsInNotebook (string notebookKey)

Get sections in notebook

 

Triggers:

Name

Summary

OnNewSectionInNotebook (string notebookKey)

When a new section is created

OnNewSectionGroupInNotebook (string notebookKey)

When a new section group is created

OnNewPageInSection (string notebookKey, string sectionId)

When a new page is created in a section

 

Objects:

Name

Summary

CreateSectionInNotebookResponse

 

CreateSectionRequest

 

GetPagesInSectionResponse

 

GetSectionsInNotebookResponse

 

Link

 

NewPageResponse

 

NewSectionGroupResponse

 

NewSectionResponse

 

Notebook

 

OneNoteClientUrl

 

OneNoteWebUrl

 

Page

 

ParentNotebook

 

Section

 

SectionGroup

 

SectionListItem

 

 

Actions:

CreateSectionInNotebook

Summary: Create section in a notebook

Description: Create section in a notebook.

 

Syntax:

OneNote(Business).CreateSectionInNotebook (string notebookKey, CreateSectionRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

body

CreateSectionRequest

 

 

True

 

Returns:

          Type:CreateSectionInNotebookResponse

 

CreatePageInSection

Summary: Create page in a section

Description: Create new page in a specified section.

 

Syntax:

OneNote(Business).CreatePageInSection (string notebookKey, string sectionId, string pageContent)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

sectionId

string

(Section Id)

The unique identifier of the section within the notebook.

True

GetSectionsInNotebook

pageContent

string

 

 

True

 

Returns:

          Type:Page

 

GetPagesInSection

Summary: Get pages for a specific section

Description: Get pages for a specific section.

 

Syntax:

OneNote(Business).GetPagesInSection (string notebookKey, string sectionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

sectionId

string

(Section Id)

Unique Id of the section.

True

GetSectionsInNotebook

 

Returns:

          Type:GetPagesInSectionResponse

 

CreatePageInQuickNotes

Summary: Create a page in Quick Notes

Description: Create a new page in the Quick Notes section.

 

Syntax:

OneNote(Business).CreatePageInQuickNotes (string pageContent)

 

Parameters:

Name

Type

Summary

Required

Related Action

pageContent

string

 

 

True

 

Returns:

          Type:Page

 

GetPageContent

Summary: Get page content

Description: Get HTML page content.

 

Syntax:

OneNote(Business).GetPageContent (string notebookKey, string sectionId, string pageId, [internal]boolean preAuthenticated)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

sectionId

string

(Section Id)

Unique Id of the section.

True

GetSectionsInNotebook

pageId

string

(Page Id)

Unique id of the page.

True

GetPagesInSection

preAuthenticated

boolean

 

 

True

 

Returns:

          Type:string

 

GetNotebooks

Summary: Get notebooks

Description: Get available notebooks.

 

Syntax:

OneNote(Business).GetNotebooks ()

 

Returns:

          Type:array of (Notebook)

 

GetSectionsInNotebook

Summary: Get sections in notebook

Description: Get sections in a specific notebook.

 

Syntax:

OneNote(Business).GetSectionsInNotebook (string notebookKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

 

Returns:

          Type:GetSectionsInNotebookResponse

 

Triggers:

Trigger OnNewSectionInNotebook

Summary: When a new section is created

Description: Triggers a flow when a new section is added to a notebook.

 

Syntax:

OneNote(Business).OnNewSectionInNotebook (string notebookKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

 

Returns:

          Type:NewSectionResponse

          Description: Response for a new section.

 

Trigger OnNewSectionGroupInNotebook

Summary: When a new section group is created

Description: Triggers a flow when a new section group is added to a notebook.

 

Syntax:

OneNote(Business).OnNewSectionGroupInNotebook (string notebookKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

 

Returns:

          Type:NewSectionGroupResponse

          Description: Response for a new section group.

 

Trigger OnNewPageInSection

Summary: When a new page is created in a section

Description: Triggers a flow when a new page is added to a section.

 

Syntax:

OneNote(Business).OnNewPageInSection (string notebookKey, string sectionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

notebookKey

string

(Notebook Key)

A key identifying the notebook. Note this is specific to the API and cannot be hand-typed.

True

GetNotebooks

sectionId

string

(Section Id)

The unique identifier of the section within the notebook.

True

GetSectionsInNotebook

 

Returns:

          Type:NewPageResponse

          Description: Response for a new page.

 


 

CreateSectionInNotebookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

OData context

The OData context.

createdBy

string

Created by name

This section created by name.

createdTime

string(date-time)

Created time

This section created time.

id

string

Create section in notebook object id

 

isDefault

boolean

Default section flag

A flag to indication if this is the default section.

lastModifiedBy

string

Last Modified By

Last modified by name.

lastModifiedTime

string(date-time)

Last Modified Time

The time this section was last modified.

links

Links

OneNote client links

OneNote client links.

name

string

Section Name

The name of the section.

pagesUrl

string

The pages Url

The url of the pages.

self

string

Url to create section in notebook

The url to create section in notebook group.

 

Links

Summary: OneNote client links

Description: OneNote client links.

 

          Properties:

Name

Type

Summary

oneNoteClientUrl

OneNoteClientUrl

OneNote Client Url

The link to open in the OneNote desktop client.

oneNoteWebUrl

OneNoteWebUrl

OneNote Web Url

The link to open in the OneNote web client.

 

OneNoteClientUrl

Summary: OneNote Client Url

Description: The link to open in the OneNote desktop client.

 

          Properties:

Name

Type

Summary

href

string

Desktop client href

OneNote desktop client href.

 

OneNoteWebUrl

Summary: OneNote Web Url

Description: The link to open in the OneNote web client.

 

          Properties:

Name

Type

Summary

href

string

Web client href

OneNote web client href.

 


 

CreateSectionRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name of the new section

The name of the new section.


 

GetPagesInSectionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

OData context

The OData context.

value

array of (ValueItem)

Pages in section value object

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

contentUrl

string

Content Url

The content url.

createdByAppId

string

Created by app id

The created by app id.

createdTime

string(date-time)

Created time

The created time for this response.

id

string

Unique identifier for response

The unique identifier for this response.

lastModifiedTime

string(date-time)

Last modified time

The last modified time for this object.

links

Links

Collection of links for this object

A collection of links for this object.

parentSection

ParentSection

Parent Section

parentSection

parentSection@odata.context

string

Parent Section OData context

Parent Section OData context.

self

string

Pages In Section group

The url to the Pages In Section group.

title

string

Page title

Page title.

 

Links

Summary: Collection of links for this object

Description: A collection of links for this object.

 

          Properties:

Name

Type

Summary

oneNoteClientUrl

OneNoteClientUrl

OneNote client url

The OneNote desktop client url.

oneNoteWebUrl

OneNoteWebUrl

OneNote web client url

The OneNote web client url.

 

OneNoteClientUrl

Summary: OneNote client url

Description: The OneNote desktop client url.

 

          Properties:

Name

Type

Summary

href

string

OneNote desktop client href

OneNote desktop client href.

 

OneNoteWebUrl

Summary: OneNote web client url

Description: The OneNote web client url.

 

          Properties:

Name

Type

Summary

href

string

OneNote web client href

OneNote web client href.

 

ParentSection

Summary: Parent Section

Description: parentSection

 

          Properties:

Name

Type

Summary

id

string

Parent section unique identifier

The unique identifier for this object parent section.

name

string

Parent section name

 

self

string

Pages in Section parent section

The url to the pages in section parent section.

 


 

GetSectionsInNotebookResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (SectionListItem)

 

 


 

Link

Summary:

Description: The links associated with the OneNote page.

 

          Properties:

Name

Type

Summary

oneNoteClientUrl

OneNoteClientUrl

 

 

oneNoteWebUrl

OneNoteWebUrl

 

 


 

NewPageResponse

Summary:

Description: Response for a new page.

 

          Properties:

Name

Type

Summary

value

array of (Page)

Pages

An array of objects, each representing a specific page.


 

NewSectionGroupResponse

Summary:

Description: Response for a new section group.

 

          Properties:

Name

Type

Summary

value

array of (SectionGroup)

Section Groups

An array of objects, each representing a specific section group.


 

NewSectionResponse

Summary:

Description: Response for a new section.

 

          Properties:

Name

Type

Summary

value

array of (Section)

Sections

An array of objects, each representing a specific section.


 

Notebook

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileName

string

 

 

Key

string

 

 


 

OneNoteClientUrl

Summary:

Description:

 

          Properties:

Name

Type

Summary

href

string

OneNote client url

A link to the notebook using the OneNote windows client.


 

OneNoteWebUrl

Summary:

Description:

 

          Properties:

Name

Type

Summary

href

string

OneNote web url

A link to the notebook using the OneNote web client.


 

Page

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

Page title

The title of the page.

links

Link

 

The links associated with the OneNote page.

contentUrl

string

Content Url

A url to the page content.

lastModifiedTime

string(date-time)

Last Modified Date

The last modified date of the page.

createdTime

string(date-time)

Created Date

The date the page was created.

id

string

Id

The unique identifier of the page.


 

ParentNotebook

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Parent Notebook Key

The unique identifier of the parent notebook.

name

string

Parent Notebook Name

The name of the parent notebook.

self

string

Parent Notebook Url

A url link to the parent notebook.


 

Section

Summary:

Description: The fields included in a section.

 

          Properties:

Name

Type

Summary

createdBy

string

Creator

The creator of the section.

createdTime

string(date-time)

Creation Date

The creation date and time of the section.

id

string

Section Identifier

Unique identifier of the section.

isDefault

boolean

IsDefault

Indicates whether it is the default section.

lastModifiedBy

string

Last Modified By

The user who last modified the section.

lastModifiedTime

string(date-time)

Last Modified Date

The last modified date and time of the section.

name

string

Section Name

The name of the section.

pagesUrl

string

Pages Url

Url to the pages in this section.

parentNotebook

ParentNotebook

 

 

self

string

Url

The url to this section.


 

SectionGroup

Summary:

Description: The fields included in a section group.

 

          Properties:

Name

Type

Summary

createdTime

string(date-time)

Creation date

The creation date and time of the section group.

createdBy

string

Creator

The creator of the section group.

id

string

Identifier

Unique identifier of the section group.

lastModifiedBy

string

Last modifier

The user who last modified the section group.

lastModifiedTime

string(date-time)

Last modified date

The last modification date and time of the section group.

name

string

Name

The name of the section group.

sectionsUrl

string

Sections Url

Url of the sections within this section group.

self

string

Section Group Url

The url to this section group.


 

SectionListItem

Summary:

Description: The fields included in a section list item.

 

          Properties:

Name

Type

Summary

name

string

Section name

The name of the section.

pagesUrl

string

Section key

The key used to reference this section; also a url to the pages.

id

string

Section Identifier

Unique identifier of the section.