This page provides a guide to Establishing a Connection to Microsoft OneNote in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Microsoft OneNote

Establishing a Connection shows how to authenticate to Microsoft OneNote and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Microsoft OneNote through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Microsoft OneNote by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Microsoft OneNote

There are two authentication methods available for connecting to Microsoft OneNote data sources:

• OAuth 2.0-based methods: Microsoft OneNote provides OAuth 2.0-based authentication via both Azure AD and Azure Service Principal.
  • For Azure AD authentication, set AuthScheme to AzureAD.
  • For Azure Service Principal authentication, set AuthScheme to AzureServicePrincipal.
• Managed Service Identity (MSI) authentication. To use this method, set AuthScheme to AzureMSI.

The following subsections describe each authentication method in detail.

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see Creating a Custom Authentication App.

Managed Service Identity (MSI)

If you are running Microsoft OneNote on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

To use Azure Service Principal authentication, you must:

• Set up the ability to assign a role to the authentication application. To do this, create a custom OAuth AD application, as described in Creating a Custom Authentication App.
• Register an application with an Azure AD tenant, to create a new service principal that can be used with the role-based access control, to access resources in your subscription.

Do the following:

1. Create a custom Azure AD application, as described in Creating a Custom Authentication App.
2. Assign a role to the application:
   1. Use the search bar to search for the Subscriptions service.
   2. Open the Subscriptions page.
   3. Select the subscription to which to assign the application.
   4. Open the Access control (IAM).
   5. Select Add > Add role assignment. Microsoft OneNote opens the Add role assignment page.
   6. Assign your custom Azure AD application the role of Owner.

Admin Consent

Admin consent occurs when the Admin for an Azure Active Directory tenant grants permissions to a custom application that explicitly requires an admin to consent to the use case.

When creating a new Azure AD application in the Azure Portal, you must specify which permissions the application requires. Some permissions may be marked as "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your application requires admin consent, there are two ways you can do this.

The easiest way to grant admin consent is to have an admin log into portal.azure.com and navigate to the application you have created in App Registrations. Under API Permissions, click Grant Consent. This gives your application permissions on the tenant under which it was created.

If your organization has multiple tenants or you must grant application permissions for other tenants outside your organization, use the GetAdminConsentURL stored procedure to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL stored procedure, no important information is returned from this endpoint. Rather, after the OAuth application is successfully authorized, it returns a Boolean indicating that permissions have been granted.

After the administrator has approved the OAuth Application, you can continue to authenticate.

Client Credentials

Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the application itself. All tasks taken by the application are done without a default user context. This makes the authentication flow a bit different from the standard flow.

All permissions related to the client OAuth flow require admin consent. This means you cannot use the application embedded with the CData Cloud in the client OAuth flow. You must create your own OAuth application to use client credentials. See Creating a Custom Authentication App for more information.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under "Application Permissions".

Select the permissions you require for your integration. After you do this, set the following connection properties:

• AuthScheme: AzureServicePrincipal.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• AzureTenant: The tenant you wish to connect to.
• OAuthGrantType: CLIENT.
• OAuthClientId: The client Id in your application settings.
• OAuthClientSecret: The client secret in your application settings.

Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.

Auth Certificate

Auth Certificate refers to an OAuth flow that uses a certificate to enable server-to-server authentication. All permissions related to the client OAuth flow require admin consent. This means you cannot use the application embedded with the CData Cloud in the client OAuth flow. You must create your own OAuth application to use an OAuth certificate. See Creating a Custom Authentication App for more information.

In your App Registration in portal.azure.com, navigate to API Permissions and select the client Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during certificate authentication are under "Application Permissions".

Select the permissions that apply to your particular integration. After you do this, set the following connection properties:

• AuthScheme: AzureServicePrincipalCert.
• AzureTenant: The tenant to which you need to connect.
• OAuthJWTCert: The JWT Certificate store.
• OAuthJWTIssuer: The OAuth client Id.
• OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.

Certificate authentication takes place automatically. Since there is no user context, there is no pop-up to signal the point at which authentication occurs. Connections are made and handled internally.

The CData Cloud can be used to perform administrative tasks. This can be done by specifying the UserId column to execute CUD operations.

The UserId Column

Many tables expose a special UserId column. This is designed to be used by an administrator to modify records on another user's account. If you are not an administrator or do not desire this behavior, do not specify the UserId when performing an INSERT / UPDATE / DELETE operation. For instance, executing the following will insert a notebook for another user:

INSERT INTO Notebooks (displayName, UserId) VALUES ('Test Notebook', '12345')

The above request will have the overall effect of attempting to add a notebook under the resource at /users/12345/notebooks. When UserId is not specified, the resources affected will instead be modified under /users/me/notebooks. In general if you are not an administrator, you can only affect or view records under /users/me, so it is not recommended to set UserId when you are not an admin.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to Microsoft OneNote APIs.

Key Features

• The Cloud models Microsoft OneNote entities like users and groups as relational views, entities like notebooks, sections, section groups and pages as relational tables, allowing you to write SQL to query Microsoft OneNote data.
• Stored procedures allow you to execute operations to Microsoft OneNote, including retrieving the access token and keeping it refreshed in OAuth 2.0.
• Live connectivity to these objects means any changes to your Microsoft OneNote account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Users and Groups.

Tables

Tables describes the available tables. Tables are statically defined to model Notebooks, SectionGroups, Sections and Pages.

Stored Procedures

Stored Procedures are function-like interfaces to OneNote. They can be used to search, create, and modify information in OneNote.

The Cloud models the data in Microsoft OneNote as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Microsoft OneNote Tables

Name	Description
Notebooks	Retrieves all Notebooks for the authenticated user.
SectionGroups	Retrieves all SectionGroups accross notebooks for the authenticated user.
Sections	Retrieves all Sections accross notebooks for the authenticated user.

Retrieves all Notebooks for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific fields of Id, UserId, GroupId and SiteId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:

SELECT * FROM Notebooks WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Notebooks WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-56e2fc02-f3dd-4f82-fvgf-dfsdf4807935')
SELECT * FROM Notebooks WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Notebooks WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM Notebooks WHERE SiteId = 'rssbuscrm.sharepoint.com,9839b8a3-343a-4064-996a-d2a300bc559f,2b6cda85-3573-4578-ae76-dfdde60c771b'

Insert

The column required to perform an Insert operation on Notebooks table is DisplayName. If the INSERT operation is done on behalf of a group or user then UserId or GroupId should also be specified. The following examples illustrate an Insert operation on Notebooks:

INSERT INTO Notebooks (DisplayName) VALUES ('Getting started')
INSERT INTO Notebooks (DisplayName, UserId) VALUES ('Getting started', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Notebooks (DisplayName, GroupId) VALUES ('Getting started', '044d385d-6ca8-4d81-800d-223124b651db')

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	True	The id of the notebook.
self	String	False	The self of the notebook.
createdDateTime	Datetime	False	The created DateTime of the notebook.
createdBy_application_displayName	String	False	The createdBy_application_displayName of the notebook.
createdBy_application_id	String	False	The createdBy_application_id of the notebook.
displayName	String	False	The display name of the notebook.
lastModifiedBy_application_displayName	String	False	The lastModifiedBy_application_displayName of the notebook.
lastModifiedBy_application_id	String	False	The lastModifiedBy_application_id of the notebook.
lastModifiedDateTime	Datetime	False	The lastModified DateTime of the notebook.
isDefault	Bool	False	Indicator if notebook is default.
isShared	Bool	False	Indicator if notebook is shared.
links_oneNoteClientUrl_href	String	False	The links_oneNoteClientUrl_href of the notebook.
sectionGroupsUrl	String	False	The sectionGroups Url of the notebook.
sectionsUrl	String	False	The sectionsUrl of the notebook.
userRole	String	False	The userRole of the notebook.
createdBy_user_displayName	String	False	The createdBy user displayName of the notebook
createdBy_user_id	String	False	The createdBy user id of the notebook
UserId	String	False	The userId that the authenticated user is impersonating.
GroupId	String	False	The groupId that the authenticated user is impersonating.
SiteId	String	False	The Id of the Site.

Retrieves all SectionGroups accross notebooks for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific fields of Id, UserId, GroupId, SiteId and ParentNotebookId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:

SELECT * FROM SectionGroups WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE ParentNotebookId = '1-2342423-1234-3424-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM SectionGroups WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM SectionGroups WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'

Insert

The columns required to perform an Insert operation on SectionGroups table is DisplayName and ParentNotebookId. If the INSERT operation is done on behalf of a group or user then UserId or GroupId should also be specified. The following examples illustrate an Insert operation on SectionGroups:

INSERT INTO SectionGroups (DisplayName, ParentNotebookId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	True	The id of the section group.
self	String	False	The self of the section group.
createdDateTime	Datetime	False	The createdDateTime of the section group.
createdBy_application_displayName	String	False	The createdBy_application_displayName of the section group.
createdBy_application_id	String	False	The createdBy_application_id of the section group.
displayName	String	False	The displayName of the section group.
lastModifiedBy_application_displayName	String	False	The lastModifiedBy_application_displayName of the section group.
lastModifiedBy_application_id	String	False	The lastModifiedBy_application_id of the section group.
lastModifiedDateTime	Datetime	False	The lastModifiedDateTime of the section group.
sectionGroupsUrl	String	False	The sectionGroupsUrl of the section group.
sectionsUrl	String	False	The sectionsUrl of the section group.
ParentNotebookId	String	False	The ParentNotebookId of the section group.
ParentSectionGroupId	String	False	The ParentSectionGroupId of the section group.
createdBy_user_displayName	String	False	The createdBy_user_displayName of the section group.
createdBy_user_id	String	False	The createdBy_user_id of the section group.
UserId	String	False	The userId that the authenticated user is impersonating.
GroupId	String	False	The groupId that the authenticated user is impersonating.
SiteId	String	False	The Id of the Sharepoint Site.

Retrieves all Sections accross notebooks for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific fields of Id, UserId, GroupId, SiteId, ParentNotebookId and ParentSectionGroupId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:

SELECT * FROM Sections WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentNotebookId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentSectionGroupId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentSectionGroupId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Sections WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM Sections WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'

Insert

The columns required to perform an Insert operation on Sections table is DisplayName and ParentNotebookId. If the INSERT operation is done on behalf of a group or user then UserId or GroupId should also be specified. The following examples illustrate an Insert operation on Sections:

INSERT INTO Sections (DisplayName, ParentNotebookId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO Sections (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Sections (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	True	The id of the section.
self	String	False	The self of the section.
createdDateTime	Datetime	False	The createdDateTime of the section.
createdBy_application_displayName	String	False	The createdBy_application_displayName of the section.
createdBy_application_id	String	False	The createdBy_application_id of the section.
displayName	String	False	The displayName of the section.
lastModifiedBy_application_displayName	String	False	The lastModifiedBy_application_displayName of the section.
lastModifiedBy_application_id	String	False	The lastModifiedBy_application_id of the section.
lastModifiedDateTime	Datetime	False	The lastModifiedDateTime of the section.
isDefault	Bool	False	The isDefault of the section.
links_oneNoteClientUrl_href	String	False	The links_oneNoteClientUrl_href of the section.
pagesUrl	String	False	The pagesUrl of the section.
ParentNotebookId	String	False	The ParentNotebookId of the section.
ParentSectionGroupId	String	False	The ParentSectionGroupId of the section.
createdBy_user_displayName	String	False	The createdBy_user_displayName of the section.
createdBy_user_id	String	False	The createdBy_user_id of the section.
UserId	String	False	The userId that the authenticated user is impersonating.
GroupId	String	False	The groupId that the authenticated user is impersonating.
SiteId	String	False	The Id of the Sharepoint Site.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Microsoft OneNote Views

Name	Description
Groups	Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups.
Pages	Retrieves all Pages accross notebooks for the authenticated user.
PagesContent	Retrieves the content for the pages
Sites	Retrieves all sites for the authenticated user.
Users	Retrieves all Azure AD user accounts within the authenticated permissions.

Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups.

Table Specific Information

Groups require Administrator permissions. To work with them, you must create your own custom OAuth App and set the appropriate OAuthClientId and OAuthClientSecret. In this app, you must configure it to request the Group.Read.All permission. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See Creating a Custom Authentication App for more details on creating a custom app.

To authorize Groups permissions, an administrator must grant the Groups permissions for your organization at large. This can be done via the administrator authorization endpoint. Simply have the administrator navigate to the following web page and grant permissions. Then run the OAuth authorization as normal afterwards.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM Groups WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Groups WHERE Id IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')

Columns

Name	Type	Description
ParentReference	String	The Parent Reference of the group.
id [KEY]	String	The Id of the group.
deletedDateTime	Datetime	The datetime when the group was deleted.
allowExternalSenders	Bool	The indicator showing if external senders should be allowed or not.
assignedLabels	String	The assigned labels of the group
assignedLicenses	String	The assigned licenses of the group.
autoSubscribeNewMembers	Bool	The indicator showing if new members should be autosubscribed.
classification	String	The classification of the group.
createdDateTime	Datetime	The created DateTime of the group.
description	String	The description of the group.
displayName	String	The display name of the group.
expirationDateTime	Datetime	The expiration datetime of the group.
groupTypes	String	The types of the group.
hasMembersWithLicenseErrors	Bool	Indicator if there are members with license error.
hideFromAddressLists	Bool	The hide From AddressLists of the group.
hideFromOutlookClients	Bool	The hide From OutlookClients of the group.
isArchived	Bool	Indicator if group is archived.
isSubscribedByMail	Bool	Indicator if group is subscribed by email.
licenseProcessingState_state	String	The license processing state of the group.
mail	String	The mail of the group.
mailEnabled	Bool	Indicator if mail is enabled in the group.
mailNickname	String	The mail nickname of the group.
membershipRule	String	The membership rule of the group.
membershipRuleProcessingState	String	The membership rule processing state of the group.
onPremisesDomainName	String	The domain name of the group.
onPremisesLastSyncDateTime	Datetime	The LastSync DateTime of the group.
onPremisesNetBiosName	String	The Net Bios Name of the group.
onPremisesProvisioningErrors	String	The provisioning errors of the group.
onPremisesSamAccountName	String	The Sam Account Name of the group.
onPremisesSecurityIdentifier	String	The security identifier of the group.
onPremisesSyncEnabled	Bool	Indicator if sync is enabled in the group.
preferredDataLocation	String	The preferred data location of the group.
preferredLanguage	String	preferred language in the group.
proxyAddresses	String	The proxy addresses of the group.
renewedDateTime	Datetime	The renewed DateTime of the group.
securityEnabled	Bool	Indicator if security is enabled in the group.
securityIdentifier	String	The security identifier of the group.
theme	String	The theme of the group.
unseenCount	Int	The unseen count of the group.
visibility	String	The visibility of the group.

Retrieves all Pages accross notebooks for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific fields of Id, ParentSectionId, UserId, GroupId or SiteId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:

SELECT * FROM Pages WHERE Id = '1-e8992fa8e5254df387d062d04e75a6e7!6-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE Id IN ('1193-dsdda-9392-4706514c636b', '1193-dsdda-9392-sdfasdw33324')
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND GroupId = '1772bb5a-f8e9-405d-a90b-eac11b0b9b9a'
SELECT * FROM Pages WHERE GroupId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'
SELECT * FROM Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'

Columns

Name	Type	Description
id [KEY]	String	The id of the page.
self	String	The self of the page.
createdDateTime	Datetime	The createdDateTime of the page.
contentUrl	String	The contentUrl of the page.
createdByAppId	String	The createdByAppId of the page.
lastModifiedDateTime	Datetime	The lastModifiedDateTime of the page.
level	Int	The level of the page.
links_oneNoteClientUrl_href	String	The links_oneNoteClientUrl_href of the page
order	Int	The order of the page.
title	String	The title of the page.
userTags	String	The userTags of the page.
ParentSectionId	String	The ParentSectionId of the page.
UserId	String	The userId that the authenticated user is impersonating.
GroupId	String	The groupId that the authenticated user is impersonating.
SiteId	String	The Id of the Sharepoint site.

Retrieves the content for the pages

Table Specific Information

Select

Most filters are handled server side, but the specific fields of PageId, UserId, GroupId or SiteId will change the endpoint we use to retrieve the data. They must be specified with an '=' or IN condition. For example:

SELECT * FROM PagesContent WHERE PageId = '1-396658ffc20744bcb716bdd972cc3bfb!1-26d8f808-d809-4df0-a292-d79499d870d'
SELECT * FROM PagesContent where PageId IN ('1-396658ffc20744bcb716bdd972cc3bfb!1-26d8f808-d809-4df0-a292-d79499d870d7', '1-3c0db927dab643d0bbe402f79e6be51f!1-11a54aa2-2105-4d7b-92c3-6e448fbadcc7', '1-a4375ec1f6cd4183ae142bd1fc54859c!1-11a54aa2-2105-4d7b-92c3-6e448fbadcc7')
SELECT * FROM PagesContent WHERE PageId IN (SELECT Id from Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe') AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM PagesContent WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM PagesContent WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'

Columns

Name	Type	Description
PageId	String	The id of the page.
Content	String	The html content of the page.
UserId	String	The id of the user.
GroupId	String	The id of the group.
SiteId	String	The id of the site.

Retrieves all sites for the authenticated user.

Columns

Name	Type	Description
Id [KEY]	String	The full identifier of the site.
SiteId	String	The unique identifier of the site collection.
WebId	String	The Web Id of the site.
SiteName	String	The name of the site.
Title	String	The title of the site.
SiteDescription	String	The description of the site.
Description	String	The description of the item.
CreatedDateTime	Datetime	Date and time the site was created.
LastModifiedDateTime	Datetime	Date and time the site was last modified.
SPWebUrl	String	URL that displays the resource in the browser.
Author	String	The author of the site.
DocumentSignature	String	The document signature of the site.
FileExtension	String	The extension of the site's file.
SecondaryFileExtension	String	The secondary extension of the site's file.
FileType	String	The file type of the site.
DocId	Long	The unique identifier of the site within a geo location.
GeoLocationSource	String	The geo location of the site.
HitHighlightedSummary	String	The heighted summary of the site.
Importance	Long	The importance of the site.
IsContainer	Bool	Specifies whether the site is a folder.
IsDocument	Bool	Specifies whether the site is a document.
OriginalPath	String	The original site path.
Path	String	The current site path.
Rank	Double	The rank of the site.
RenderTemplateId	String	The site's control render template name.
SiteLogo	String	The URI of the site's logo.
ViewsLifeTime	Long	The total view count since the site was created.
ViewsRecent	Long	The total view count of the site in the last 14 days.
WebTemplate	String	The web temple from which the site is created.

Retrieves all Azure AD user accounts within the authenticated permissions.

Table Specific Information

Users require Administrator permissions. To work with them, you must create your own custom OAuth App and set the appropriate OAuthClientId and OAuthClientSecret. In this app, you must configure it to request the User.Read.All permission. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See Creating a Custom Authentication App for more details on creating a custom app.

To authorize User permissions, an administrator must grant the Users permissions for your organization at large. This can be done via the administrator authorization endpoint. Simply have the administrator navigate to the following web page and grant permissions. Then run the OAuth authorization as normal afterwards.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Users WHERE Id IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')

Columns

Name	Type	Description
id [KEY]	String	The id of the user.
deletedDateTime	Datetime	The deletedDateTime of the user.
aboutMe	String	The aboutMe of the user.
accountEnabled	Bool	Indicates if accountEnabled for the user.
ageGroup	String	The ageGroup of the user.
assignedLicenses	String	The assignedLicenses of the user.
assignedPlans	String	The assignedPlans of the user.
birthday	Datetime	The birthday of the user.
businessPhones	String	The businessPhones of the user.
city	String	The city of the user.
companyName	String	The companyName of the user.
consentProvidedForMinor	String	The consentProvidedForMinor of the user.
country	String	The country of the user.
createdDateTime	Datetime	The createdDateTime of the user.
creationType	String	The creationType of the user.
department	String	The department of the user.
deviceEnrollmentLimit	Int	The deviceEnrollmentLimit of the user.
displayName	String	The displayName of the user.
employeeHireDate	Datetime	The employeeHireDate of the user.
employeeId	String	The employeeId of the user.
employeeOrgData_costCenter	String	The employeeOrgData_costCenter of the user.
employeeOrgData_division	String	The employeeOrgData_division of the user.
employeeType	String	The employeeType of the user.
externalUserState	String	The externalUserState of the user.
externalUserStateChangeDateTime	Datetime	The externalUserStateChangeDateTime of the user.
faxNumber	String	The faxNumber of the user.
givenName	String	The givenName of the user.
hireDate	Datetime	The hireDate of the user.
identities	String	The identities of the user.
imAddresses	String	The imAddresses of the user.
interests	String	The interests of the user.
isResourceAccount	Bool	Indicates if it isResourceAccount of the user.
jobTitle	String	The jobTitle of the user.
lastPasswordChangeDateTime	Datetime	The lastPasswordChangeDateTime of the user.
legalAgeGroupClassification	String	The legalAgeGroupClassification of the user.
licenseAssignmentStates	String	The licenseAssignmentStates of the user.
mail	String	The mail of the user.
mailboxSettings_archiveFolder	String	The mailboxSettings_archiveFolder of the user.
mailboxSettings_automaticRepliesSetting_externalAudience	String	The mailboxSettings_automaticRepliesSetting_externalAudience of the user.
mailboxSettings_automaticRepliesSetting_externalReplyMessage	String	The mailboxSettings_automaticRepliesSetting_externalReplyMessage of the user.
mailboxSettings_automaticRepliesSetting_internalReplyMessage	String	The mailboxSettings_automaticRepliesSetting_internalReplyMessage of the user.
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime	Datetime	The mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime of the user.
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone	String	The mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone of the user.
mailboxSettings_automaticRepliesSetting_status	String	The mailboxSettings_automaticRepliesSetting_status of the user.
mailboxSettings_dateFormat	String	The mailboxSettings_dateFormat of the user.
mailboxSettings_delegateMeetingMessageDeliveryOptions	String	The mailboxSettings_delegateMeetingMessageDeliveryOptions of the user.
mailboxSettings_language_displayName	String	The mailboxSettings_language_displayName of the user.
mailboxSettings_language_locale	String	The mailboxSettings_language_locale of the user.
mailboxSettings_timeFormat	String	The mailboxSettings_timeFormat of the user.
mailboxSettings_timeZone	String	The mailboxSettings_timeZone of the user.
mailboxSettings_workingHours_daysOfWeek	String	The mailboxSettings_workingHours_daysOfWeek of the user.
mailboxSettings_workingHours_endTime	Time	The mailboxSettings_workingHours_endTime of the user.
mailboxSettings_workingHours_startTime	Time	The mailboxSettings_workingHours_startTime of the user.
mailboxSettings_workingHours_timeZone_name	String	The mailboxSettings_workingHours_timeZone_name of the user.
mailNickname	String	The mailNickname of the user.
mobilePhone	String	The mobilePhone of the user.
mySite	String	The mySite of the user.
officeLocation	String	The officeLocation of the user.
onPremisesDistinguishedName	String	The onPremisesDistinguishedName of the user.
onPremisesDomainName	String	The onPremisesDomainName of the user.
onPremisesExtensionAttributes_extensionAttribute1	String	The onPremisesExtensionAttributes_extensionAttribute1 of the user.
onPremisesExtensionAttributes_extensionAttribute10	String	The onPremisesExtensionAttributes_extensionAttribute10 of the user.
onPremisesExtensionAttributes_extensionAttribute11	String	The onPremisesExtensionAttributes_extensionAttribute11 of the user.
onPremisesExtensionAttributes_extensionAttribute12	String	The onPremisesExtensionAttributes_extensionAttribute12 of the user.
onPremisesExtensionAttributes_extensionAttribute13	String	The onPremisesExtensionAttributes_extensionAttribute13 of the user.
onPremisesExtensionAttributes_extensionAttribute14	String	The onPremisesExtensionAttributes_extensionAttribute14 of the user.
onPremisesExtensionAttributes_extensionAttribute15	String	The onPremisesExtensionAttributes_extensionAttribute15 of the user.
onPremisesExtensionAttributes_extensionAttribute2	String	The onPremisesExtensionAttributes_extensionAttribute2 of the user.
onPremisesExtensionAttributes_extensionAttribute3	String	The onPremisesExtensionAttributes_extensionAttribute3 of the user.
onPremisesExtensionAttributes_extensionAttribute4	String	The onPremisesExtensionAttributes_extensionAttribute4 of the user.
onPremisesExtensionAttributes_extensionAttribute5	String	The onPremisesExtensionAttributes_extensionAttribute5 of the user.
onPremisesExtensionAttributes_extensionAttribute6	String	The onPremisesExtensionAttributes_extensionAttribute6 of the user.
onPremisesExtensionAttributes_extensionAttribute7	String	The onPremisesExtensionAttributes_extensionAttribute7 of the user.
onPremisesExtensionAttributes_extensionAttribute8	String	The onPremisesExtensionAttributes_extensionAttribute8 of the user.
onPremisesExtensionAttributes_extensionAttribute9	String	The onPremisesExtensionAttributes_extensionAttribute9 of the user.
onPremisesImmutableId	String	The onPremisesImmutableId of the user.
onPremisesLastSyncDateTime	Datetime	The onPremisesLastSyncDateTime of the user.
onPremisesProvisioningErrors	String	The onPremisesProvisioningErrors of the user.
onPremisesSamAccountName	String	The onPremisesSamAccountName of the user.
onPremisesSecurityIdentifier	String	The onPremisesSecurityIdentifier of the user.
onPremisesSyncEnabled	Bool	Indicates onPremisesSyncEnabled for the user.
onPremisesUserPrincipalName	String	The onPremisesUserPrincipalName of the user.
otherMails	String	The otherMails of the user.
passwordPolicies	String	The passwordPolicies of the user.
passwordProfile_forceChangePasswordNextSignIn	Bool	Indicate passwordProfile_forceChangePasswordNextSignIn for the user.
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	Indicate passwordProfile_forceChangePasswordNextSignInWithMfa for the user.
passwordProfile_password	String	The passwordProfile_password of the user.
pastProjects	String	The pastProjects of the user.
postalCode	String	The postalCode of the user.
preferredLanguage	String	The preferredLanguage of the user.
preferredName	String	The preferredName of the user.
provisionedPlans	String	The provisionedPlans of the user.
proxyAddresses	String	The proxyAddresses of the user.
responsibilities	String	The responsibilities of the user.
schools	String	The schools of the user.
showInAddressList	Bool	Indicate showInAddressList of the user.
signInSessionsValidFromDateTime	Datetime	The signInSessionsValidFromDateTime of the user.
skills	String	The skills of the user.
state	String	The state of the user.
streetAddress	String	The streetAddress of the user.
surname	String	The surname of the user.
usageLocation	String	The usageLocation of the user.
userPrincipalName	String	The userPrincipalName of the user.
userType	String	The userType of the user.
ParentReference	String	The ParentReference of the user.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT operations with Microsoft OneNote.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft OneNote, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Microsoft OneNote Stored Procedures

Copies a notebook to the Notebooks folder in the destination Documents library. The folder is created if it doesn't exist.

Input

Name	Type	Required	Description
NotebookId	String	True	The id of the notebook that you want to copy.
GroupId	String	False	The id of the group to copy to. Use only when copying to an Office 365 group.
UserId	String	False	The id of the user to copy to. Use only when copying to an Office 365 user.
RenameAs	String	False	The name of the copy. Defaults to the name of the existing item.

Result Set Columns

Name	Type	Description
Status	String	Status of the copying operation.

Copies a page to a specific section.

Input

Name	Type	Required	Description
PageId	String	True	The id of the page that you want to copy.
SectionId	String	True	The id of the section that you want to copy.
GroupId	String	False	The id of the group to copy to. Use only when copying to an Office 365 group.
UserId	String	False	The id of the user to copy to. Use only when copying to an Office 365 user.

Result Set Columns

Name	Type	Description
Status	String	Status of the copying operation.

Copies a section to a specific notebook or section group.

Input

Name	Type	Required	Description
SectionId	String	True	The Id of the section that you want to copy.
GroupId	String	False	The Id of the group to copy to. Use only when copying to an Office 365 group.
UserId	String	False	The Id of the user to copy to. Use only when copying to an Office 365 user.
NotebookId	String	False	The Id of the destination notebook. Either this, or SectionGroupId should be specified.
SectionGroupId	String	False	The Id of the destination section group. Either this, or NotebookId should be specified.
RenameAs	String	False	The name of the copy. Defaults to the name of the existing item.

Result Set Columns

Name	Type	Description
Status	String	Status of the copying operation.

Creates a new page for the specified section

Stored Procedures Specific Information

Microsoft OneNote allows multiple columns to be used in the Exec query. These columns can typically be used with only = comparison. SectionId and One of either Content or File params are required to execute this procedure.
Note: In case of OAuthGrantType=CLIENT, one of userId or groupId must be specified. For example:

EXECUTE CreatePage SectionId = '1-8a84fed0-5381-47f3-89bc-cd16f7a4f06d', File = 'C:\\Users\\Dell\\Desktop\\content.html'

Input

Name	Type	Required	Description
SectionId	String	True	The id of the page.
Content	String	False	The html content of the page.
File	String	False	The path of the file containing the html content of the page.
GroupId	String	False	The id of the group.
UserId	String	False	The id of the User

Result Set Columns

Name	Type	Description
Id	String	The Id of the created page.
Status	String	Status of the create page operation.
Title	String	Title of the page created.

Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Input

Name	Type	Required	Description
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings.
State	String	False	The same value for state that you sent when you requested the authorization code.
Scope	String	False	A space-separated list of scopes to request from the Admin. The default value is 'https://graph.microsoft.com/group.read.all https://graph.microsoft.com/user.read.all https://graph.microsoft.com/notes.readwrite.all'

Result Set Columns

Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

The HTML content of the particular Page

Input

Name	Type	Required	Description
PageId	String	True	The id of the page.
GroupId	String	False	The id of the group.
UserId	String	False	The id of the User

Result Set Columns

Name	Type	Description
Content	String	The HTML content of the particular Page.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Microsoft OneNote:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Notebooks table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Notebooks' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CopyNotebook stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CopyNotebook' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Notebooks table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Notebooks' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:onenote:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Data Type Mappings

The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Microsoft OneNote (OData V4)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.Date	datetime
Edm.DateTimeOffset	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft OneNote.

Connection

---

Property

Description

IncludeSharePointSites

Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme.

Azure Authentication

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

---

Property	Description
GroupId	Specify this GroupId in order to access the OneNote documents for this group.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserId	Specify this UserId in order to access the OneNote documents for this user.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft OneNote.

The type of authentication to use when connecting to Microsoft OneNote.

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

Data Type

string

Default Value

"AzureAD"

Remarks

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

---

Property

Description

IncludeSharePointSites

Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme.

Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme.

Data Type

bool

Default Value

false

Remarks

This property affects only Drives views.

This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

Data Type

string

Default Value

""

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

The Azure Environment to use when establishing a connection.

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

"GLOBAL"

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

The client Id assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The grant type for the OAuth flow.

Possible Values

CODE, CLIENT

Data Type

string

Default Value

"CODE"

Remarks

The following options are available: CODE,CLIENT

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The type of key store containing the JWT Certificate.

Data Type

string

Default Value

"PEMKEY_BLOB"

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the OAuth JWT certificate.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The subject of the OAuth JWT certificate.

Data Type

string

Default Value

"*"

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
GroupId	Specify this GroupId in order to access the OneNote documents for this group.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserId	Specify this UserId in order to access the OneNote documents for this user.

Specify this GroupId in order to access the OneNote documents for this group.

Data Type

string

Default Value

""

Remarks

Specify this GroupId in order to access the OneNote documents for this group.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.

Specify this UserId in order to access the OneNote documents for this user.

Data Type

string

Default Value

""

Remarks

Specify this UserId in order to access the OneNote documents for this user.