CData Cloud offers access to Microsoft Office 365 across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Microsoft Office 365 through CData Cloud.
CData Cloud allows you to standardize and configure connections to Microsoft Office 365 as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Microsoft Office 365 in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Microsoft Office 365 and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Microsoft Office 365 through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Microsoft Office 365 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.
Microsoft Office 365 uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
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 OAuth Application.
If you are running Microsoft Office 365 on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.
When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.
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:
Do the following:
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.
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 OAuth Application 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:
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.
The CData Cloud can be used to perform administrative tasks. This can be done by specifying the UserId column to execute CUD operations.
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 contact for another user:
INSERT INTO Contacts (displayName, CompanyName, UserId) VALUES ('Bill', 'Bob Co', '12345')
The above request will have the overall effect of attempting to add a contact under the resource at /users/12345/contacts. When UserId is not specified, the resources affected will instead be modified under /users/me/contacts. 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.
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.
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.
Set the following properties:
The Cloud models the Microsoft Office 365 API as relational tables. Any changes to the remote data are immediately reflected in your queries; the table definitions are dynamically retrieved. When you connect, the Cloud connects to Microsoft Office 365 and gets the list of tables and the metadata for the tables by calling the appropriate Web services.
API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
Tables shows definitions from a sample Office 365 site. The actual data model will be obtained dynamically based on your user credentials and Office 365 site.
Stored Procedures are function-like interfaces to Office365. They can be used to search, update, and modify information in Office365.
The Cloud models the data in Microsoft Office 365 as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
Calendars | This table is dynamic and maps to the corresponding field in the API. |
Contacts | The Office365 table Contacts. |
Conversations | The Office365 table Conversations. |
Events | This field is dynamic and maps to the corresponding field in the API. |
Files | The Office365 table Files. |
Groups | The Office365 table Groups. |
Messages | The Office365 table Messages. |
Tasks | The Office365 table Tasks. |
Users | Read, Insert, Update and Delete a User. |
This table is dynamic and maps to the corresponding field in the API.
You can query Calendars by specifying an Id or selecting all:
SELECT * FROM Calendars WHERE Id = 'your Calendar Id goes here'
Select a certain column from the entity and filter by that column:
SELECT id FROM Calendars WHERE name LIKE 'Calendar%'
Specify a Name as a minimum in order to create a new Calendar:
INSERT INTO Calendars (Name) VALUES ('John')
Note: In case of client credentials, UserId is required in order to create a new Calendar:
INSERT INTO Calendars (Name, UserId) VALUES ('Test123', '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe');
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
This field is dynamic and maps to the corresponding field in the API. | |
Etag | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
allowedOnlineMeetingProviders | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
canEdit | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
canShare | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
canViewPrivateItems | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
changeKey | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
color | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
defaultOnlineMeetingProvider | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
hexColor | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
isDefaultCalendar | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isRemovable | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isTallyingResponses | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
name | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
owner_address | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
owner_name | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
UserId [KEY] | String | False |
The UserId column for the table Calendars. |
The Office365 table Contacts.
You can query Contacts by specifying an Id or selecting all:
SELECT * FROM Contacts WHERE Id = 'your Contact Id goes here'
Select a certain column from the entity and filter by that column:
SELECT GivenName FROM Contacts WHERE GivenName LIKE 'John%'
Specify a GivenName and a Surname as a minimum in order to create a new Contact:
INSERT INTO Contacts (GivenName, Surname) VALUES ('John', 'Smith')
Note: In case of client credentials, UserId is required in order to create a new Contact:
INSERT INTO Contacts (GivenName, Surname, UserId) VALUES ('John', 'Smith', '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe')
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
The contact's unique identifier. | |
Etag | String | False | ||
categories | String | False |
The categories associated with the contact. | |
changeKey | String | False |
Identifies the version of the contact. This changes every time the contact is changed. | |
createdDateTime | Datetime | False |
The time the contact was created. | |
lastModifiedDateTime | Datetime | False |
The time the contact was last modified. | |
assistantName | String | False |
The name of the contact's assistant. | |
birthday | Datetime | False |
The contact's birthday. | |
businessAddress_city | String | False |
The city of the contact's business address. | |
businessAddress_countryOrRegion | String | False |
The country or region of the contact's business address. | |
businessAddress_postalCode | String | False |
The postal code of the contact's business address. | |
businessAddress_state | String | False |
The state of the contact's business address. | |
businessAddress_street | String | False |
The street of the contact's business address. | |
businessHomePage | String | False |
The business home page of the contact. | |
businessPhones | String | False |
The contact's business phone numbers. | |
children | String | False |
The names of the contact's children. | |
companyName | String | False |
The name of the contact's company. | |
department | String | False |
The department of the contact. | |
displayName | String | False |
The contact's display name. | |
emailAddresses | String | False |
A collection of email address associated with the contact. | |
fileAs | String | False |
The name the contact is filed under. | |
generation | String | False |
The generation of the contact. | |
givenName | String | False |
The given name of the contact. | |
homeAddress_city | String | False |
The city of the contact's home address. | |
homeAddress_countryOrRegion | String | False |
The country or region of the contact's home address. | |
homeAddress_postalCode | String | False |
The postal code of the contact's home address. | |
homeAddress_state | String | False |
The state of the contact's home address. | |
homeAddress_street | String | False |
The street of the contact's home address. | |
homePhones | String | False |
The contact's home phone numbers | |
imAddresses | String | False |
The contact's instant messaging (IM) address. | |
initials | String | False |
The initials of the contact. | |
jobTitle | String | False |
The contact's job title. | |
manager | String | False |
The name of the contact's manager. | |
middleName | String | False |
The contact's middle name. | |
mobilePhone | String | False |
The mobile phone number of the contact. | |
nickName | String | False |
The contact's nickname. | |
officeLocation | String | False |
The location of the contact's address. | |
otherAddress_city | String | False |
The city of the customer's other address. | |
otherAddress_countryOrRegion | String | False |
The country or region of the customer's other address. | |
otherAddress_postalCode | String | False |
The postal code of the customer's other address | |
otherAddress_state | String | False |
The state of the customer's other address. | |
otherAddress_street | String | False |
The street of the customer's other address. | |
parentFolderId | String | False |
The ID of the contact's parent folder. | |
personalNotes | String | False |
The user's notes about the contact. | |
profession | String | False |
The contact's profession. | |
spouseName | String | False |
The name of the contact's spouse/partner. | |
surname | String | False |
The contact's surname. | |
title | String | False |
The contact's title. | |
yomiCompanyName | String | False |
The phonetic Japanese company name of the contact. | |
yomiGivenName | String | False |
The phonetic Japanese given name (first name) of the contact. | |
yomiSurname | String | False |
The phonetic Japanese surname (last name) of the contact. | |
UserId [KEY] | String | False |
The contact's user ID. |
The Office365 table Conversations.
The GroupId is required to get group Conversations.
SELECT * FROM Conversations WHERE GroupId = 'your GroupId goes here'
You can also get group Conversations by using the GroupId and the Conversation Id.
SELECT * FROM Conversations WHERE Id = 'conversation Id here' AND GroupId = 'your GroupId goes here'
Specify GroupId, Topic, Content, and NewParticipants to create a new Conversation. NewParticipants is a complex type. Its format is as follows: 'name1, email1; name2, email2'.
INSERT INTO Conversations (GroupId, Topic, Content, NewParticipants) VALUES ('GroupId here', 'This is a test topic.', 'Hi, How Are you?', 'someone, [email protected]')
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
The id column for the table Conversations. | |
Etag | String | False | ||
hasAttachments | Bool | False |
The hasAttachments column for the table Conversations. | |
lastDeliveredDateTime | Datetime | False |
The lastDeliveredDateTime column for the table Conversations. | |
preview | String | False |
The preview column for the table Conversations. | |
topic | String | False |
The topic column for the table Conversations. | |
uniqueSenders | String | False |
The uniqueSenders column for the table Conversations. | |
GroupId [KEY] | String | False |
The GroupId column for the table Conversations. | |
Content | String | False |
The Content column for the table Conversations. | |
NewParticipants | String | False |
The NewParticipants column for the table Conversations. |
This field is dynamic and maps to the corresponding field in the API.
The 'me' property is used by default to return events.
You can use the UserId in the WHERE clause to override this when searching for Events.
SELECT * FROM Events WHERE UserId = 'abc123' AND Subject LIKE '%test%'
The GroupId can be a calendar type Id or a group Id. For example:
SELECT * FROM Events WHERE GroupId = 'enter your group Id here'
To create a new event, start and end are required, including the timezone.
INSERT INTO Events (Subject, Body_Content, Start_DateTime, Start_TimeZone, End_DateTime, End_TimeZone) VALUES ('New Test Event', 'Event created using Office365Provider', '2016-01-01T10:00:00', 'UTC', '2016-01-01T11:00:00', 'UTC')
Note: By default this statement will create your event under the default calendar.
Note: In case of client credentials, UserId is required in order to create a new Event:
INSERT INTO Events (Subject, Body_Content, Start_DateTime, Start_TimeZone, End_DateTime, End_TimeZone, UserId) VALUES ('New Test Event', 'Event created using Office365Provider', '2016-01-01T10:00:00', 'UTC', '2016-01-01T11:00:00', 'UTC', '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe')
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
This field is dynamic and maps to the corresponding field in the API. | |
Etag | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
categories | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
changeKey | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
createdDateTime | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
lastModifiedDateTime | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
allowNewTimeProposals | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
attendees | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
body_content | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
body_contentType | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
bodyPreview | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
end_dateTime | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
end_timeZone | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
hasAttachments | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
hideAttendees | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
iCalUId | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
importance | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
isAllDay | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isCancelled | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isDraft | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isOnlineMeeting | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isOrganizer | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
isReminderOn | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_address_city | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_address_countryOrRegion | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_address_postalCode | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_address_state | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_address_street | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_coordinates_accuracy | Double | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_coordinates_altitude | Double | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_coordinates_altitudeAccuracy | Double | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_coordinates_latitude | Double | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_coordinates_longitude | Double | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_displayName | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_locationEmailAddress | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_locationType | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_locationUri | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_uniqueId | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
location_uniqueIdType | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
locations | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeeting_conferenceId | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeeting_joinUrl | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeeting_phones | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeeting_quickDial | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeeting_tollFreeNumbers | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeeting_tollNumber | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeetingProvider | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
onlineMeetingUrl | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
organizer_emailAddress_address | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
organizer_emailAddress_name | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
originalEndTimeZone | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
originalStart | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
originalStartTimeZone | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_dayOfMonth | Int | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_daysOfWeek | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_firstDayOfWeek | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_index | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_interval | Int | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_month | Int | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_pattern_type | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_range_endDate | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_range_numberOfOccurrences | Int | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_range_recurrenceTimeZone | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_range_startDate | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
recurrence_range_type | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
reminderMinutesBeforeStart | Int | False |
This field is dynamic and maps to the corresponding field in the API. | |
responseRequested | Bool | False |
This field is dynamic and maps to the corresponding field in the API. | |
responseStatus_response | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
responseStatus_time | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
sensitivity | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
seriesMasterId | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
showAs | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
start_dateTime | Datetime | False |
This field is dynamic and maps to the corresponding field in the API. | |
start_timeZone | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
subject | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
transactionId | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
type | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
webLink | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
UserId | String | False |
This field is dynamic and maps to the corresponding field in the API. | |
GroupId | String | False |
This field is dynamic and maps to the corresponding field in the API. |
The Office365 table Files.
Retrieve files by using the UserId or File Id (Id) for instance, or simply filter by a certain column:
SELECT * FROM Files WHERE UserId = 'MyUserId' SELECT Name, LastModifiedDateTime FROM Files WHERE Name LIKE 'test%'
To work for Folder-level files, we need to specify the parentReference_path in the query.
SELECT * FROM files WHERE parentReference_path = '/drives/b!3LIvU2zISEqicGlWkgVknKxKT-q7gM5IqlBJ4w4MZqaX6BQc_vtwQpnqaldXkH9I/root:/Test_Shubham';
INSERT operation is not supported for this table.
Note: See UploadFile (or CreateFolder to create a folder) to insert and update content to a file.
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
The id column for the table Files. | |
Etag | String | False |
The Etag column for the table Files. | |
createdBy_application_displayName | String | False |
The createdBy_application_displayName column for the table Files. | |
createdBy_application_id | String | False |
The createdBy_application_id column for the table Files. | |
createdDateTime | Datetime | False |
The createdDateTime column for the table Files. | |
description | String | False |
The description column for the table Files. | |
lastModifiedBy_application_displayName | String | False |
The lastModifiedBy_application_displayName column for the table Files. | |
lastModifiedBy_application_id | String | False |
The lastModifiedBy_application_id column for the table Files. | |
lastModifiedDateTime | Datetime | False |
The lastModifiedDateTime column for the table Files. | |
name | String | False |
The name column for the table Files. | |
parentReference_driveId | String | False |
The parentReference_driveId column for the table Files. | |
parentReference_driveType | String | False |
The parentReference_driveType column for the table Files. | |
parentReference_id | String | False |
The parentReference_id column for the table Files. | |
parentReference_name | String | False |
The parentReference_name column for the table Files. | |
parentReference_path | String | False |
The parentReference_path column for the table Files. | |
parentReference_shareId | String | False |
The parentReference_shareId column for the table Files. | |
parentReference_sharepointIds_listId | String | False |
The parentReference_sharepointIds_listId column for the table Files. | |
parentReference_sharepointIds_listItemId | String | False |
The parentReference_sharepointIds_listItemId column for the table Files. | |
parentReference_sharepointIds_listItemUniqueId | String | False |
The parentReference_sharepointIds_listItemUniqueId column for the table Files. | |
parentReference_sharepointIds_siteId | String | False |
The parentReference_sharepointIds_siteId column for the table Files. | |
parentReference_sharepointIds_siteUrl | String | False |
The parentReference_sharepointIds_siteUrl column for the table Files. | |
parentReference_sharepointIds_tenantId | String | False |
The parentReference_sharepointIds_tenantId column for the table Files. | |
parentReference_sharepointIds_webId | String | False |
The parentReference_sharepointIds_webId column for the table Files. | |
parentReference_siteId | String | False |
The parentReference_siteId column for the table Files. | |
webUrl | String | False |
The webUrl column for the table Files. | |
audio_album | String | False |
The audio_album column for the table Files. | |
audio_albumArtist | String | False |
The audio_albumArtist column for the table Files. | |
audio_artist | String | False |
The audio_artist column for the table Files. | |
audio_bitrate | Long | False |
The audio_bitrate column for the table Files. | |
audio_composers | String | False |
The audio_composers column for the table Files. | |
audio_copyright | String | False |
The audio_copyright column for the table Files. | |
audio_disc | Int | False |
The audio_disc column for the table Files. | |
audio_discCount | Int | False |
The audio_discCount column for the table Files. | |
audio_duration | Long | False |
The audio_duration column for the table Files. | |
audio_genre | String | False |
The audio_genre column for the table Files. | |
audio_hasDrm | Bool | False |
The audio_hasDrm column for the table Files. | |
audio_isVariableBitrate | Bool | False |
The audio_isVariableBitrate column for the table Files. | |
audio_title | String | False |
The audio_title column for the table Files. | |
audio_track | Int | False |
The audio_track column for the table Files. | |
audio_trackCount | Int | False |
The audio_trackCount column for the table Files. | |
audio_year | Int | False |
The audio_year column for the table Files. | |
content | String | False |
The content column for the table Files. | |
cTag | String | False |
The cTag column for the table Files. | |
deleted_state | String | False |
The deleted_state column for the table Files. | |
file_hashes_crc32Hash | String | False |
The file_hashes_crc32Hash column for the table Files. | |
file_hashes_quickXorHash | String | False |
The file_hashes_quickXorHash column for the table Files. | |
file_hashes_sha1Hash | String | False |
The file_hashes_sha1Hash column for the table Files. | |
file_hashes_sha256Hash | String | False |
The file_hashes_sha256Hash column for the table Files. | |
file_mimeType | String | False |
The file_mimeType column for the table Files. | |
file_processingMetadata | Bool | False |
The file_processingMetadata column for the table Files. | |
fileSystemInfo_createdDateTime | Datetime | False |
The fileSystemInfo_createdDateTime column for the table Files. | |
fileSystemInfo_lastAccessedDateTime | Datetime | False |
The fileSystemInfo_lastAccessedDateTime column for the table Files. | |
fileSystemInfo_lastModifiedDateTime | Datetime | False |
The fileSystemInfo_lastModifiedDateTime column for the table Files. | |
folder_childCount | Int | False |
The folder_childCount column for the table Files. | |
folder_view_sortBy | String | False |
The folder_view_sortBy column for the table Files. | |
folder_view_sortOrder | String | False |
The folder_view_sortOrder column for the table Files. | |
folder_view_viewType | String | False |
The folder_view_viewType column for the table Files. | |
image_height | Int | False |
The image_height column for the table Files. | |
image_width | Int | False |
The image_width column for the table Files. | |
location_altitude | Double | False |
The location_altitude column for the table Files. | |
location_latitude | Double | False |
The location_latitude column for the table Files. | |
location_longitude | Double | False |
The location_longitude column for the table Files. | |
package_type | String | False |
The package_type column for the table Files. | |
pendingOperations_pendingContentUpdate_queuedDateTime | Datetime | False |
The pendingOperations_pendingContentUpdate_queuedDateTime column for the table Files. | |
photo_cameraMake | String | False |
The photo_cameraMake column for the table Files. | |
photo_cameraModel | String | False |
The photo_cameraModel column for the table Files. | |
photo_exposureDenominator | Double | False |
The photo_exposureDenominator column for the table Files. | |
photo_exposureNumerator | Double | False |
The photo_exposureNumerator column for the table Files. | |
photo_fNumber | Double | False |
The photo_fNumber column for the table Files. | |
photo_focalLength | Double | False |
The photo_focalLength column for the table Files. | |
photo_iso | Int | False |
The photo_iso column for the table Files. | |
photo_orientation | Int | False |
The photo_orientation column for the table Files. | |
photo_takenDateTime | Datetime | False |
The photo_takenDateTime column for the table Files. | |
publication_level | String | False |
The publication_level column for the table Files. | |
publication_versionId | String | False |
The publication_versionId column for the table Files. | |
remoteItem_createdBy_application_displayName | String | False |
The remoteItem_createdBy_application_displayName column for the table Files. | |
remoteItem_createdBy_application_id | String | False |
The remoteItem_createdBy_application_id column for the table Files. | |
remoteItem_createdDateTime | Datetime | False |
The remoteItem_createdDateTime column for the table Files. | |
remoteItem_file_hashes_crc32Hash | String | False |
The remoteItem_file_hashes_crc32Hash column for the table Files. | |
remoteItem_file_hashes_quickXorHash | String | False |
The remoteItem_file_hashes_quickXorHash column for the table Files. | |
remoteItem_file_hashes_sha1Hash | String | False |
The remoteItem_file_hashes_sha1Hash column for the table Files. | |
remoteItem_file_hashes_sha256Hash | String | False |
The remoteItem_file_hashes_sha256Hash column for the table Files. | |
remoteItem_file_mimeType | String | False |
The remoteItem_file_mimeType column for the table Files. | |
remoteItem_file_processingMetadata | Bool | False |
The remoteItem_file_processingMetadata column for the table Files. | |
remoteItem_fileSystemInfo_createdDateTime | Datetime | False |
The remoteItem_fileSystemInfo_createdDateTime column for the table Files. | |
remoteItem_fileSystemInfo_lastAccessedDateTime | Datetime | False |
The remoteItem_fileSystemInfo_lastAccessedDateTime column for the table Files. | |
remoteItem_fileSystemInfo_lastModifiedDateTime | Datetime | False |
The remoteItem_fileSystemInfo_lastModifiedDateTime column for the table Files. | |
remoteItem_folder_childCount | Int | False |
The remoteItem_folder_childCount column for the table Files. | |
remoteItem_folder_view_sortBy | String | False |
The remoteItem_folder_view_sortBy column for the table Files. | |
remoteItem_folder_view_sortOrder | String | False |
The remoteItem_folder_view_sortOrder column for the table Files. | |
remoteItem_folder_view_viewType | String | False |
The remoteItem_folder_view_viewType column for the table Files. | |
remoteItem_id | String | False |
The remoteItem_id column for the table Files. | |
remoteItem_image_height | Int | False |
The remoteItem_image_height column for the table Files. | |
remoteItem_image_width | Int | False |
The remoteItem_image_width column for the table Files. | |
remoteItem_lastModifiedDateTime | Datetime | False |
The remoteItem_lastModifiedDateTime column for the table Files. | |
remoteItem_name | String | False |
The remoteItem_name column for the table Files. | |
remoteItem_package_type | String | False |
The remoteItem_package_type column for the table Files. | |
remoteItem_parentReference_driveId | String | False |
The remoteItem_parentReference_driveId column for the table Files. | |
remoteItem_parentReference_driveType | String | False |
The remoteItem_parentReference_driveType column for the table Files. | |
remoteItem_parentReference_id | String | False |
The remoteItem_parentReference_id column for the table Files. | |
remoteItem_parentReference_name | String | False |
The remoteItem_parentReference_name column for the table Files. | |
remoteItem_parentReference_path | String | False |
The remoteItem_parentReference_path column for the table Files. | |
remoteItem_parentReference_shareId | String | False |
The remoteItem_parentReference_shareId column for the table Files. | |
remoteItem_parentReference_sharepointIds_listId | String | False |
The remoteItem_parentReference_sharepointIds_listId column for the table Files. | |
remoteItem_parentReference_sharepointIds_listItemId | String | False |
The remoteItem_parentReference_sharepointIds_listItemId column for the table Files. | |
remoteItem_parentReference_sharepointIds_listItemUniqueId | String | False |
The remoteItem_parentReference_sharepointIds_listItemUniqueId column for the table Files. | |
remoteItem_parentReference_sharepointIds_siteId | String | False |
The remoteItem_parentReference_sharepointIds_siteId column for the table Files. | |
remoteItem_parentReference_sharepointIds_siteUrl | String | False |
The remoteItem_parentReference_sharepointIds_siteUrl column for the table Files. | |
remoteItem_parentReference_sharepointIds_tenantId | String | False |
The remoteItem_parentReference_sharepointIds_tenantId column for the table Files. | |
remoteItem_parentReference_sharepointIds_webId | String | False |
The remoteItem_parentReference_sharepointIds_webId column for the table Files. | |
remoteItem_parentReference_siteId | String | False |
The remoteItem_parentReference_siteId column for the table Files. | |
remoteItem_shared_scope | String | False |
The remoteItem_shared_scope column for the table Files. | |
remoteItem_shared_sharedDateTime | Datetime | False |
The remoteItem_shared_sharedDateTime column for the table Files. | |
remoteItem_size | Long | False |
The remoteItem_size column for the table Files. | |
remoteItem_specialFolder_name | String | False |
The remoteItem_specialFolder_name column for the table Files. | |
remoteItem_video_audioBitsPerSample | Int | False |
The remoteItem_video_audioBitsPerSample column for the table Files. | |
remoteItem_video_audioChannels | Int | False |
The remoteItem_video_audioChannels column for the table Files. | |
remoteItem_video_audioSamplesPerSecond | Int | False |
The remoteItem_video_audioSamplesPerSecond column for the table Files. | |
remoteItem_video_bitrate | Int | False |
The remoteItem_video_bitrate column for the table Files. | |
remoteItem_video_duration | Long | False |
The remoteItem_video_duration column for the table Files. | |
remoteItem_video_fourCC | String | False |
The remoteItem_video_fourCC column for the table Files. | |
remoteItem_video_frameRate | Double | False |
The remoteItem_video_frameRate column for the table Files. | |
remoteItem_video_height | Int | False |
The remoteItem_video_height column for the table Files. | |
remoteItem_video_width | Int | False |
The remoteItem_video_width column for the table Files. | |
remoteItem_webDavUrl | String | False |
The remoteItem_webDavUrl column for the table Files. | |
remoteItem_webUrl | String | False |
The remoteItem_webUrl column for the table Files. | |
searchResult_onClickTelemetryUrl | String | False |
The searchResult_onClickTelemetryUrl column for the table Files. | |
shared_owner_application_displayName | String | False |
The shared_owner_application_displayName column for the table Files. | |
shared_owner_application_id | String | False |
The shared_owner_application_id column for the table Files. | |
shared_scope | String | False |
The shared_scope column for the table Files. | |
shared_sharedDateTime | Datetime | False |
The shared_sharedDateTime column for the table Files. | |
sharepointIds_listId | String | False |
The sharepointIds_listId column for the table Files. | |
sharepointIds_listItemId | String | False |
The sharepointIds_listItemId column for the table Files. | |
sharepointIds_listItemUniqueId | String | False |
The sharepointIds_listItemUniqueId column for the table Files. | |
sharepointIds_siteId | String | False |
The sharepointIds_siteId column for the table Files. | |
sharepointIds_siteUrl | String | False |
The sharepointIds_siteUrl column for the table Files. | |
sharepointIds_tenantId | String | False |
The sharepointIds_tenantId column for the table Files. | |
sharepointIds_webId | String | False |
The sharepointIds_webId column for the table Files. | |
size | Long | False |
The size column for the table Files. | |
specialFolder_name | String | False |
The specialFolder_name column for the table Files. | |
video_audioBitsPerSample | Int | False |
The video_audioBitsPerSample column for the table Files. | |
video_audioChannels | Int | False |
The video_audioChannels column for the table Files. | |
video_audioFormat | String | False |
The video_audioFormat column for the table Files. | |
video_audioSamplesPerSecond | Int | False |
The video_audioSamplesPerSecond column for the table Files. | |
video_bitrate | Int | False |
The video_bitrate column for the table Files. | |
video_duration | Long | False |
The video_duration column for the table Files. | |
video_fourCC | String | False |
The video_fourCC column for the table Files. | |
video_frameRate | Double | False |
The video_frameRate column for the table Files. | |
video_height | Int | False |
The video_height column for the table Files. | |
video_width | Int | False |
The video_width column for the table Files. | |
webDavUrl | String | False |
The webDavUrl column for the table Files. | |
UserId | String | False |
The UserId column for the table Files. |
The Office365 table Groups.
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 and the Group.ReadWrite.All permissions. 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 OAuth Application 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
Note that if your organization has multiple tenants, you may replace the /common/ in the url with the tenant id to indicate which tenant to grant permissions for.
Retrieve all groups, specify a GroupId (Id), or simply filter by a certain column:
SELECT * FROM Groups WHERE Id = 'Group Id here' SELECT Id, Description, DisplayName FROM Groups WHERE DisplayName = 'test'
The following are required to create a new Security Group:
INSERT INTO Groups (DisplayName, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test group', false, 'test', true)
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
The unique identifier for the group. | |
Etag | String | False | ||
deletedDateTime | Datetime | False | ||
allowExternalSenders | Bool | False |
Indicates if people external to the organization can send messages to the group. | |
assignedLabels | String | False | ||
assignedLicenses | String | False | ||
autoSubscribeNewMembers | Bool | False |
Indicates if new members added to the group will be auto-subscribed to receive email notifications. | |
classification | String | False | ||
createdDateTime | Datetime | False | ||
description | String | False |
An optional description for the group. | |
displayName | String | False |
The display name for the group. | |
expirationDateTime | Datetime | False | ||
groupTypes | String | False |
Specifies the type of group to create. Possible values are Unified to create an Office 365 group, or DynamicMembership for dynamic groups. For all other group types, like security-enabled groups and email-enabled security groups, do not set this property. | |
hasMembersWithLicenseErrors | Bool | False | ||
hideFromAddressLists | Bool | False | ||
hideFromOutlookClients | Bool | False | ||
isArchived | Bool | False | ||
isSubscribedByMail | Bool | False |
Indicates whether the current user is subscribed to receive email conversations. | |
licenseProcessingState_state | String | False | ||
String | False |
The SMTP address for the group. | ||
mailEnabled | Bool | False |
Specifies whether the group is mail-enabled. If the securityEnabled property is also true, the group is a mail-enabled security group; otherwise, the group is a Microsoft Exchange distribution group. | |
mailNickname | String | False |
The mail alias for the group, unique in the organization. | |
membershipRule | String | False | ||
membershipRuleProcessingState | String | False | ||
onPremisesDomainName | String | False | ||
onPremisesLastSyncDateTime | Datetime | False |
Indicates the last time at which the group was synced with the on-premises directory. | |
onPremisesNetBiosName | String | False | ||
onPremisesProvisioningErrors | String | False | ||
onPremisesSamAccountName | String | False | ||
onPremisesSecurityIdentifier | String | False |
Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. | |
onPremisesSyncEnabled | Bool | False |
True if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory. | |
preferredDataLocation | String | False | ||
preferredLanguage | String | False | ||
proxyAddresses | String | False |
The proxy addresses for the table Groups. | |
renewedDateTime | Datetime | False | ||
securityEnabled | Bool | False |
Specifies whether the group is a security group. If the mailEnabled property is also true, the group is a mail-enabled security group; otherwise it is a security group. Must be false for Office 365 groups. | |
securityIdentifier | String | False | ||
theme | String | False | ||
unseenCount | Int | False |
Count of posts that the current user has not seen since his last visit. | |
visibility | String | False |
Specifies the visibility of an Office 365 group. The possible values are: Private, Public, HiddenMembership, or empty (which is interpreted as Public). |
The Office365 table Messages.
You can retrieve all from Messages, specify a Message (Id), UserId, or ParentFolderId, or you can filter results by a certain column:
SELECT * FROM Messages WHERE Id = 'MyMessageId' SELECT * FROM Messages WHERE UserId = 'MyUserId' SELECT * FROM Messages WHERE ParentFolderId = 'MyParentfolderId' SELECT * FROM Messages WHERE ParentFolderId = 'Drafts' SELECT DisplayName, Id FROM Users WHERE DisplayName LIKE 'John%'
After the insert a new Message will be created in the User's Drafts folder.
INSERT INTO Messages (Subject, Body_Content, UserId) VALUES ('New test Email', 'Test Email created.', 'User Id goes here')
Note: To send the mail, see SendMail.
There's currently an issue with this table. Sometimes it may return an inconsistent number of results. That is, it can return X number of rows for some query and if you try that query again shortly after it will return a different numbers of rows, even though you haven't changed anything. Some rows may be missing.
This is a known API issue that currently has no workaround. As soon as Microsoft fixes it on their Microsoft Graph API then it will automatically work on this Cloud too.
That being said, there is a configuration that you can apply on the Cloud to retrieve all messages, but it comes with a downfall: 'events' and 'contacts' data will be returned along with 'messages' data. So we guarantee no purity of information. You will have to rely on your own filtering to distinguish between message and non-message rows.
In order to activate the configuration simply add "ClientSidePaging=true;" (without quotation marks) in the value of Other connection property.
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True |
The id column of the Messages table. | |
Etag | String | False |
The Etag column of the Messages table. | |
categories | String | False |
The categories column of the Messages table. | |
changeKey | String | False |
The changeKey column of the Messages table. | |
createdDateTime | Datetime | False |
The createdDateTime column of the Messages table. | |
lastModifiedDateTime | Datetime | False |
The lastModifiedDateTime column of the Messages table. | |
bccRecipients | String | False |
The bccRecipients column of the Messages table. | |
body_content | String | False |
The body_content column of the Messages table. | |
body_contentType | String | False |
The body_contentType column of the Messages table. | |
bodyPreview | String | False |
The bodyPreview column of the Messages table. | |
ccRecipients | String | False |
The ccRecipients column of the Messages table. | |
conversationId | String | False |
The conversationId column of the Messages table. | |
conversationIndex | Binary | False |
The conversationIndex column of the Messages table. | |
flag_completedDateTime_dateTime | Datetime | False |
The flag_completedDateTime_dateTime column of the Messages table. | |
flag_completedDateTime_timeZone | String | False |
The flag_completedDateTime_timeZone column of the Messages table. | |
flag_flagStatus | String | False |
The flag_flagStatus column of the Messages table. | |
from_emailAddress_address | String | False |
The from_emailAddress_address column of the Messages table. | |
from_emailAddress_name | String | False |
The from_emailAddress_name column of the Messages table. | |
hasAttachments | Bool | False |
The hasAttachments column of the Messages table. | |
importance | String | False |
The importance column of the Messages table. | |
inferenceClassification | String | False |
The inferenceClassification column of the Messages table. | |
internetMessageHeaders | String | False |
The internetMessageHeaders column of the Messages table. | |
internetMessageId | String | False |
The internetMessageId column of the Messages table. | |
isDeliveryReceiptRequested | Bool | False |
The isDeliveryReceiptRequested column of the Messages table. | |
isDraft | Bool | False |
The isDraft column of the Messages table. | |
isRead | Bool | False |
The isRead column of the Messages table. | |
isReadReceiptRequested | Bool | False |
The isReadReceiptRequested column of the Messages table. | |
parentFolderId | String | False |
The parentFolderId column of the Messages table. | |
receivedDateTime | Datetime | False |
The receivedDateTime column of the Messages table. | |
replyTo | String | False |
The replyTo column of the Messages table. | |
sender_emailAddress_address | String | False |
The sender_emailAddress_address column of the Messages table. | |
sender_emailAddress_name | String | False |
The sender_emailAddress_name column of the Messages table. | |
sentDateTime | Datetime | False |
The sentDateTime column of the Messages table. | |
subject | String | False |
The subject column of the Messages table. | |
toRecipients | String | False |
The toRecipients column of the Messages table. | |
uniqueBody_content | String | False |
The uniqueBody_content column of the Messages table. | |
uniqueBody_contentType | String | False |
The uniqueBody_contentType column of the Messages table. | |
webLink | String | False |
The webLink column of the Messages table. | |
UserId | String | False |
The UserId column of the Messages table. | |
IsEventMessage | Bool | False |
he column to distinguish if the messages is with calendar/event invites |
The Office365 table Tasks.
Tasks requires the Groups and Tasks permissions from the Microsoft Graph. For this reason, you must create your own OAuth App. Please see Creating a Custom OAuth Application for more details.
By default, if no criteria is specified, only Tasks personally assigned to you will show up. For example:
SELECT * FROM Tasks
To bring back tasks across the organization, provide the specific plans ids, or use a subselect for the plan id. For example:
SELECT * FROM Tasks WHERE PlanId IN (SELECT Id FROM Plans)
To insert a Task, the associated plan must be specified:
INSERT INTO Tasks (Title, PlanId) VALUES ('My Title', '99999999-eeeeeeeee')
To update a Task, both the Id and Etag must be specified:
UPDATE Tasks SET Title = 'New Title' WHERE Id = 'xxxxxx-AAAAAAAAAAA' AND Etag = 'W/\"XXXXXXQEBAQEBAQEBAQEBAQEBARCc=\"'
To delete a Task, both the Id and Etag must be specified:
DELETE FROM Tasks WHERE Id = 'xxxxxx-AAAAAAAAAAA' AND Etag = 'W/\"XXXXXXQEBAQEBAQEBAQEBAQEBARCc=\"'
Name | Type | ReadOnly | References | Description |
activeChecklistItemCount | Int | False | ||
appliedCategories | String | False | ||
assigneePriority | String | False | ||
assignments | String | False | ||
bucketId | String | False | ||
checklistItemCount | Int | False | ||
completedBy_application_displayName | String | False | ||
completedBy_application_id | String | False | ||
completedDateTime | Datetime | False | ||
conversationThreadId | String | False | ||
createdBy_application_displayName | String | False | ||
createdBy_application_id | String | False | ||
createdDateTime | Datetime | False | ||
dueDateTime | Datetime | False | ||
hasDescription | Bool | False | ||
orderHint | String | False | ||
percentComplete | Int | False | ||
planId | String | False | ||
previewType | String | False | ||
priority | Int | False | ||
referenceCount | Int | False | ||
startDateTime | Datetime | False | ||
title | String | False | ||
Etag | String | False | ||
Id [KEY] | String | False |
Read, Insert, Update and Delete a User.
Query the Users table by retrieving everything from Users, specifying a Id, or filtering by a column:
SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617' SELECT DisplayName, Id FROM Users WHERE DisplayName LIKE 'John%'
The following are required to create a new organizational User:
INSERT INTO Users (AccountEnabled, DisplayName, MailNickname, UserPrincipalName, PasswordProfile_ForceChangePasswordNextSignIn, PasswordProfile_Password) VALUES (false, 'John Smith', 'JohnS', '[email protected]', true, '123password')
Name | Type | ReadOnly | References | Description |
id [KEY] | String | True | ||
deletedDateTime | Datetime | False | ||
accountEnabled | Bool | False | ||
businessPhones | String | False | ||
city | String | False | ||
companyName | String | False | ||
country | String | False | ||
createdDateTime | Datetime | False | ||
department | String | False | ||
displayName | String | False | ||
employeeHireDate | Datetime | False | ||
employeeId | String | False | ||
employeeLeaveDateTime | Datetime | False | ||
employeeOrgData_costCenter | String | False | ||
employeeOrgData_division | String | False | ||
employeeType | String | False | ||
givenName | String | False | ||
identities | String | False | ||
imAddresses | String | False | ||
isResourceAccount | Bool | False | ||
jobTitle | String | False | ||
lastPasswordChangeDateTime | Datetime | False | ||
String | False | |||
mailNickname | String | False | ||
mobilePhone | String | False | ||
officeLocation | String | False | ||
onPremisesDistinguishedName | String | False | ||
onPremisesDomainName | String | False | ||
onPremisesExtensionAttributes_extensionAttribute1 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute10 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute11 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute12 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute13 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute14 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute15 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute2 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute3 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute4 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute5 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute6 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute7 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute8 | String | False | ||
onPremisesExtensionAttributes_extensionAttribute9 | String | False | ||
onPremisesImmutableId | String | False | ||
onPremisesLastSyncDateTime | Datetime | False | ||
onPremisesProvisioningErrors | String | False | ||
onPremisesSamAccountName | String | False | ||
onPremisesSecurityIdentifier | String | False | ||
onPremisesSyncEnabled | Bool | False | ||
onPremisesUserPrincipalName | String | False | ||
otherMails | String | False | ||
passwordProfile_forceChangePasswordNextSignIn | Bool | False | ||
passwordProfile_forceChangePasswordNextSignInWithMfa | Bool | False | ||
passwordProfile_password | String | False | ||
postalCode | String | False | ||
preferredLanguage | String | False | ||
securityIdentifier | String | False | ||
state | String | False | ||
streetAddress | String | False | ||
surname | String | False | ||
userPrincipalName | String | False | ||
userType | String | False |
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.
Name | Description |
CalendarView | Retrieve the ccurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's. |
EventOccurrences | Usage information for the operation EventOccurrences.rsd. |
Plans | The Office365 table Plans. |
Retrieve the ccurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's.
Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's. By default only the event occurrences from the user's default calendar in the range of the last 30 days will be returned. You can filter results by CalendarId, UserId, Start_DateTime, End_DateTime.
For example the following queries will be processed server side:
SELECT * FROM CalendarView WHERE Start_DateTime >= '2019-12-10 15:00' AND End_DateTime <= '2020-01-10 14:30'
SELECT * FROM CalendarView WHERE CalendarId = 'AQMkAGRlMWQ5MDg0LWI5ZTQtNDk2Yi1hOTQ1LTU4YzFmMzEwZjlhMgBGAAAD-FjxR3cIwE6TEGSCVtIHcwcAQyR2Iw3coEOaUD1BLt0tnAAAAwcAAABDJHYjDdygQ5pQPUEu3S2cAAACC_IAAAA='
SELECT * FROM CalendarView WHERE CalendarId = 'AQMkAGRlMWQ5MDg0LWI5ZTQtNDk2Yi1hOTQ1LTU4YzFmMzEwZjlhMgBGAAAD-FjxR3cIwE6TEGSCVtIHcwcAQyR2Iw3coEOaUD1BLt0tnAAAAwcAAABDJHYjDdygQ5pQPUEu3S2cAAACC_IAAAA=' AND UserId = 'a98f25b5-5da1-4937-8729-c0d03026caa0' AND Start_DateTime >= '2019-12-15 08:00' AND End_DateTime <= '2020-01-14 08:00'
Name | Type | References | Description |
id [KEY] | String | ||
Etag | String | ||
categories | String | ||
changeKey | String | ||
createdDateTime | Datetime | ||
lastModifiedDateTime | Datetime | ||
allowNewTimeProposals | Bool | ||
attendees | String | ||
body_content | String | ||
body_contentType | String | ||
bodyPreview | String | ||
end_dateTime | Datetime | ||
end_timeZone | String | ||
hasAttachments | Bool | ||
hideAttendees | Bool | ||
iCalUId | String | ||
importance | String | ||
isAllDay | Bool | ||
isCancelled | Bool | ||
isDraft | Bool | ||
isOnlineMeeting | Bool | ||
isOrganizer | Bool | ||
isReminderOn | Bool | ||
location_address_city | String | ||
location_address_countryOrRegion | String | ||
location_address_postalCode | String | ||
location_address_state | String | ||
location_address_street | String | ||
location_coordinates_accuracy | Double | ||
location_coordinates_altitude | Double | ||
location_coordinates_altitudeAccuracy | Double | ||
location_coordinates_latitude | Double | ||
location_coordinates_longitude | Double | ||
location_displayName | String | ||
location_locationEmailAddress | String | ||
location_locationType | String | ||
location_locationUri | String | ||
location_uniqueId | String | ||
location_uniqueIdType | String | ||
locations | String | ||
onlineMeeting_conferenceId | String | ||
onlineMeeting_joinUrl | String | ||
onlineMeeting_phones | String | ||
onlineMeeting_quickDial | String | ||
onlineMeeting_tollFreeNumbers | String | ||
onlineMeeting_tollNumber | String | ||
onlineMeetingProvider | String | ||
onlineMeetingUrl | String | ||
organizer_emailAddress_address | String | ||
organizer_emailAddress_name | String | ||
originalEndTimeZone | String | ||
originalStart | Datetime | ||
originalStartTimeZone | String | ||
recurrence_pattern_dayOfMonth | Int | ||
recurrence_pattern_daysOfWeek | String | ||
recurrence_pattern_firstDayOfWeek | String | ||
recurrence_pattern_index | String | ||
recurrence_pattern_interval | Int | ||
recurrence_pattern_month | Int | ||
recurrence_pattern_type | String | ||
recurrence_range_endDate | Datetime | ||
recurrence_range_numberOfOccurrences | Int | ||
recurrence_range_recurrenceTimeZone | String | ||
recurrence_range_startDate | Datetime | ||
recurrence_range_type | String | ||
reminderMinutesBeforeStart | Int | ||
responseRequested | Bool | ||
responseStatus_response | String | ||
responseStatus_time | Datetime | ||
sensitivity | String | ||
seriesMasterId | String | ||
showAs | String | ||
start_dateTime | Datetime | ||
start_timeZone | String | ||
subject | String | ||
transactionId | String | ||
type | String | ||
webLink | String | ||
UserId | String | ||
CalendarId | String |
Usage information for the operation EventOccurrences.rsd.
You can query EventOccurrences by specifying the Event Id, StartDatetime and EndDateTime. EventId is a required field, instead StartDatetime and EndDateTime have a default range of the last 30 days. If you query filtering only by EventId and the specific event does not exist within this time range, you will get empty results.
SELECT * FROM [EventOccurrences] WHERE id = 'event id' AND StartDateTime = '2018/01/01' AND EndDateTime = '2018/12/31'
By default, if StartDateTime and EndDateTime filters are not specified, only the event occurrences from the user's default calendar in the range of the last 30 days will be returned. Otherwise, the query will get the Occurrences of the Event during the period specified by StartDateTime and EndDateTime.
Name | Type | References | Description |
GroupId | String | ||
UserId | String | ||
Events_id [KEY] | String |
Events.id | |
id [KEY] | String | ||
categories | String | ||
changeKey | String | ||
createdDateTime | Datetime | ||
lastModifiedDateTime | Datetime | ||
allowNewTimeProposals | Bool | ||
attendees | String | ||
body_content | String | ||
body_contentType | String | ||
bodyPreview | String | ||
end_dateTime | Datetime | ||
end_timeZone | String | ||
hasAttachments | Bool | ||
hideAttendees | Bool | ||
iCalUId | String | ||
importance | String | ||
isAllDay | Bool | ||
isCancelled | Bool | ||
isDraft | Bool | ||
isOnlineMeeting | Bool | ||
isOrganizer | Bool | ||
isReminderOn | Bool | ||
location_address_city | String | ||
location_address_countryOrRegion | String | ||
location_address_postalCode | String | ||
location_address_state | String | ||
location_address_street | String | ||
location_coordinates_accuracy | Double | ||
location_coordinates_altitude | Double | ||
location_coordinates_altitudeAccuracy | Double | ||
location_coordinates_latitude | Double | ||
location_coordinates_longitude | Double | ||
location_displayName | String | ||
location_locationEmailAddress | String | ||
location_locationType | String | ||
location_locationUri | String | ||
location_uniqueId | String | ||
location_uniqueIdType | String | ||
locations | String | ||
onlineMeeting_conferenceId | String | ||
onlineMeeting_joinUrl | String | ||
onlineMeeting_phones | String | ||
onlineMeeting_quickDial | String | ||
onlineMeeting_tollFreeNumbers | String | ||
onlineMeeting_tollNumber | String | ||
onlineMeetingProvider | String | ||
onlineMeetingUrl | String | ||
organizer_emailAddress_address | String | ||
organizer_emailAddress_name | String | ||
originalEndTimeZone | String | ||
originalStart | Datetime | ||
originalStartTimeZone | String | ||
recurrence_pattern_dayOfMonth | Int | ||
recurrence_pattern_daysOfWeek | String | ||
recurrence_pattern_firstDayOfWeek | String | ||
recurrence_pattern_index | String | ||
recurrence_pattern_interval | Int | ||
recurrence_pattern_month | Int | ||
recurrence_pattern_type | String | ||
recurrence_range_endDate | Datetime | ||
recurrence_range_numberOfOccurrences | Int | ||
recurrence_range_recurrenceTimeZone | String | ||
recurrence_range_startDate | Datetime | ||
recurrence_range_type | String | ||
reminderMinutesBeforeStart | Int | ||
responseRequested | Bool | ||
responseStatus_response | String | ||
responseStatus_time | Datetime | ||
sensitivity | String | ||
seriesMasterId | String | ||
showAs | String | ||
start_dateTime | Datetime | ||
start_timeZone | String | ||
subject | String | ||
transactionId | String | ||
type | String | ||
webLink | String |
The Office365 table Plans.
Using Plans requires access to Groups permissions. This requires Admin approval. For this reason, you must use your own OAuth App to add the Groups permissions and from the Microsoft Graph. See Creating a Custom OAuth Application for more details.
All plans in MS Planner exist as a part of a group. In order to retrieve the list of available plans, you must retrieve a list of available plans per group.
If no GroupId is specified, then the following WHERE condition will be appended to any query:
GroupId IN (SELECT Id FROM Groups)
Name | Type | References | Description |
container_containerId | String | ||
container_type | String | ||
container_url | String | ||
createdBy_application_displayName | String | ||
createdBy_application_id | String | ||
createdDateTime | Datetime | ||
owner | String | ||
title | String | ||
GroupId | String | ||
Id [KEY] | String |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Office 365.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Office 365, along with an indication of whether the procedure succeeded or failed.
Name | Description |
AssignLicense | Add or remove subscriptions for the user. You can also enable and disable specific plans associated with a subscription |
CancelEvent | Cancels an event. |
CreateFolder | Upload a new file or update content to an existing file. |
FetchAdditionalUserFields | Fetch all T1, T2, and T3 fields for a specified user. |
ForwardEvent | Forward events to recipients. |
ForwardMail | Retrieve Forwarded Mail. |
GetAdminConsentURL | 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. |
MoveMail | Move mail. |
SendMail | Send mail. |
Add or remove subscriptions for the user. You can also enable and disable specific plans associated with a subscription
Name | Type | Required | Description |
UserID | String | False | The Id of the User for which License needs to be assigned. Don't feed if you have to do for the User with which you are logged in. |
UserPrincipalName | String | False | The Principal Name of the User for which License needs to be assigned. Don't feed if you have to do for the User with which you are logged in. |
AddLicenseSkuId | String | False | The unique identifier for the SKU. |
DisabledPlans | String | False | A collection of the comma seperated unique identifiers for plans that have been disabled. |
RemoveLicenses | String | False | A collection of comma seperated GUIDs that identify the licenses to remove. |
Name | Type | Description |
Status | String | Stored Procedure Execution Status |
Cancels an event.
Name | Type | Required | Description |
EventId | String | True | Id of the event. |
UserId | String | False | Id of the user. |
UserPrincipalName | String | False | The Principal Name of the User for which License needs to be assigned. Don't feed if you have to do for the User with which you are logged in. |
Comment | String | False | A comment to include. Can be an empty string. |
Name | Type | Description |
Status | String | Stored Procedure Execution Status |
Upload a new file or update content to an existing file.
Name | Type | Required | Description |
FolderName | String | True | Name of the folder to be created. |
ParentId | String | False | Id of the folder where the current item is. |
Name | Type | Description |
Id | String | Id of the Foler created. |
Fetch all T1, T2, and T3 fields for a specified user.
Name | Type | Required | Description |
UserId | String | True | The unique identifier of the user. |
Name | Type | Description |
* | String | Results of the query: all the fields of the User object. |
Forward events to recipients.
Name | Type | Required | Description |
EventId | String | True | Id of the event. |
ToRecipients | String | True | A semicolon-separated list of recipient emails. |
UserId | String | False | Id of the user. |
UserPrincipalName | String | False | The Principal Name of the User for which License needs to be assigned. Don't feed if you have to do for the User with which you are logged in. |
Comment | String | False | A comment to include. Can be an empty string. |
Name | Type | Description |
Status | String | Stored Procedure Execution Status |
Retrieve Forwarded Mail.
Name | Type | Required | Description |
MessageId | String | True | Id of the email. |
ToRecipients | String | True | A semicolon-separated list of recipient emails. |
Comment | String | False | BodyContent on top of the original message. |
Name | Type | Description |
Id | String | Forwarded mail Id. |
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.
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 permissions to request from the Admin.
The default value is offline_access https://graph.microsoft.com/group.read.all https://graph.microsoft.com/group.readwrite.all https://graph.microsoft.com/user.read https://graph.microsoft.com/user.readwrite.all https://graph.microsoft.com/calendars.readwrite https://graph.microsoft.com/contacts.readwrite https://graph.microsoft.com/mail.readwrite https://graph.microsoft.com/Files.ReadWrite.All. |
Name | Type | Description |
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Move mail.
Name | Type | Required | Description |
MessageId | String | True | The email Id. |
DestinationId | String | True | Id of the destination folder where the email will be moved to. |
Name | Type | Description |
Id | String | Moved mail Id. |
Send mail.
Name | Type | Required | Description |
Id | String | False | The Id of the message to be sent (this is optional). The user can either use an existing email Id or send a new email by optionally filling the other fields. |
Subject | String | False | The email subject. |
Content | String | False | Email body content. |
Attachments | String | False | The attachments. Specify File attachments in the following format: filename1,filecontent1;filename2,filecontent2. Each filecontent can be either base64 data, or the path of a local file with the @ character before it |
FileName | String | False | Name of the email attachment. |
LocalFile | String | False | The file containing the content of the attachment |
ContentBytes | String | False | Content of the attachment encoded to base 64. |
ToRecipients | String | False | The recipients. Specify recipients in the following order: [email protected];[email protected]. |
CCRecipients | String | False | The CC recipients. Specify recipients in the following order: [email protected];[email protected]. |
SenderEmail | String | False | The email address on who's behalf email needs to be sent. Set this if you want to send email on behalf of other user's account. |
FromEmail | String | False | The email address of the User from which email needs to be sent. Set this if you want to send email from other user's account. |
ContentType | String | False | The content type of the email body.
The allowed values are text, html. The default value is text. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Microsoft Office 365:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
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
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 Events table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Events'
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
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 SendMail stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SendMail' AND Direction=1 OR Direction=2
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 Events table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Events'
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'
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
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'
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:office365: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 <> ''
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.
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.
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
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. |
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
Microsoft Office 365 (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.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Microsoft Office 365. |
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. |
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. |
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. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Property | Description |
DirectoryRetrievalDepth | Specify how many folders deep you want to get results for Files table. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Pagesize | The maximum number of results to return per page from Microsoft Office 365. |
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. |
UseClientSidePaging | Whether or not the CData ADO.NET Provider for Microsoft Office 365 should use client side paging. |
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 Office 365. |
The type of authentication to use when connecting to Microsoft Office 365.
string
"AzureAD"
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.
string
""
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.
string
"GLOBAL"
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.
string
""
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.
string
""
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.
string
"CODE"
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.
string
""
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.
string
"PEMKEY_BLOB"
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.
string
""
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.
string
"*"
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.
string
""
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.
string
"1"
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.
string
""
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 |
DirectoryRetrievalDepth | Specify how many folders deep you want to get results for Files table. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Pagesize | The maximum number of results to return per page from Microsoft Office 365. |
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. |
UseClientSidePaging | Whether or not the CData ADO.NET Provider for Microsoft Office 365 should use client side paging. |
Specify how many folders deep you want to get results for Files table. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in.
string
"5"
This property must be set in the connection string or the driver will use a default of DirectoryRetrievalDepth=5.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
The maximum number of results to return per page from Microsoft Office 365.
int
300
The Pagesize property affects the maximum number of results to return per page from Microsoft Office 365. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
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.
int
60
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.
Whether or not the CData ADO.NET Provider for Microsoft Office 365 should use client side paging.
bool
true
Some sources do not support server side paging. In these cases, set UseClientSidePaging to true. Otherwise, leave it as false. Setting UseClientSidePaging to true on a source that already supports paging can cause incomplete results.