How to use IBM App Connect with Microsoft OneNote

Microsoft OneNote is a digital notebook that collects information and organizes notes.

Connecting to Microsoft OneNote

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Microsoft OneNote administrator to obtain these values.

Authorization method Connection field Applicability
BASIC OAUTH Application client ID App Connect Enterprise as a Service and App Connect in containers
Application client secret
Access token
Refresh token
OAUTH 2.0 PASSWORD Username App Connect Enterprise as a Service and App Connect in containers
Password
Application client ID
Application client secret
OAUTH 2.0 AUTH CODE
Tip: Authorize connection to Microsoft OneNote by signing in to your account.
App Connect Enterprise as a Service
Microsoft OneNote has the following connection fields.
Connection field Description
Application client ID The unique identifier generated after the Microsoft Azure app registration gets mapped to the specific project requests.
Application client secret The application client secret for a project-specific unique application client ID.
Access token The access token that is generated from the application client ID and client secret.
Refresh token The refresh token that is generated from the application client ID and client secret.
Username The username that is authorized to access the Microsoft OneNote API.
Password The password for the specified username.

To obtain the connection values for Microsoft OneNote, see Obtaining connection values for Microsoft OneNote.

To connect to a Microsoft OneNote endpoint from the App Connect Designer Applications and APIs page for the first time, expand Microsoft OneNote, then click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with Microsoft OneNote, take note of the following considerations:

  • The following table describes the service limits for the Microsoft OneNote connector:
    Limit type Limit per app per user (delegated context) Limit per app (app-only context)
    Requests rate 120 requests per 1 minute and 400 per 1 hour 240 requests per 1 minute and 800 per 1 hour
    Concurrent requests 5 concurrent requests 20 concurrent requests
    For more information about service limits, see OneNote service limits in the Microsoft documentation.
  • All the supported actions in the Microsoft OneNote connector have User ID as an input field.
    • To complete an action on your own notebook, set 'me' as the input value.
    • To complete an action on behalf of other users with their permission, provide the user ID of the other user as the input value.
  • Example of App Connect user interface fields that are filled for the action Create page with embedded content:
    Example of App Connect user interface fields that are completed for the Create page with embedded content
    In the example, the Content field contains information about the HTML content, which consists of a file attachment. You can configure this field to include multiple images and file attachments. For more information about configuring this field, see the following useful resources in the Microsoft documentation.
    Restriction: For a list of limitations when you send image and file data, see Size limitations for POST pages requests in the Microsoft documentation.
  • (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

Microsoft OneNote events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Microsoft OneNote actions

Your flow completes these actions on this application.

Object Action Description
Pages Create page with embedded content Creates a page with embedded content in OneNote
Tip: For more information about using the Create page with embedded content operation, see Add images, videos, and files to OneNote pages in the Microsoft documentation.
Create page Creates a page in OneNote
Retrieve pages Retrieves pages from OneNote
Delete page Deletes a page from OneNote
Download page content Downloads the page content
Append note Appends a note in OneNote page
Notebooks Create notebook Creates a notebook in OneNote
Retrieve notebooks Retrieves the notebooks from OneNote
Retrieve recent notebooks Retrieves the recent notebooks from OneNote
Sections Create section Creates a section in OneNote page
Retrieve sections Retrieves the sections from OneNote pages
Section groups Create section group Creates the section group in OneNote page
Retrieve section groups Retrieves the section groups from OneNote page

Examples

Dashboard tile for a template that uses Microsoft OneNote
Dashboard tile for a template that uses Microsoft OneNote
Dashboard tile for a template that uses Microsoft OneNote

Use templates to quickly create flows for Microsoft OneNote

Learn how to use App Connect templates to quickly create flows that complete actions on Microsoft OneNote. For example, go to the Discover page and search for Microsoft OneNote.

Dashboard tile for a template that uses Microsoft OneNote
Microsoft OneNote flow in detailed view

Use IBM® App Connect to build flows that integrate with Microsoft OneNote.

Read the blog in the IBM Community to learn how to create a page with embedded content for each new email received with attachments from Microsoft Exchange. Click Read the blog to go to the blog.