Connectors Reference
Outlook.com connector allows you to manage your mail, calendars, and contacts. You can perform various actions such as send mail, schedule meetings, add contacts, etc.
|
Status: Production |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
Get calendar metadata |
|
|
Get folder metadata |
|
|
GetEventsCalendarView (string calendarId, string startDateTimeOffset, string endDateTimeOffset) |
Get calendar view of events |
|
When an event is added, updated or deleted in a calendar - Outlook subscription |
|
|
Delete event subscription |
|
|
RenewEventSubscription (string id, string options, ClientSubscription subscription) |
Update web hook |
|
When the file picker is opened for the first time |
|
|
When the file picker is open and being browsed |
|
|
Get emails |
|
|
Send an email |
|
|
Get emails (V2) |
|
|
Send an email (V2) |
|
|
GetEmail (string messageId, [Optional]boolean includeAttachments) |
Get email |
|
Delete email |
|
|
Move email |
|
|
Flag email |
|
|
Mark as read |
|
|
ReplyTo (string messageId, string comment, [Optional]boolean replyAll) |
Reply to email |
|
Reply to email (V2) |
|
|
ReplyToV3 (string messageId, ReplyHtmlMessage replyParameters) |
Reply to email (V3) |
|
Get attachment |
|
|
Create a webhook subscription for the trigger when a new email arrives |
|
|
When a new mentioning me email arrives - Outlook subscription |
|
|
Create an Outlook webhook subscription for the trigger when an email is flagged |
|
|
Delete mail subscription |
|
|
RenewOnNewEmailSubscription (string id, string options, ClientSubscription subscription) |
Update web hook |
|
|
|
|
SendMailWithOptions (OptionsEmailSubscription optionsEmailSubscription) |
Send email with options |
|
SendApprovalMail (ApprovalEmailSubscription approvalEmailSubscription) |
Send approval email |
|
Delete approval email subscription |
|
|
Delete options email subscription |
|
|
Tests the connection |
|
|
Get calendars |
|
|
Get events (V1) |
|
|
Create event (V1) |
|
|
Get event (V1) |
|
|
Delete event |
|
|
CalendarPatchItem (string table, string id, CalendarEventBackend item) |
Update event (V1) |
|
Get events (V3) |
|
|
V3CalendarPostItem (string table, CalendarEventHtmlClient item) |
Create event (V3) |
|
Get events (V2) |
|
|
Create event (V2) |
|
|
Get calendar view of events (V2) |
|
|
Get event (V2) |
|
|
V2CalendarPatchItem (string table, string id, CalendarEventClient item) |
Update event (V2) |
|
V3CalendarPatchItem (string table, string id, CalendarEventHtmlClient item) |
Update event (V3) |
|
Get contact folders |
|
|
Get contacts |
|
|
Create contact |
|
|
Get contact |
|
|
Delete contact |
|
|
Update contact |
|
|
Get datasets |
|
|
RespondToEvent (string event_id, string response, [Optional]ResponseToEventInvite body) |
Respond to an event invite |
|
Forward an email |
|
|
ReceiveResponseGet (string state, [Optional]string sig, [Optional]boolean showConfirm) |
Receives response from user |
|
ReceiveResponsePost (string state, [Optional]string sig, [Optional]boolean fromConfirm) |
Receives response from user |
|
Receive mail |
|
|
Receive mail (V2) |
|
|
Receive event |
|
|
Receive event (V2) |
|
Name |
Summary |
|
OnUpcomingEvents (string table, [advanced][Optional]integer lookAheadTimeInMinutes) |
When an upcoming event is starting soon |
|
OnUpcomingEventsV2 (string table, [advanced][Optional]integer lookAheadTimeInMinutes) |
When an upcoming event is starting soon (V2) |
|
When a new email arrives |
|
|
When a new email arrives (V2) |
|
|
When an email is flagged |
|
|
When an email is flagged (V2) |
|
|
When a new email mentioning me arrives |
|
|
When a new email mentioning me arrives (V2) |
|
|
When a new event is created (V1) |
|
|
When an event is modified (V1) |
|
|
When a new item is created in a table |
|
|
When an item is modified |
|
|
When a new event is created (V2) |
|
|
When an event is modified (V2) |
|
|
When an event is added, updated or deleted |
|
|
When an event is added, updated or deleted (V2) |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PaginatedListResponse[CalendarEventClientReceiveStringEnums] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get calendar metadata
Description: This operation gets metadata for a calendar.
Syntax:
Outlook.com.CalendarGetTable (string table)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Select a calendar. |
True |
Returns:
Type:TableMetadata
Description: Table metadata
Summary: Get folder metadata
Description: This operation gets metadata for a contacts folder.
Syntax:
Outlook.com.ContactGetTable (string table)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Select a contacts folder. |
True |
Returns:
Type:TableMetadata
Description: Table metadata
Summary: Get calendar view of events
Description: Get calendar view of events.
Syntax:
Outlook.com.GetEventsCalendarView (string calendarId, string startDateTimeOffset, string endDateTimeOffset)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
calendarId |
string (Calendar Id) |
Select a calendar. |
True |
|
|
startDateTimeOffset |
string (Start Time) |
Start time (example: '2017-01-01T08:00:00-07:00'). |
True |
|
|
endDateTimeOffset |
string (End Time) |
End time (example: '2017-02-01T08:00:00-07:00'). |
True |
Returns:
Type:PaginatedListResponse[CalendarEventClientReceiveStringEnums]
Description: Response containing a list and next link
Summary: When an event is added, updated or deleted in a calendar - Outlook subscription
Description: Create an Outlook webhook subscription for the trigger when an event is added, updated or deleted in a calendar.
Syntax:
Outlook.com.CreateOnChangedEventPokeSubscription (ClientSubscription subscription, string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscription |
|
Describes the subscription information. |
True |
|
|
table |
string (Calendar id) |
Select a calendar. |
True |
|
|
incomingDays |
integer(int32) (Incoming Days Tracked) |
Number of incoming days in calendar to be tracked. |
False |
|
|
pastDays |
integer(int32) (Past Days Tracked) |
Number of past days in calendar to be tracked. |
False |
Returns:
Type:SubscriptionResponse
Description: Base response model that connector returns to LA engine
Summary: Delete event subscription
Description: This operation deletes an event subscription.
Syntax:
Outlook.com.DeleteEventSubscription (string id, string options)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Id of subscription to be deleted) |
Id of subscription to be deleted. |
True |
|
|
options |
string (Subscription options) |
Subscription options. |
True |
Returns:
Summary: Update web hook
Description: Update web hook with renew interval.
Syntax:
Outlook.com.RenewEventSubscription (string id, string options, ClientSubscription subscription)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Id of subscription to be renewed) |
Id of subscription to be renewed. |
True |
|
|
options |
string (Subscription options) |
Subscription options. |
True |
|
|
subscription |
|
Describes the subscription information. |
True |
Returns:
Summary: When the file picker is opened for the first time
Description: When the file picker is opened for the first time.
Syntax:
Outlook.com.OnFilePickerOpen (string operation, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
operation |
string (Name of the operation) |
Name of the operation. |
True |
|
|
top |
integer(int32) (Limit on the number of results to return) |
Limit on the number of results to return. |
False |
|
|
skip |
integer(int32) (Number of results to skip) |
Number of results to skip. |
False |
|
|
mailboxAddress |
string (Mailbox to perform operations for) |
Mailbox to perform operations for. |
False |
Returns:
Type:EntityListResponse[FilePickerFile]
Description: Entity list response
Summary: When the file picker is open and being browsed
Description: When the file picker is open and being browsed.
Syntax:
Outlook.com.OnFilePickerBrowse (string operation, string id, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
operation |
string (Name of the operation) |
Name of the operation. |
True |
|
|
id |
string (Id of the previously selected item) |
Id of the previously selected item. |
True |
|
|
top |
integer(int32) (Limit on the number of results to return) |
Limit on the number of results to return. |
False |
|
|
skip |
integer(int32) (Number of results to skip) |
Number of results to skip. |
False |
|
|
mailboxAddress |
string (Mailbox to perform operations for) |
Mailbox to perform operations for. |
False |
Returns:
Type:EntityListResponse[FilePickerFile]
Description: Entity list response
Summary: Get emails
Description: This operation gets emails from a folder.
Syntax:
Outlook.com.GetEmails ([Optional]string folderPath, [Optional]boolean fetchOnlyUnread, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top, [internal][Optional]integer skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder) |
Mail folder to retrieve emails from (default: 'Inbox'). |
False |
|
|
fetchOnlyUnread |
boolean (Fetch Only Unread Messages) |
Retrieve only unread emails?. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
If set to true, attachments will also be retrieved along with the email. |
False |
|
|
searchQuery |
string (Search Query) |
Search query (like in the Outlook client) to filter emails. |
False |
|
|
top |
integer(int32) (Top) |
Number of emails to retrieve (default: 10). |
False |
|
|
skip |
integer(int32) (Skip) |
Number of emails to skip (default: 0). |
False |
Returns:
Type:array of (ClientReceiveMessageStringEnums)
Summary: Send an email
Description: This operation sends an email message.
Syntax:
Outlook.com.SendEmail (ClientSendMessage emailMessage)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
emailMessage |
|
Send Email Message |
True |
Returns:
Summary: Get emails (V2)
Description: This operation gets emails from a folder.
Syntax:
Outlook.com.GetEmailsV2 ([Optional]string folderPath, [Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]string subjectFilter, [Optional]boolean fetchOnlyUnread, [internal][Optional]boolean fetchOnlyFlagged, [internal][Optional]string mailboxAddress, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder) |
Mail folder to retrieve emails from (default: 'Inbox'). |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
|
|
fetchOnlyUnread |
boolean (Fetch Only Unread Messages) |
Retrieve only unread emails?. |
False |
|
|
fetchOnlyFlagged |
boolean (Fetch Only Flagged Messages) |
Retrieve only flagged emails?. |
False |
|
|
mailboxAddress |
string (Original Mailbox Address) |
Address of the shared mailbox. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
If set to true, attachments will also be retrieved along with the email. |
False |
|
|
searchQuery |
string (Search Query) |
Search query to filter emails. How to use '$search' parameter please refer to: https://docs.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/complex-types-for-mail-contacts-calendar#search-requests. |
False |
|
|
top |
integer(int32) (Top) |
Number of emails to retrieve (default: 10). |
False |
Returns:
Type:BatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch response
Summary: Send an email (V2)
Description: This operation sends an email message.
Syntax:
Outlook.com.SendEmailV2 (ClientSendHtmlMessage emailMessage)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
emailMessage |
|
Send HTML Email Message |
True |
Returns:
Summary: Get email
Description: This operation gets an email by id.
Syntax:
Outlook.com.GetEmail (string messageId, [Optional]boolean includeAttachments)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email. |
True |
|
|
includeAttachments |
boolean (Include Attachments) |
If set to true, attachments will also be retrieved along with the email. |
False |
Returns:
Type:ClientReceiveMessage
Description: Receive Email Message
Summary: Delete email
Description: This operation deletes an email by id.
Syntax:
Outlook.com.DeleteEmail (string messageId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to delete. |
True |
Returns:
Summary: Move email
Description: This operation moves an email to the specified folder.
Syntax:
Outlook.com.Move (string messageId, string folderPath)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to be moved. |
True |
|
|
folderPath |
string (Folder) |
Mail folder to move the email to. |
True |
Returns:
Type:ClientReceiveMessageStringEnums
Description: Receive Email Message
Summary: Flag email
Description: This operation flags an email.
Syntax:
Outlook.com.Flag (string messageId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to be flagged. |
True |
Returns:
Summary: Mark as read
Description: This operation marks an email as having been read.
Syntax:
Outlook.com.MarkAsRead (string messageId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to be marked as read. |
True |
Returns:
Summary: Reply to email
Description: This operation replies to an email.
Syntax:
Outlook.com.ReplyTo (string messageId, string comment, [Optional]boolean replyAll)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to reply to. |
True |
|
|
comment |
string (Comment) |
Reply comment. |
True |
|
|
replyAll |
boolean (Reply All) |
Reply to all recipients. |
False |
Returns:
Summary: Reply to email (V2)
Description: This operation replies to an email.
Syntax:
Outlook.com.ReplyToV2 (string messageId, ReplyMessage replyParameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to reply to. |
True |
|
|
replyParameters |
|
Properties of an email reply message. |
True |
Returns:
Summary: Reply to email (V3)
Description: This operation replies to an email.
Syntax:
Outlook.com.ReplyToV3 (string messageId, ReplyHtmlMessage replyParameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email to reply to. |
True |
|
|
replyParameters |
|
Properties of an HTML email reply message. |
True |
Returns:
Summary: Get attachment
Description: This operation gets an email attachment by id.
Syntax:
Outlook.com.GetAttachment (string messageId, string attachmentId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message Id) |
Id of the email. |
True |
|
|
attachmentId |
string (Attachment Id) |
Id of the attachment to download. |
True |
Returns:
Type:string(binary)
Summary: Create a webhook subscription for the trigger when a new email arrives
Description: Create a webhook subscription for the trigger when a new email arrives.
Syntax:
Outlook.com.CreateOnNewEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscription |
|
Describes the subscription information. |
True |
|
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
Returns:
Type:SubscriptionResponse
Description: Base response model that connector returns to LA engine
Summary: When a new mentioning me email arrives - Outlook subscription
Description: Create an Outlook webhook subscription for the trigger when a new mentioning me email arrives.
Syntax:
Outlook.com.CreateOnNewMentionMeEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscription |
|
Describes the subscription information. |
True |
|
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
Returns:
Type:SubscriptionResponse
Description: Base response model that connector returns to LA engine
Summary: Create an Outlook webhook subscription for the trigger when an email is flagged
Description: Create an Outlook webhook subscription for the trigger when an email is flagged.
Syntax:
Outlook.com.CreateOnFlaggedEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscription |
|
Describes the subscription information. |
True |
|
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
Returns:
Type:SubscriptionResponse
Description: Base response model that connector returns to LA engine
Summary: Delete mail subscription
Description: This operation deletes a mail subscription.
Syntax:
Outlook.com.DeleteOnNewEmailSubscription (string id, string options)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Id of subscription to be deleted) |
Id of subscription to be deleted. |
True |
|
|
options |
string (Subscription options) |
Subscription options. |
True |
Returns:
Summary: Update web hook
Description: Update web hook with renew interval.
Syntax:
Outlook.com.RenewOnNewEmailSubscription (string id, string options, ClientSubscription subscription)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Id of subscription to be renewed) |
Id of subscription to be renewed. |
True |
|
|
options |
string (Subscription options) |
Subscription options. |
True |
|
|
subscription |
|
Describes the subscription information. |
True |
Returns:
Summary:
Description:
Syntax:
Outlook.com.GetDataSetsMetadata ()
Returns:
Type:DataSetsMetadata
Description: Dataset metadata
Summary: Send email with options
Description: This operation sends an email with multiple options and waits for the recipient to respond back with one of the options. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.
Syntax:
Outlook.com.SendMailWithOptions (OptionsEmailSubscription optionsEmailSubscription)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
optionsEmailSubscription |
|
Model for Options Email Subscription |
True |
Returns:
Type:SubscriptionResponse
Description: Base response model that connector returns to LA engine
Summary: Send approval email
Description: This operation sends an approval email and waits for a response from the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.
Syntax:
Outlook.com.SendApprovalMail (ApprovalEmailSubscription approvalEmailSubscription)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
approvalEmailSubscription |
|
Model for Approval Email Subscription |
True |
Returns:
Type:SubscriptionResponse
Description: Base response model that connector returns to LA engine
Summary: Delete approval email subscription
Description: This operation deletes a subscription of approval email.
Syntax:
Outlook.com.DeleteApprovalMailSubscription (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Id of subscription to be deleted) |
Id of subscription to be deleted. |
True |
Returns:
Summary: Delete options email subscription
Description: This operation deletes a subscription of options email.
Syntax:
Outlook.com.DeleteOptionsMailSubscription (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Id of subscription to be deleted) |
Id of subscription to be deleted. |
True |
Returns:
Summary: Tests the connection
Description: Tests the connection.
Syntax:
Outlook.com.TestConnection ()
Returns:
Summary: Get calendars
Description: This operation lists available calendars.
Syntax:
Outlook.com.CalendarGetTables ()
Returns:
Type:EntityListResponse[Table]
Description: Entity list response
Summary: Get events (V1)
Description: This operation gets events from a calendar. (V1)
Syntax:
Outlook.com.CalendarGetItems (string table, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:EntityListResponse[CalendarEventBackend]
Description: Entity list response
Summary: Create event (V1)
Description: This operation creates a new event in a calendar. (V1)
Syntax:
Outlook.com.CalendarPostItem (string table, CalendarEventBackend item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
item |
|
Connector specific calendar event model class for the backend |
True |
Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend
Summary: Get event (V1)
Description: This operation gets a specific event from a calendar. (V1)
Syntax:
Outlook.com.CalendarGetItem (string table, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
id |
string (Item id) |
Select an event |
True |
Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend
Summary: Delete event
Description: This operation deletes an event in a calendar.
Syntax:
Outlook.com.CalendarDeleteItem (string table, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
id |
string (Id) |
Select an event |
True |
Returns:
Summary: Update event (V1)
Description: This operation updates an event in a calendar. (V1)
Syntax:
Outlook.com.CalendarPatchItem (string table, string id, CalendarEventBackend item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
id |
string (Id) |
Select an event |
True |
|
|
item |
|
Connector specific calendar event model class for the backend |
True |
Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend
Summary: Get events (V3)
Description: This operation gets events from a calendar. (V3)
Syntax:
Outlook.com.V3CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items
Summary: Create event (V3)
Description: This operation creates a new event in a calendar.
Syntax:
Outlook.com.V3CalendarPostItem (string table, CalendarEventHtmlClient item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
item |
|
Connector specific calendar event model class for the html client |
True |
Returns:
Type:CalendarEventClientReceiveStringEnums
Description: Connector specific calendar event model class for the client
Summary: Get events (V2)
Description: This operation gets events from a calendar. (V2)
Syntax:
Outlook.com.V2CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:EntityListResponse[CalendarEventClientReceiveStringEnums]
Description: Entity list response
Summary: Create event (V2)
Description: This operation creates a new event in a calendar. (V2)
Syntax:
Outlook.com.V2CalendarPostItem (string table, CalendarEventClient item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
item |
|
Connector specific calendar event model class for the client |
True |
Returns:
Type:CalendarEventClientReceiveStringEnums
Description: Connector specific calendar event model class for the client
Summary: Get calendar view of events (V2)
Description: This operation gets all events (including instances of recurrences) in a calendar. (V2)
Syntax:
Outlook.com.GetEventsCalendarViewV2 (string calendarId, string startDateTimeOffset, string endDateTimeOffset, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string search)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
calendarId |
string (Calendar Id) |
Select a calendar |
True |
|
|
startDateTimeOffset |
string (Start Time) |
Start time (example: '2017-01-01T08:00:00-07:00') |
True |
|
|
endDateTimeOffset |
string (End Time) |
End time (example: '2017-02-01T08:00:00-07:00') |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
|
|
search |
string (Search) |
Search text for matching event body and subject |
False |
Returns:
Type:EntityListResponse[CalendarEventClientReceiveStringEnums]
Description: Entity list response
Summary: Get event (V2)
Description: This operation gets a specific event from a calendar. (V2)
Syntax:
Outlook.com.V2CalendarGetItem (string table, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
id |
string (Item id) |
Select an event |
True |
Returns:
Type:CalendarEventClientReceiveStringEnums
Description: Connector specific calendar event model class for the client
Summary: Update event (V2)
Description: This operation updates an event in a calendar. (V2)
Syntax:
Outlook.com.V2CalendarPatchItem (string table, string id, CalendarEventClient item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
id |
string (Id) |
Select an event |
True |
|
|
item |
|
Connector specific calendar event model class for the client |
True |
Returns:
Type:CalendarEventClientReceiveStringEnums
Description: Connector specific calendar event model class for the client
Summary: Update event (V3)
Description: This operation updates an event in a calendar.
Syntax:
Outlook.com.V3CalendarPatchItem (string table, string id, CalendarEventHtmlClient item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
id |
string (Id) |
Select an event |
True |
|
|
item |
|
Connector specific calendar event model class for the html client |
True |
Returns:
Type:CalendarEventClientReceiveStringEnums
Description: Connector specific calendar event model class for the client
Summary: Get contact folders
Description: This operation lists available contacts folders.
Syntax:
Outlook.com.ContactGetTables ()
Returns:
Type:EntityListResponse[Table]
Description: Entity list response
Summary: Get contacts
Description: This operation gets contacts from a contacts folder.
Syntax:
Outlook.com.ContactGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Unique identifier of the contacts folder to retrieve |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:EntityListResponse[ContactResponse]
Description: Entity list response
Summary: Create contact
Description: This operation creates a new contact in a contacts folder.
Syntax:
Outlook.com.ContactPostItem (string table, Contact item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Select a contacts folder |
True |
|
|
item |
|
Contact |
True |
Returns:
Type:ContactResponse
Description: Contact response
Summary: Get contact
Description: This operation gets a specific contact from a contacts folder.
Syntax:
Outlook.com.ContactGetItem (string table, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Select a contacts folder |
True |
|
|
id |
string (Item id) |
Unique identifier of a contact to retrieve |
True |
Returns:
Type:ContactResponse
Description: Contact response
Summary: Delete contact
Description: This operation deletes a contact from a contacts folder.
Syntax:
Outlook.com.ContactDeleteItem (string table, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Select a contacts folder |
True |
|
|
id |
string (Id) |
Unique identifier of contact to delete |
True |
Returns:
Summary: Update contact
Description: This operation updates a contact in a contacts folder.
Syntax:
Outlook.com.ContactPatchItem (string table, string id, Contact item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Folder id) |
Select a contacts folder |
True |
|
|
id |
string (Id) |
Unique identifier of contact to update |
True |
|
|
item |
|
Contact |
True |
Returns:
Type:ContactResponse
Description: Contact response
Summary: Get datasets
Description: This operation gets Contacts or Calendars
Syntax:
Outlook.com.GetDataSets ()
Returns:
Type:DataSetsList
Description: List of datasets
Summary: Respond to an event invite
Description: Respond to an event invite.
Syntax:
Outlook.com.RespondToEvent (string event_id, string response, [Optional]ResponseToEventInvite body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
event_id |
string (Event Id) |
Id of the event to respond to. |
True |
|
|
response |
string (Response)Values: [Accept, Tentatively Accept, Decline] |
Response for the event invite |
True |
|
|
body |
|
Response to an event invite |
False |
Returns:
Summary: Forward an email
Description: Forward an email.
Syntax:
Outlook.com.ForwardEmail (string message_id, DirectForwardMessage body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
message_id |
string (Message Id) |
Id of the message to forward. |
True |
|
|
body |
|
Directly forward message |
True |
Returns:
Summary: Receives response from user
Description: This operation gets a response from the user.
Syntax:
Outlook.com.ReceiveResponseGet (string state, [Optional]string sig, [Optional]boolean showConfirm)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (callback state) |
callback state. |
True |
|
|
sig |
string
|
|
False |
|
|
showConfirm |
boolean (showConfirm query parameter, if true, then confirmation page will be returned) |
showConfirm query parameter, if true, then confirmation page will be returned. |
False |
Returns:
Type:string
Summary: Receives response from user
Description: This operation gets a response from the user.
Syntax:
Outlook.com.ReceiveResponsePost (string state, [Optional]string sig, [Optional]boolean fromConfirm)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (callback state) |
callback state. |
True |
|
|
sig |
string
|
|
False |
|
|
fromConfirm |
boolean (fromConfirm query parameter, if true, then request is from confirmation page) |
fromConfirm query parameter, if true, then request is from confirmation page. |
False |
Returns:
Type:string
Summary: Receive mail
Description: This operation validates the subscription request.
Syntax:
Outlook.com.ReceiveMailFromSubscription (string state, SubscriptionPayload[OutlookReceiveMessage] subscriptionPayload, [Optional]string validationtoken)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (Callback state) |
Callback state. |
True |
|
|
subscriptionPayload |
SubscriptionPayload[OutlookReceiveMessage]
|
Payload from backend containing subscription metadata as well as data |
True |
|
|
validationtoken |
string (Validation token) |
Validation token. |
False |
Returns:
Summary: Receive mail (V2)
Description: This operation validates the subscription request.
Syntax:
Outlook.com.ReceiveMailFromSubscriptionV2 (string state, SubscriptionPayload[OutlookReceiveMessage] subscriptionPayload, [Optional]string validationtoken, string subscribedConnectionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (Callback state) |
Callback state. |
True |
|
|
subscriptionPayload |
SubscriptionPayload[OutlookReceiveMessage]
|
Payload from backend containing subscription metadata as well as data |
True |
|
|
validationtoken |
string (Validation token) |
Validation token. |
False |
|
|
subscribedConnectionId |
string
|
|
True |
Returns:
Summary: Receive event
Description: This operation validates the subscription request.
Syntax:
Outlook.com.ReceiveEventFromSubscription (string state, SubscriptionPayload[SubscriptionEvent] subscriptionPayload, [Optional]string validationtoken)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (Callback state) |
Callback state. |
True |
|
|
subscriptionPayload |
SubscriptionPayload[SubscriptionEvent]
|
Payload from backend containing subscription metadata as well as data |
True |
|
|
validationtoken |
string (Validation token) |
Validation token. |
False |
Returns:
Summary: Receive event (V2)
Description: This operation validates the subscription request.
Syntax:
Outlook.com.ReceiveEventFromSubscriptionV2 (string state, SubscriptionPayload[SubscriptionEvent] subscriptionPayload, [Optional]string validationtoken, string subscribedConnectionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (Callback state) |
Callback state. |
True |
|
|
subscriptionPayload |
SubscriptionPayload[SubscriptionEvent]
|
Payload from backend containing subscription metadata as well as data |
True |
|
|
validationtoken |
string (Validation token) |
Validation token. |
False |
|
|
subscribedConnectionId |
string
|
|
True |
Returns:
Summary: When an upcoming event is starting soon
Description: This operation triggers a flow when an upcoming calendar event is starting.
Syntax:
Outlook.com.OnUpcomingEvents (string table, [advanced][Optional]integer lookAheadTimeInMinutes)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar Id) |
Unique identifier of the calendar. |
True |
|
|
lookAheadTimeInMinutes |
integer(int32) (Look-Ahead Time) |
Time (in minutes) to look ahead for upcoming events. |
False |
Returns:
Type:CalendarEventList
Description: The list of calendar items
Summary: When an upcoming event is starting soon (V2)
Description: This operation triggers a flow when an upcoming calendar event is starting.
Syntax:
Outlook.com.OnUpcomingEventsV2 (string table, [advanced][Optional]integer lookAheadTimeInMinutes)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar Id) |
Unique identifier of the calendar. |
True |
|
|
lookAheadTimeInMinutes |
integer(int32) (Look-Ahead Time) |
Time (in minutes) to look ahead for upcoming events. |
False |
Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items
Summary: When a new email arrives
Description: This operation triggers a flow when a new email arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.
Syntax:
Outlook.com.OnNewEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
Should the response of the trigger include the attachments. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
|
|
x-ms-operation-context |
string (x-ms-operation-context) |
Special header to enable operation simulation. |
False |
Returns:
Type:TriggerBatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch trigger response
Summary: When a new email arrives (V2)
Description: This operation triggers a flow when a new email arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.
Syntax:
Outlook.com.OnNewEmailV2 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
Should the response of the trigger include the attachments. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
|
|
x-ms-operation-context |
string (x-ms-operation-context) |
Special header to enable operation simulation. |
False |
Returns:
Type:TriggerBatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch trigger response
Summary: When an email is flagged
Description: This operation triggers a flow when an email is flagged.
Syntax:
Outlook.com.OnFlaggedEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
Should the response of the trigger include the attachments. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
Returns:
Type:TriggerBatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch trigger response
Summary: When an email is flagged (V2)
Description: This operation triggers a flow when an email is flagged.
Syntax:
Outlook.com.OnFlaggedEmailV2 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
Should the response of the trigger include the attachments. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
Returns:
Type:TriggerBatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch trigger response
Summary: When a new email mentioning me arrives
Description: This operation triggers a flow when a new email mentioning me arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.
Syntax:
Outlook.com.OnNewMentionMeEmail ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageIdToFireOnFirstTriggerRun |
string (Message Id to Fire on First Trigger Run) |
Id of message to fire on first trigger run if supplied. |
False |
|
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
Should the response of the trigger include the attachments. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
Returns:
Type:TriggerBatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch trigger response
Summary: When a new email mentioning me arrives (V2)
Description: This operation triggers a flow when a new email mentioning me arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.
Syntax:
Outlook.com.OnNewMentionMeEmailV2 ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageIdToFireOnFirstTriggerRun |
string (Message Id to Fire on First Trigger Run) |
Id of message to fire on first trigger run if supplied. |
False |
|
|
folderPath |
string (Folder) |
Mail folder to check for new emails. |
False |
|
|
to |
string(email) (To) |
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
cc |
string(email) (CC) |
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
toOrCc |
string(email) (To or CC) |
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
from |
string(email) (From) |
Sender email addresses separated by semicolons (If any match, the trigger will run). |
False |
|
|
importance |
string (Importance)Values: [Any, Low, Normal, High] |
Importance of the email (Any, High, Normal, Low). |
False |
|
|
fetchOnlyWithAttachment |
boolean (Only with Attachments) |
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
False |
|
|
includeAttachments |
boolean (Include Attachments) |
Should the response of the trigger include the attachments. |
False |
|
|
subjectFilter |
string (Subject Filter) |
String to look for in the subject line. |
False |
Returns:
Type:TriggerBatchResponse[ClientReceiveMessage]
Description: Represents a wrapper object for batch trigger response
Summary: When a new event is created (V1)
Description: This operation triggers a flow when a new event is created in a calendar. (V1)
Syntax:
Outlook.com.CalendarGetOnNewItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventList
Description: The list of calendar items
Summary: When an event is modified (V1)
Description: This operation triggers a flow when an event is modified in a calendar. (V1)
Syntax:
Outlook.com.CalendarGetOnUpdatedItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventList
Description: The list of calendar items
Summary: When a new item is created in a table
Description: This operation triggers a flow when a new item is created in a table.
Syntax:
Outlook.com.ODataStyleGetOnNewItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dataset |
string (Dataset) |
dataset name |
True |
|
|
table |
string (Calendar id) |
table name |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventList
Description: The list of calendar items
Summary: When an item is modified
Description: This operation triggers a flow when an item is modified in a table.
Syntax:
Outlook.com.ODataStyleCalendarGetOnUpdatedItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dataset |
string (Dataset) |
dataset name |
True |
|
|
table |
string (Calendar id) |
table name |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventList
Description: The list of calendar items
Summary: When a new event is created (V2)
Description: This operation triggers a flow when a new event is created in a calendar. (V2)
Syntax:
Outlook.com.CalendarGetOnNewItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items
Summary: When an event is modified (V2)
Description: This operation triggers a flow when an event is modified in a calendar. (V2)
Syntax:
Outlook.com.CalendarGetOnUpdatedItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
$filter |
string (Filter Query) |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
False |
|
|
$orderby |
string (Order By) |
An ODATA orderBy query for specifying the order of entries. |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve (default = all). |
False |
|
|
$skip |
integer(int32) (Skip Count) |
The number of entries to skip (default = 0). |
False |
Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items
Summary: When an event is added, updated or deleted
Description: This operation triggers a flow when an event is added, updated or deleted in a calendar.
Syntax:
Outlook.com.CalendarGetOnChangedItems (string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
incomingDays |
integer(int32) (Incoming Days Tracked) |
Number of incoming days in calendar to be tracked |
False |
|
|
pastDays |
integer(int32) (Past Days Tracked) |
Number of past days in calendar to be tracked |
False |
Returns:
Type:CalendarEventListWithActionType
Description: The list of calendar items with action type
Summary: When an event is added, updated or deleted (V2)
Description: This operation triggers a flow when an event is added, updated or deleted in a calendar.
Syntax:
Outlook.com.CalendarGetOnChangedItemsV2 (string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
table |
string (Calendar id) |
Select a calendar |
True |
|
|
incomingDays |
integer(int32) (Incoming Days Tracked) |
Number of incoming days in calendar to be tracked |
False |
|
|
pastDays |
integer(int32) (Past Days Tracked) |
Number of past days in calendar to be tracked |
False |
Returns:
Type:CalendarEventListWithActionType
Description: The list of calendar items with action type
Summary:
Description: Model for Approval Email Subscription
Properties:
|
Name |
Type |
Summary |
|
NotificationUrl |
string
|
Gets or sets callback url to flow engine. It is expected as part of request |
|
Message |
|
Approval Email Message. This is the message expected as part of user input |
Summary:
Description: Approval Email Message. This is the message expected as part of user input
Properties:
|
Name |
Type |
Summary |
|
To |
string(email) To |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Subject |
string Subject |
Subject |
|
Options |
string User Options |
User Options |
|
HeaderText |
string Header Text |
Header text for email body |
|
SelectionText |
string Selection Text |
Header text for users options selection |
|
Body |
string Body |
Body |
|
Importance |
string Importance |
Importance Values: [Low, Normal, High] |
|
Attachments |
array of (ClientSendAttachment) Attachments |
Attachments |
|
UseOnlyHTMLMessage |
boolean Use only HTML message |
Use only HTML message |
|
HideHTMLMessage |
boolean Hide HTML message |
If set to Yes, then the email body is hidden and only message card is displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value. |
|
ShowHTMLConfirmationDialog |
boolean Show HTML confirmation dialog |
If set to Yes then a dialog wil be shown to confirm selected option of HTML message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
|
|
Type |
string
|
Values: [Required, Optional, Resource] |
|
EmailAddress |
|
|
Summary:
Description: Represents a wrapper object for batch response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ClientReceiveMessage)
|
A list of the response objects |
Summary:
Description: Blob dataset metadata
Properties:
|
Name |
Type |
Summary |
|
source |
string
|
Blob dataset source |
|
displayName |
string
|
Blob dataset display name |
|
urlEncoding |
string
|
Blob dataset url encoding |
Summary:
Description: Connector specific calendar event model class for the backend
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
The Event's unique identifier |
|
Attendees |
array of (Attendee) Attendees |
List of attendees for the event |
|
Body |
|
|
|
BodyPreview |
string Body preview |
The preview of the message associated with the event |
|
Categories |
array of (string) Categories |
The categories associated with the event |
|
ChangeKey |
string Change key |
This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. |
|
DateTimeCreated |
string(date-time) Created time |
The date and time that the event was created |
|
DateTimeLastModified |
string(date-time) Last modified time |
The date and time that the event was last modified |
|
End |
string(date-time) End time |
The end time of the event |
|
EndTimeZone |
string End time zone |
This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time'). |
|
HasAttachments |
boolean Has attachments? |
Set to true if the event has attachments |
|
ICalUId |
string Event Unique ID |
A unique identifier that is shared by all instances of an event across different calendars |
|
Importance |
string Importance |
The importance of the event: Low, Normal, or High Values: [Low, Normal, High] |
|
IsAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
IsCancelled |
boolean Is cancelled? |
Set to true if the event has been canceled |
|
IsOrganizer |
boolean Is Organizer |
Set to true if the message sender is also the organizer |
|
Location |
|
|
|
Organizer |
|
|
|
Recurrence |
|
|
|
Reminder |
integer(int32) Reminder |
Time in minutes before event start to remind |
|
ResponseRequested |
boolean Response requested |
Set to true if the sender would like a response when the event is accepted or declined |
|
ResponseStatus |
|
|
|
SeriesMasterId |
string Series master id |
Unique identifier for Series Master event type |
|
ShowAs |
string Show as |
Shows as free or busy Values: [Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown] |
|
Start |
string(date-time) Start time |
The start time of the event |
|
StartTimeZone |
string Start time zone |
This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time'). |
|
Subject |
string Subject |
Event subject |
|
Type |
string Type |
The event type: Single Instance, Occurrence, Exception, or Series Master Values: [SingleInstance, Occurrence, Exception, SeriesMaster] |
|
WebLink |
string(uri) Web link |
The preview of the message associated with the event |
|
Reason |
string Reason |
The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event. |
Summary:
Description: Connector specific calendar event model class for the client
Properties:
|
Name |
Type |
Summary |
|
Subject |
string Subject |
Event subject |
|
Start |
string(date-time) Start time |
Start time of the event (example: '2016-11-01T14:30:00Z') |
|
End |
string(date-time) End time |
End time of the event (example: '2016-11-01T15:30:00Z') |
|
TimeZone |
string Time zone |
Time zone of the event Values: [, (UTC-12:00) International Date Line West, (UTC-11:00) Coordinated Universal Time-11, (UTC-10:00) Aleutian Islands, (UTC-10:00) Hawaii, (UTC-09:30) Marquesas Islands, (UTC-09:00) Alaska, (UTC-09:00) Coordinated Universal Time-09, (UTC-08:00) Baja California, (UTC-08:00) Coordinated Universal Time-08, (UTC-08:00) Pacific Time (US & Canada), (UTC-07:00) Arizona, (UTC-07:00) Chihuahua, La Paz, Mazatlan, (UTC-07:00) Mountain Time (US & Canada), (UTC-06:00) Central America, (UTC-06:00) Central Time (US & Canada), (UTC-06:00) Easter Island, (UTC-06:00) Guadalajara, Mexico City, Monterrey, (UTC-06:00) Saskatchewan, (UTC-05:00) Bogota, Lima, Quito, Rio Branco, (UTC-05:00) Chetumal, (UTC-05:00) Eastern Time (US & Canada), (UTC-05:00) Haiti, (UTC-05:00) Havana, (UTC-05:00) Indiana (East), (UTC-04:00) Asuncion, (UTC-04:00) Atlantic Time (Canada), (UTC-04:00) Caracas, (UTC-04:00) Cuiaba, (UTC-04:00) Georgetown, La Paz, Manaus, San Juan, (UTC-04:00) Santiago, (UTC-04:00) Turks and Caicos, (UTC-03:30) Newfoundland, (UTC-03:00) Araguaina, (UTC-03:00) Brasilia, (UTC-03:00) Cayenne, Fortaleza, (UTC-03:00) City of Buenos Aires, (UTC-03:00) Greenland, (UTC-03:00) Montevideo, (UTC-03:00) Punta Arenas, (UTC-03:00) Saint Pierre and Miquelon, (UTC-03:00) Salvador, (UTC-02:00) Coordinated Universal Time-02, (UTC-02:00) Mid-Atlantic - Old, (UTC-01:00) Azores, (UTC-01:00) Cabo Verde Is., (UTC) Coordinated Universal Time, (UTC+00:00) Casablanca, (UTC+00:00) Dublin, Edinburgh, Lisbon, London, (UTC+00:00) Monrovia, Reykjavik, (UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, (UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague, (UTC+01:00) Brussels, Copenhagen, Madrid, Paris, (UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb, (UTC+01:00) West Central Africa, (UTC+01:00) Windhoek, (UTC+02:00) Amman, (UTC+02:00) Athens, Bucharest, (UTC+02:00) Beirut, (UTC+02:00) Cairo, (UTC+02:00) Chisinau, (UTC+02:00) Damascus, (UTC+02:00) Gaza, Hebron, (UTC+02:00) Harare, Pretoria, (UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, (UTC+02:00) Jerusalem, (UTC+02:00) Kaliningrad, (UTC+02:00) Tripoli, (UTC+03:00) Baghdad, (UTC+03:00) Istanbul, (UTC+03:00) Kuwait, Riyadh, (UTC+03:00) Minsk, (UTC+03:00) Moscow, St. Petersburg, (UTC+03:00) Nairobi, (UTC+03:30) Tehran, (UTC+04:00) Abu Dhabi, Muscat, (UTC+04:00) Astrakhan, Ulyanovsk, (UTC+04:00) Baku, (UTC+04:00) Izhevsk, Samara, (UTC+04:00) Port Louis, (UTC+04:00) Saratov, (UTC+04:00) Tbilisi, (UTC+04:00) Volgograd, (UTC+04:00) Yerevan, (UTC+04:30) Kabul, (UTC+05:00) Ashgabat, Tashkent, (UTC+05:00) Ekaterinburg, (UTC+05:00) Islamabad, Karachi, (UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi, (UTC+05:30) Sri Jayawardenepura, (UTC+05:45) Kathmandu, (UTC+06:00) Astana, (UTC+06:00) Dhaka, (UTC+06:00) Omsk, (UTC+06:30) Yangon (Rangoon), (UTC+07:00) Bangkok, Hanoi, Jakarta, (UTC+07:00) Barnaul, Gorno-Altaysk, (UTC+07:00) Hovd, (UTC+07:00) Krasnoyarsk, (UTC+07:00) Novosibirsk, (UTC+07:00) Tomsk, (UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi, (UTC+08:00) Irkutsk, (UTC+08:00) Kuala Lumpur, Singapore, (UTC+08:00) Perth, (UTC+08:00) Taipei, (UTC+08:00) Ulaanbaatar, (UTC+08:30) Pyongyang, (UTC+08:45) Eucla, (UTC+09:00) Chita, (UTC+09:00) Osaka, Sapporo, Tokyo, (UTC+09:00) Seoul, (UTC+09:00) Yakutsk, (UTC+09:30) Adelaide, (UTC+09:30) Darwin, (UTC+10:00) Brisbane, (UTC+10:00) Canberra, Melbourne, Sydney, (UTC+10:00) Guam, Port Moresby, (UTC+10:00) Hobart, (UTC+10:00) Vladivostok, (UTC+10:30) Lord Howe Island, (UTC+11:00) Bougainville Island, (UTC+11:00) Chokurdakh, (UTC+11:00) Magadan, (UTC+11:00) Norfolk Island, (UTC+11:00) Sakhalin, (UTC+11:00) Solomon Is., New Caledonia, (UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky, (UTC+12:00) Auckland, Wellington, (UTC+12:00) Coordinated Universal Time+12, (UTC+12:00) Fiji, (UTC+12:00) Petropavlovsk-Kamchatsky - Old, (UTC+12:45) Chatham Islands, (UTC+13:00) Coordinated Universal Time+13, (UTC+13:00) Nuku'alofa, (UTC+13:00) Samoa, (UTC+14:00) Kiritimati Island] |
|
RequiredAttendees |
string(email) Required attendees |
Required attendees for the event separated by semicolons |
|
OptionalAttendees |
string(email) Optional attendees |
Optional attendees for the event separated by semicolons |
|
ResourceAttendees |
string Resource attendees |
Resource attendees for the event separated by semicolons |
|
Body |
string Body |
Body of the message associated with the event |
|
IsHtml |
boolean Is HTML |
Set to true if the body is Html |
|
Location |
string Location |
Location of the event |
|
Importance |
string Importance |
The importance of the event: Low, Normal, or High Values: [Low, Normal, High] |
|
IsAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
Recurrence |
string Recurrence |
The recurrence pattern for the event Values: [None, Daily, Weekly, Monthly, Yearly] |
|
RecurrenceEnd |
string(date-time) Recurrence end time |
End time of the recurrence |
|
NumberOfOccurrences |
integer(int32) Number of occurrences |
How many times to repeat the event |
|
Reminder |
integer(int32) Reminder |
Time in minutes before event start to remind |
|
ShowAs |
string Show as |
Status to show during the event Values: [Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown] |
|
ResponseRequested |
boolean Response requested |
Set to true if the sender would like a response when the event is accepted or declined |
Summary:
Description: Connector specific calendar event model class for the client
Properties:
|
Name |
Type |
Summary |
|
Subject |
string Subject |
Event subject |
|
Start |
string(date-time) Start time |
Start time of the event (example: '2016-11-01T14:30:00Z') |
|
End |
string(date-time) End time |
End time of the event (example: '2016-11-01T15:30:00Z') |
|
ShowAs |
integer(int32) Show as |
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4) |
|
Recurrence |
integer(int32) Recurrence |
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4) |
|
ResponseType |
integer(int32) Response type |
The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5) |
|
ResponseTime |
string(date-time) Response time |
The response time of the event |
|
ICalUId |
string Event Unique ID |
A unique identifier that is shared by all instances of an event across different calendars |
|
Importance |
integer(int32) Importance |
The importance of the event (0 - Low, 1 - Normal, 2 - High) |
|
Id |
string Id |
The event's unique identifier |
|
DateTimeCreated |
string(date-time) Created time |
The date and time that the event was created |
|
DateTimeLastModified |
string(date-time) Last modified time |
The date and time that the event was last modified |
|
Organizer |
string(email) Organizer |
The organizer of the event |
|
TimeZone |
string Time zone |
Time zone of the event |
|
SeriesMasterId |
string Series master id |
Unique identifier for Series Master event type |
|
Categories |
array of (string) Categories |
The categories associated with the event |
|
WebLink |
string(uri) Web link |
The URL to open the event in Outlook Web App |
|
RequiredAttendees |
string(email) Required attendees |
Required attendees for the event separated by semicolons |
|
OptionalAttendees |
string(email) Optional attendees |
Optional attendees for the event separated by semicolons |
|
ResourceAttendees |
string Resource attendees |
Resource attendees for the event separated by semicolons |
|
Body |
string Body |
Body of the message associated with the event |
|
IsHtml |
boolean Is HTML |
Set to true if the body is Html |
|
Location |
string Location |
Location of the event |
|
IsAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
RecurrenceEnd |
string(date-time) Recurrence end time |
End time of the recurrence |
|
NumberOfOccurrences |
integer(int32) Number of occurrences |
How many times to repeat the event |
|
Reminder |
integer(int32) Reminder |
Time in minutes before event start to remind |
|
ResponseRequested |
boolean Response requested |
Set to true if the sender would like a response when the event is accepted or declined |
Summary:
Description: Connector specific calendar event model class for the client
Properties:
|
Name |
Type |
Summary |
|
Importance |
string Importance |
The importance of the event: Low, Normal, or High Values: [Low, Normal, High] |
|
ResponseType |
string Response type |
The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded Values: [None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded] |
|
Recurrence |
string Recurrence |
The recurrence pattern for the event Values: [None, Daily, Weekly, Monthly, Yearly] |
|
ShowAs |
string Show as |
Status to show during the event Values: [Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown] |
|
Subject |
string Subject |
Event subject |
|
Start |
string(date-time) Start time |
Start time of the event (example: '2016-11-01T14:30:00Z') |
|
End |
string(date-time) End time |
End time of the event (example: '2016-11-01T15:30:00Z') |
|
ResponseTime |
string(date-time) Response time |
The response time of the event |
|
ICalUId |
string Event Unique ID |
A unique identifier that is shared by all instances of an event across different calendars |
|
Id |
string Id |
The event's unique identifier |
|
DateTimeCreated |
string(date-time) Created time |
The date and time that the event was created |
|
DateTimeLastModified |
string(date-time) Last modified time |
The date and time that the event was last modified |
|
Organizer |
string(email) Organizer |
The organizer of the event |
|
TimeZone |
string Time zone |
Time zone of the event |
|
SeriesMasterId |
string Series master id |
Unique identifier for Series Master event type |
|
Categories |
array of (string) Categories |
The categories associated with the event |
|
WebLink |
string(uri) Web link |
The URL to open the event in Outlook Web App |
|
RequiredAttendees |
string(email) Required attendees |
Required attendees for the event separated by semicolons |
|
OptionalAttendees |
string(email) Optional attendees |
Optional attendees for the event separated by semicolons |
|
ResourceAttendees |
string Resource attendees |
Resource attendees for the event separated by semicolons |
|
Body |
string Body |
Body of the message associated with the event |
|
IsHtml |
boolean Is HTML |
Set to true if the body is Html |
|
Location |
string Location |
Location of the event |
|
IsAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
RecurrenceEnd |
string(date-time) Recurrence end time |
End time of the recurrence |
|
NumberOfOccurrences |
integer(int32) Number of occurrences |
How many times to repeat the event |
|
Reminder |
integer(int32) Reminder |
Time in minutes before event start to remind |
|
ResponseRequested |
boolean Response requested |
Set to true if the sender would like a response when the event is accepted or declined |
Summary:
Description: Calendar event model with action type
Properties:
|
Name |
Type |
Summary |
|
ActionType |
string Action Type |
Changed action type of the event - added, updated or deleted. Values: [added, updated, deleted] |
|
IsAdded |
boolean Is Added |
Flag that indicates whether the event was added since the last poll of the trigger. |
|
IsUpdated |
boolean Is Updated |
Flag that indicates whether the event was updated since the last poll of the trigger. |
|
Subject |
string Subject |
Event subject |
|
Start |
string(date-time) Start time |
Start time of the event (example: '2016-11-01T14:30:00Z') |
|
End |
string(date-time) End time |
End time of the event (example: '2016-11-01T15:30:00Z') |
|
ShowAs |
integer(int32) Show as |
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4) |
|
Recurrence |
integer(int32) Recurrence |
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4) |
|
ResponseType |
integer(int32) Response type |
The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5) |
|
ResponseTime |
string(date-time) Response time |
The response time of the event |
|
ICalUId |
string Event Unique ID |
A unique identifier that is shared by all instances of an event across different calendars |
|
Importance |
integer(int32) Importance |
The importance of the event (0 - Low, 1 - Normal, 2 - High) |
|
Id |
string Id |
The event's unique identifier |
|
DateTimeCreated |
string(date-time) Created time |
The date and time that the event was created |
|
DateTimeLastModified |
string(date-time) Last modified time |
The date and time that the event was last modified |
|
Organizer |
string(email) Organizer |
The organizer of the event |
|
TimeZone |
string Time zone |
Time zone of the event |
|
SeriesMasterId |
string Series master id |
Unique identifier for Series Master event type |
|
Categories |
array of (string) Categories |
The categories associated with the event |
|
WebLink |
string(uri) Web link |
The URL to open the event in Outlook Web App |
|
RequiredAttendees |
string(email) Required attendees |
Required attendees for the event separated by semicolons |
|
OptionalAttendees |
string(email) Optional attendees |
Optional attendees for the event separated by semicolons |
|
ResourceAttendees |
string Resource attendees |
Resource attendees for the event separated by semicolons |
|
Body |
string Body |
Body of the message associated with the event |
|
IsHtml |
boolean Is HTML |
Set to true if the body is Html |
|
Location |
string Location |
Location of the event |
|
IsAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
RecurrenceEnd |
string(date-time) Recurrence end time |
End time of the recurrence |
|
NumberOfOccurrences |
integer(int32) Number of occurrences |
How many times to repeat the event |
|
Reminder |
integer(int32) Reminder |
Time in minutes before event start to remind |
|
ResponseRequested |
boolean Response requested |
Set to true if the sender would like a response when the event is accepted or declined |
Summary:
Description: Connector specific calendar event model class for the html client
Properties:
|
Name |
Type |
Summary |
|
Subject |
string Subject |
Event subject |
|
Start |
string(date-time) Start time |
Start time of the event (example: '2016-11-01T14:30:00Z') |
|
End |
string(date-time) End time |
End time of the event (example: '2016-11-01T15:30:00Z') |
|
TimeZone |
string Time zone |
Time zone of the event Values: [, (UTC-12:00) International Date Line West, (UTC-11:00) Coordinated Universal Time-11, (UTC-10:00) Aleutian Islands, (UTC-10:00) Hawaii, (UTC-09:30) Marquesas Islands, (UTC-09:00) Alaska, (UTC-09:00) Coordinated Universal Time-09, (UTC-08:00) Baja California, (UTC-08:00) Coordinated Universal Time-08, (UTC-08:00) Pacific Time (US & Canada), (UTC-07:00) Arizona, (UTC-07:00) Chihuahua, La Paz, Mazatlan, (UTC-07:00) Mountain Time (US & Canada), (UTC-06:00) Central America, (UTC-06:00) Central Time (US & Canada), (UTC-06:00) Easter Island, (UTC-06:00) Guadalajara, Mexico City, Monterrey, (UTC-06:00) Saskatchewan, (UTC-05:00) Bogota, Lima, Quito, Rio Branco, (UTC-05:00) Chetumal, (UTC-05:00) Eastern Time (US & Canada), (UTC-05:00) Haiti, (UTC-05:00) Havana, (UTC-05:00) Indiana (East), (UTC-04:00) Asuncion, (UTC-04:00) Atlantic Time (Canada), (UTC-04:00) Caracas, (UTC-04:00) Cuiaba, (UTC-04:00) Georgetown, La Paz, Manaus, San Juan, (UTC-04:00) Santiago, (UTC-04:00) Turks and Caicos, (UTC-03:30) Newfoundland, (UTC-03:00) Araguaina, (UTC-03:00) Brasilia, (UTC-03:00) Cayenne, Fortaleza, (UTC-03:00) City of Buenos Aires, (UTC-03:00) Greenland, (UTC-03:00) Montevideo, (UTC-03:00) Punta Arenas, (UTC-03:00) Saint Pierre and Miquelon, (UTC-03:00) Salvador, (UTC-02:00) Coordinated Universal Time-02, (UTC-02:00) Mid-Atlantic - Old, (UTC-01:00) Azores, (UTC-01:00) Cabo Verde Is., (UTC) Coordinated Universal Time, (UTC+00:00) Casablanca, (UTC+00:00) Dublin, Edinburgh, Lisbon, London, (UTC+00:00) Monrovia, Reykjavik, (UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, (UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague, (UTC+01:00) Brussels, Copenhagen, Madrid, Paris, (UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb, (UTC+01:00) West Central Africa, (UTC+01:00) Windhoek, (UTC+02:00) Amman, (UTC+02:00) Athens, Bucharest, (UTC+02:00) Beirut, (UTC+02:00) Cairo, (UTC+02:00) Chisinau, (UTC+02:00) Damascus, (UTC+02:00) Gaza, Hebron, (UTC+02:00) Harare, Pretoria, (UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, (UTC+02:00) Jerusalem, (UTC+02:00) Kaliningrad, (UTC+02:00) Tripoli, (UTC+03:00) Baghdad, (UTC+03:00) Istanbul, (UTC+03:00) Kuwait, Riyadh, (UTC+03:00) Minsk, (UTC+03:00) Moscow, St. Petersburg, (UTC+03:00) Nairobi, (UTC+03:30) Tehran, (UTC+04:00) Abu Dhabi, Muscat, (UTC+04:00) Astrakhan, Ulyanovsk, (UTC+04:00) Baku, (UTC+04:00) Izhevsk, Samara, (UTC+04:00) Port Louis, (UTC+04:00) Saratov, (UTC+04:00) Tbilisi, (UTC+04:00) Volgograd, (UTC+04:00) Yerevan, (UTC+04:30) Kabul, (UTC+05:00) Ashgabat, Tashkent, (UTC+05:00) Ekaterinburg, (UTC+05:00) Islamabad, Karachi, (UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi, (UTC+05:30) Sri Jayawardenepura, (UTC+05:45) Kathmandu, (UTC+06:00) Astana, (UTC+06:00) Dhaka, (UTC+06:00) Omsk, (UTC+06:30) Yangon (Rangoon), (UTC+07:00) Bangkok, Hanoi, Jakarta, (UTC+07:00) Barnaul, Gorno-Altaysk, (UTC+07:00) Hovd, (UTC+07:00) Krasnoyarsk, (UTC+07:00) Novosibirsk, (UTC+07:00) Tomsk, (UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi, (UTC+08:00) Irkutsk, (UTC+08:00) Kuala Lumpur, Singapore, (UTC+08:00) Perth, (UTC+08:00) Taipei, (UTC+08:00) Ulaanbaatar, (UTC+08:30) Pyongyang, (UTC+08:45) Eucla, (UTC+09:00) Chita, (UTC+09:00) Osaka, Sapporo, Tokyo, (UTC+09:00) Seoul, (UTC+09:00) Yakutsk, (UTC+09:30) Adelaide, (UTC+09:30) Darwin, (UTC+10:00) Brisbane, (UTC+10:00) Canberra, Melbourne, Sydney, (UTC+10:00) Guam, Port Moresby, (UTC+10:00) Hobart, (UTC+10:00) Vladivostok, (UTC+10:30) Lord Howe Island, (UTC+11:00) Bougainville Island, (UTC+11:00) Chokurdakh, (UTC+11:00) Magadan, (UTC+11:00) Norfolk Island, (UTC+11:00) Sakhalin, (UTC+11:00) Solomon Is., New Caledonia, (UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky, (UTC+12:00) Auckland, Wellington, (UTC+12:00) Coordinated Universal Time+12, (UTC+12:00) Fiji, (UTC+12:00) Petropavlovsk-Kamchatsky - Old, (UTC+12:45) Chatham Islands, (UTC+13:00) Coordinated Universal Time+13, (UTC+13:00) Nuku'alofa, (UTC+13:00) Samoa, (UTC+14:00) Kiritimati Island] |
|
RequiredAttendees |
string(email) Required attendees |
Required attendees for the event separated by semicolons |
|
OptionalAttendees |
string(email) Optional attendees |
Optional attendees for the event separated by semicolons |
|
ResourceAttendees |
string Resource attendees |
Resource attendees for the event separated by semicolons |
|
Body |
string(html) Body |
Body of the message associated with the event |
|
Location |
string Location |
Location of the event |
|
Importance |
string Importance |
The importance of the event: Low, Normal, or High Values: [Low, Normal, High] |
|
IsAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
Recurrence |
string Recurrence |
The recurrence pattern for the event Values: [None, Daily, Weekly, Monthly, Yearly] |
|
RecurrenceEnd |
string(date-time) Recurrence end time |
End time of the recurrence |
|
NumberOfOccurrences |
integer(int32) Number of occurrences |
How many times to repeat the event |
|
Reminder |
integer(int32) Reminder |
Time in minutes before event start to remind |
|
ShowAs |
string Show as |
Status to show during the event Values: [Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown] |
|
ResponseRequested |
boolean Response requested |
Set to true if the sender would like a response when the event is accepted or declined |
Summary:
Description: The list of calendar items
Properties:
|
Name |
Type |
Summary |
|
value |
array of (CalendarEventBackend)
|
List of calendar items |
Summary:
Description: The list of calendar items
Properties:
|
Name |
Type |
Summary |
|
value |
array of (CalendarEventClientReceive)
|
List of calendar items |
Summary:
Description: The list of calendar items with action type
Properties:
|
Name |
Type |
Summary |
|
value |
array of (CalendarEventClientWithActionType)
|
List of calendar items |
Summary:
Description: File Attachment
Properties:
|
Name |
Type |
Summary |
|
Id |
string Attachment Id |
Attachment Id |
|
Name |
string Name |
Attachment name |
|
ContentBytes |
string(byte) Content |
Attachment content |
|
ContentType |
string Content-Type |
Attachment content type |
|
Size |
integer(int64) Size |
The size in bytes of the attachment |
|
IsInline |
boolean Is Inline |
Set to true if this is an inline attachment |
|
LastModifiedDateTime |
string(date-time) Last Modified DateTime |
The date and time when the attachment was last modified |
|
ContentId |
string Content Id |
Content Id |
Summary:
Description: Receive Email Message
Properties:
|
Name |
Type |
Summary |
|
From |
string(email) From |
The mailbox owner and sender of the message |
|
To |
string(email) To |
The recipients for the message |
|
Cc |
string(email) CC |
The Cc recipients for the message |
|
Bcc |
string(email) BCC |
The Bcc recipients for the message |
|
ReplyTo |
string(email) Reply To |
The email addresses to use when replying |
|
Subject |
string Subject |
The subject of the message |
|
Body |
string Body |
The body of the message |
|
Importance |
integer(int32) Importance |
The importance of the message (0 - Low, 1 - Normal, 2 - High) |
|
BodyPreview |
string Body Preview |
The preview of the message |
|
HasAttachment |
boolean Has Attachment |
Indicates whether the message has attachments |
|
Id |
string Message Id |
The unique identifier of the message |
|
InternetMessageId |
string Internet Message Id |
The message ID in the format specified by RFC2822 |
|
ConversationId |
string Conversation Id |
The Id of the conversation the email belongs to |
|
DateTimeReceived |
string(date-time) Received Time |
The date and time the message was received |
|
IsRead |
boolean Is Read |
Indicates whether the message has been read |
|
Attachments |
array of (ClientReceiveFileAttachment) Attachments |
The file attachments for the message |
|
IsHtml |
boolean Is HTML |
Is Html? |
Summary:
Description: Receive Email Message
Properties:
|
Name |
Type |
Summary |
|
Importance |
string Importance |
The importance of the message Values: [Low, Normal, High] |
|
From |
string(email) From |
The mailbox owner and sender of the message |
|
To |
string(email) To |
The recipients for the message |
|
Cc |
string(email) CC |
The Cc recipients for the message |
|
Bcc |
string(email) BCC |
The Bcc recipients for the message |
|
ReplyTo |
string(email) Reply To |
The email addresses to use when replying |
|
Subject |
string Subject |
The subject of the message |
|
Body |
string Body |
The body of the message |
|
BodyPreview |
string Body Preview |
The preview of the message |
|
HasAttachment |
boolean Has Attachment |
Indicates whether the message has attachments |
|
Id |
string Message Id |
The unique identifier of the message |
|
InternetMessageId |
string Internet Message Id |
The message ID in the format specified by RFC2822 |
|
ConversationId |
string Conversation Id |
The Id of the conversation the email belongs to |
|
DateTimeReceived |
string(date-time) Received Time |
The date and time the message was received |
|
IsRead |
boolean Is Read |
Indicates whether the message has been read |
|
Attachments |
array of (ClientReceiveFileAttachment) Attachments |
The file attachments for the message |
|
IsHtml |
boolean Is HTML |
Is Html? |
Summary:
Description: Attachment
Properties:
|
Name |
Type |
Summary |
|
Name |
string Name |
Attachment name |
|
ContentBytes |
string(byte) Content |
Attachment content |
Summary:
Description: Send HTML Email Message
Properties:
|
Name |
Type |
Summary |
|
To |
string(email) To |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Subject |
string Subject |
Specify the subject of the mail |
|
Body |
string(html) Body |
Specify the body of the mail |
|
From |
string(email) From (Send as) |
Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list |
|
Cc |
string(email) CC |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Bcc |
string(email) BCC |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Attachments |
array of (ClientSendAttachment) Attachments |
Attachments |
|
ReplyTo |
string(email) Reply To |
The email addresses to use when replying |
|
Importance |
string Importance |
Importance Values: [Low, Normal, High] |
Summary:
Description: Send Email Message
Properties:
|
Name |
Type |
Summary |
|
Cc |
string(email) CC |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Bcc |
string(email) BCC |
Specify email addresses separated by semicolons like someone@contoso.com |
|
To |
string(email) To |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Subject |
string Subject |
Specify the subject of the mail |
|
Body |
string Body |
Specify the body of the mail |
|
Attachments |
array of (ClientSendAttachment) Attachments |
Attachments |
|
ReplyTo |
string(email) Reply To |
The email addresses to use when replying |
|
Importance |
string Importance |
Importance Values: [Low, Normal, High] |
|
IsHtml |
boolean Is HTML |
Is Html? |
Summary:
Description: Describes the subscription information.
Properties:
|
Name |
Type |
Summary |
|
NotificationUrl |
string
|
Callback url to the flow engine. Expected as part of the request and provided by Flow. |
Summary:
Description: Contact
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
The contact's unique identifier. |
|
ParentFolderId |
string Parent folder id |
The ID of the contact's parent folder |
|
Birthday |
string(date-time) Birthday |
The contact's birthday |
|
FileAs |
string File as |
The name the contact is filed under |
|
DisplayName |
string Display Name |
The contact's display name |
|
GivenName |
string Given name |
The contact's given name |
|
Initials |
string Initials |
The contact's initials |
|
MiddleName |
string Middle name |
The contact's middle name |
|
NickName |
string Nickname |
The contact's nickname |
|
Surname |
string Surname |
The contact's surname |
|
Title |
string Title |
The contact's title |
|
Generation |
string Generation |
The contact's generation |
|
EmailAddresses |
array of (EmailAddress) Email addresses |
The contact's email addresses |
|
ImAddresses |
array of (string) IM addresses |
The contact's instant messaging (IM) addresses |
|
JobTitle |
string JobTitle |
The contact's job title |
|
CompanyName |
string Company name |
The name of the contact's company |
|
Department |
string Department |
The contact's department |
|
OfficeLocation |
string Office location |
The location of the contact's office |
|
Profession |
string Profession |
The contact's profession |
|
BusinessHomePage |
string Business home page |
The business home page of the contact |
|
AssistantName |
string Assistant name |
The name of the contact's assistant |
|
Manager |
string Manager |
The name of the contact's manager |
|
HomePhones |
array of (string) Home phones |
The contact's home phone numbers |
|
BusinessPhones |
array of (string) Business phones |
The contact's business phone numbers |
|
MobilePhone1 |
string Mobile phone |
The contact's mobile phone number |
|
HomeAddress |
|
|
|
BusinessAddress |
|
|
|
OtherAddress |
|
|
|
YomiCompanyName |
string Yomi company name |
The phonetic Japanese company name of the contact |
|
YomiGivenName |
string Yomi given name |
The phonetic Japanese given name (first name) of the contact |
|
YomiSurname |
string Yomi surname |
The phonetic Japanese surname (last name) of the contact |
|
Categories |
array of (string) Categories |
The categories associated with the contact |
|
ChangeKey |
string Change key |
Identifies the version of the event object |
|
DateTimeCreated |
string(date-time) Created time |
The time the contact was created |
|
DateTimeLastModified |
string(date-time) Last modified time |
The time the contact was modified |
Summary:
Description: Contact response
Properties:
|
Name |
Type |
Summary |
|
GivenName |
string Given name |
The contact's given name |
|
HomePhones |
array of (string) Home phones |
The contact's home phone numbers |
|
Id |
string Id |
The contact's unique identifier. |
|
ParentFolderId |
string Parent folder id |
The ID of the contact's parent folder |
|
Birthday |
string(date-time) Birthday |
The contact's birthday |
|
FileAs |
string File as |
The name the contact is filed under |
|
DisplayName |
string Display Name |
The contact's display name |
|
Initials |
string Initials |
The contact's initials |
|
MiddleName |
string Middle name |
The contact's middle name |
|
NickName |
string Nickname |
The contact's nickname |
|
Surname |
string Surname |
The contact's surname |
|
Title |
string Title |
The contact's title |
|
Generation |
string Generation |
The contact's generation |
|
EmailAddresses |
array of (EmailAddress) Email addresses |
The contact's email addresses |
|
ImAddresses |
array of (string) IM addresses |
The contact's instant messaging (IM) addresses |
|
JobTitle |
string JobTitle |
The contact's job title |
|
CompanyName |
string Company name |
The name of the contact's company |
|
Department |
string Department |
The contact's department |
|
OfficeLocation |
string Office location |
The location of the contact's office |
|
Profession |
string Profession |
The contact's profession |
|
BusinessHomePage |
string Business home page |
The business home page of the contact |
|
AssistantName |
string Assistant name |
The name of the contact's assistant |
|
Manager |
string Manager |
The name of the contact's manager |
|
BusinessPhones |
array of (string) Business phones |
The contact's business phone numbers |
|
MobilePhone1 |
string Mobile phone |
The contact's mobile phone number |
|
HomeAddress |
|
|
|
BusinessAddress |
|
|
|
OtherAddress |
|
|
|
YomiCompanyName |
string Yomi company name |
The phonetic Japanese company name of the contact |
|
YomiGivenName |
string Yomi given name |
The phonetic Japanese given name (first name) of the contact |
|
YomiSurname |
string Yomi surname |
The phonetic Japanese surname (last name) of the contact |
|
Categories |
array of (string) Categories |
The categories associated with the contact |
|
ChangeKey |
string Change key |
Identifies the version of the event object |
|
DateTimeCreated |
string(date-time) Created time |
The time the contact was created |
|
DateTimeLastModified |
string(date-time) Last modified time |
The time the contact was modified |
Summary:
Description: Dataset
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Dataset name |
|
DisplayName |
string
|
Dataset display name |
|
query |
array of (PassThroughNativeQuery)
|
Pass-through Native Queries |
Summary:
Description: List of datasets
Properties:
|
Name |
Type |
Summary |
|
value |
array of (DataSet)
|
List of datasets |
Summary:
Description: Dataset metadata
Properties:
|
Name |
Type |
Summary |
|
tabular |
|
Tabular dataset metadata |
|
blob |
|
Blob dataset metadata |
Summary:
Description: Directly forward message
Properties:
|
Name |
Type |
Summary |
|
Comment |
string Comment |
Comment |
|
ToRecipients |
string To |
Semicolon separated list of recipients to forward the message to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
|
|
Address |
string(email)
|
|
Summary:
Description: Entity list response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (CalendarEventBackend)
|
List of values |
Summary:
Description: Entity list response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (CalendarEventClientReceiveStringEnums)
|
List of values |
Summary:
Description: Entity list response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ContactResponse)
|
List of values |
Summary:
Description: Entity list response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (FilePickerFile)
|
List of values |
Summary:
Description: Entity list response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Table)
|
List of values |
Summary:
Description: FilePickerFile
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Uniquely identifies the file |
|
DisplayName |
string
|
Display name for the file |
|
IsFolder |
boolean
|
Set to true if the file is a folder |
|
Path |
string
|
Path of the file |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Altitude |
number(double)
|
|
|
Latitude |
number(double)
|
|
|
Longitude |
number(double)
|
|
|
Accuracy |
number(double)
|
|
|
AltitudeAccuracy |
number(double)
|
|
Summary:
Description: Class representing a data structure for an Internet message header which is considered as SMTP header by Exchange
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Header name |
|
Value |
string
|
Header value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ContentType |
string
|
Values: [Text, HTML] |
|
Content |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DisplayName |
string
|
|
|
Address |
|
|
|
Coordinates |
|
|
Summary:
Description: User Options Email Message. This is the message expected as part of user input
Properties:
|
Name |
Type |
Summary |
|
To |
string(email) To |
Specify email addresses separated by semicolons like someone@contoso.com |
|
Subject |
string Subject |
Subject of the email |
|
Options |
string User Options |
List of comma separated options for the email response |
|
HeaderText |
string Header Text |
Header text for email body |
|
SelectionText |
string Selection Text |
Header text for users options selection |
|
Body |
string Body |
Body of the email |
|
Importance |
string Importance |
Importance Values: [Low, Normal, High] |
|
Attachments |
array of (ClientSendAttachment) Attachments |
Attachments |
|
UseOnlyHTMLMessage |
boolean Use only HTML message |
Use only HTML message |
|
HideHTMLMessage |
boolean Hide HTML message |
If set to Yes, then the email body is hidden and only message card is displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value. |
|
ShowHTMLConfirmationDialog |
boolean Show HTML confirmation dialog |
If set to Yes then a dialog wil be shown to confirm selected option of HTML message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Model for Options Email Subscription
Properties:
|
Name |
Type |
Summary |
|
NotificationUrl |
string
|
Gets or sets callback url to flow engine. It is expected as part of request |
|
Message |
|
User Options Email Message. This is the message expected as part of user input |
Summary:
Description: Attachment
Properties:
|
Name |
Type |
Summary |
|
@odata.type |
string
|
OData type |
|
Id |
string
|
Attachment Id |
|
Name |
string
|
Attachment name |
|
ContentBytes |
string
|
Attachment content |
|
ContentType |
string
|
Attachment content type |
|
Size |
integer(int64)
|
Attachment size in bytes |
|
Permission |
string
|
Permission associated with a reference attachment |
|
ProviderType |
string
|
Provider for the reference attachment |
|
SourceUrl |
string
|
Reference attachment source url |
|
IsInline |
boolean
|
Set to true if this is an inline attachment |
|
LastModifiedDateTime |
string(date-time)
|
The date and time when the attachment was last modified |
|
ContentId |
string
|
Content Id |
Summary:
Description: Received message from outlook rest api
Properties:
|
Name |
Type |
Summary |
|
InternetMessageId |
string
|
Internet Message Id |
|
BodyPreview |
string
|
Body preview |
|
Id |
string
|
Id |
|
ConversationId |
string
|
Conversation Id |
|
HasAttachments |
boolean
|
Has attachments |
|
IsRead |
boolean
|
Is read |
|
CreatedDateTime |
string(date-time)
|
Created date and time |
|
ReceivedDateTime |
string(date-time)
|
Received date and time |
|
LastModifiedDateTime |
string(date-time)
|
Last modified date and time |
|
Attachments |
array of (OutlookReceiveAttachment)
|
Attachments |
|
ToRecipients |
array of (Recipient)
|
To Recipient |
|
CcRecipients |
array of (Recipient)
|
Cc Recipients |
|
BccRecipients |
array of (Recipient)
|
Bcc Recipients |
|
ReplyTo |
array of (Recipient)
|
The email addresses to use when replying |
|
Subject |
string
|
Subject |
|
Body |
|
|
|
From |
|
|
|
Importance |
string
|
Importance Values: [Low, Normal, High] |
|
InternetMessageHeaders |
array of (InternetMessageHeader)
|
Internet message headers |
Summary:
Description: Response containing a list and next link
Properties:
|
Name |
Type |
Summary |
|
Values |
array of (CalendarEventClientReceiveStringEnums)
|
Values |
Summary:
Description: static schema for pass-through native query execution
Properties:
|
Name |
Type |
Summary |
|
Language |
string
|
Query language |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Pattern |
|
|
|
Range |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Street |
string
|
|
|
City |
string
|
|
|
State |
string
|
|
|
CountryOrRegion |
string
|
|
|
PostalCode |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
EmailAddress |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Type |
string
|
Values: [Daily, Weekly, AbsoluteMonthly, RelativeMonthly, AbsoluteYearly, RelativeYearly] |
|
Interval |
integer(int32)
|
|
|
Month |
integer(int32)
|
|
|
DayOfMonth |
integer(int32)
|
|
|
DaysOfWeek |
array of (string)
|
|
|
FirstDayOfWeek |
string
|
Values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday] |
|
Index |
string
|
Values: [First, Second, Third, Fourth, Last] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Type |
string
|
Values: [EndDate, NoEnd, Numbered] |
|
StartDate |
string(date-time)
|
|
|
EndDate |
string(date-time)
|
|
|
NumberOfOccurrences |
integer(int32)
|
|
Summary:
Description: Properties of an HTML email reply message.
Properties:
|
Name |
Type |
Summary |
|
To |
string(email) To |
Example: recipient1@domain.com; recipient2@domain.com |
|
Cc |
string(email) CC |
Example: recipient1@domain.com; recipient2@domain.com |
|
Bcc |
string(email) BCC |
Example: recipient1@domain.com; recipient2@domain.com |
|
Subject |
string Subject |
Email subject (if empty, the original subject used). |
|
Body |
string(html) Body |
Content of the email. |
|
ReplyAll |
boolean Reply All |
True to reply to all recipients. (default: False) |
|
Importance |
string Importance |
Pick an importance. (default: Low) Values: [Low, Normal, High] |
|
Attachments |
array of (ClientSendAttachment) Attachments |
Details of attachments to be sent along with the reply. |
Summary:
Description: Properties of an email reply message.
Properties:
|
Name |
Type |
Summary |
|
To |
string(email) To |
Example: recipient1@domain.com; recipient2@domain.com |
|
Cc |
string(email) CC |
Example: recipient1@domain.com; recipient2@domain.com |
|
Bcc |
string(email) BCC |
Example: recipient1@domain.com; recipient2@domain.com |
|
Subject |
string Subject |
Email subject (if empty, the original subject used). |
|
Body |
string Body |
Content of the email. |
|
ReplyAll |
boolean Reply All |
True to reply to all recipients. (default: False) |
|
IsHtml |
boolean Is HTML |
True to send the reply as HTML. (default: True) |
|
Importance |
string Importance |
Pick an importance. (default: Low) Values: [Low, Normal, High] |
|
Attachments |
array of (ClientSendAttachment) Attachments |
Details of attachments to be sent along with the reply. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Response |
string
|
Values: [None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded] |
|
Time |
string(date-time)
|
|
Summary:
Description: Response to an event invite
Properties:
|
Name |
Type |
Summary |
|
Comment |
string Comment |
Comment |
|
SendResponse |
boolean Send response? |
Send response to organizer? |
Summary:
Description: Subscription event
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
The Event's unique identifier |
Summary:
Description: Subscription payload entity
Properties:
|
Name |
Type |
Summary |
|
SequenceNumber |
integer(int32)
|
Sequence number |
|
ChangeType |
string
|
Change type |
|
ClientState |
string
|
Client state |
|
Resource |
string
|
Resource |
|
ResourceData |
|
Received message from outlook rest api |
Summary:
Description: Subscription payload entity
Properties:
|
Name |
Type |
Summary |
|
SequenceNumber |
integer(int32)
|
Sequence number |
|
ChangeType |
string
|
Change type |
|
ClientState |
string
|
Client state |
|
Resource |
string
|
Resource |
|
ResourceData |
|
Subscription event |
Summary:
Description: Payload from backend containing subscription metadata as well as data
Properties:
|
Name |
Type |
Summary |
|
value |
array of (SubscriptionPayloadEntity[OutlookReceiveMessage])
|
List of values |
Summary:
Description: Payload from backend containing subscription metadata as well as data
Properties:
|
Name |
Type |
Summary |
|
value |
array of (SubscriptionPayloadEntity[SubscriptionEvent])
|
List of values |
Summary:
Description: Base response model that connector returns to LA engine
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id of the subscription |
|
resource |
string
|
Resource of the subscription request |
|
notificationType |
string
|
Notification Type |
|
notificationUrl |
string
|
Notification Url |
Summary:
Description: Represents a table.
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
The name of the table. The name is used at runtime. |
|
DisplayName |
string
|
The display name of the table. |
|
DynamicProperties |
|
Additional table properties provided by the connector to the clients. |
Summary:
Description: Additional table properties provided by the connector to the clients.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Metadata for a table (capabilities)
Properties:
|
Name |
Type |
Summary |
|
sortRestrictions |
|
Metadata for a table (sort restrictions) |
|
filterRestrictions |
TableFilterRestrictionsMetadata
|
Metadata for a table (filter restrictions) |
|
selectRestrictions |
TableSelectRestrictionsMetadata
|
Metadata for a table (select restrictions) |
|
isOnlyServerPagable |
boolean
|
Server paging restrictions |
|
filterFunctionSupport |
array of (string)
|
List of supported filter capabilities |
|
serverPagingOptions |
array of (string)
|
List of supported server-driven paging capabilities |
Summary:
Description: Metadata for a table (filter restrictions)
Properties:
|
Name |
Type |
Summary |
|
filterable |
boolean
|
Indicates whether this table has filterable columns |
|
nonFilterableProperties |
array of (string)
|
List of non filterable properties |
|
requiredProperties |
array of (string)
|
List of required properties |
Summary:
Description: Table metadata
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Table name |
|
title |
string
|
Table title |
|
x-ms-permission |
string
|
Table permission |
|
x-ms-capabilities |
|
Metadata for a table (capabilities) |
|
schema |
|
|
|
referencedEntities |
|
|
|
webUrl |
string
|
Url link |
Summary:
Description: Metadata for a table (select restrictions)
Properties:
|
Name |
Type |
Summary |
|
selectable |
boolean
|
Indicates whether this table has selectable columns |
Summary:
Description: Metadata for a table (sort restrictions)
Properties:
|
Name |
Type |
Summary |
|
sortable |
boolean
|
Indicates whether this table has sortable columns |
|
unsortableProperties |
array of (string)
|
List of unsortable properties |
|
ascendingOnlyProperties |
array of (string)
|
List of properties which support ascending order only |
Summary:
Description: Tabular dataset metadata
Properties:
|
Name |
Type |
Summary |
|
source |
string
|
Dataset source |
|
displayName |
string
|
Dataset display name |
|
urlEncoding |
string
|
Dataset url encoding |
|
tableDisplayName |
string
|
Table display name |
|
tablePluralName |
string
|
Table plural display name |
Summary:
Description: Represents a wrapper object for batch trigger response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ClientReceiveMessage)
|
A list of the response objects |