Connectors Reference

Office 365 Outlook

Microsoft Office 365 is a cloud-based service that is designed to help meet your organization's needs for robust security, reliability, and user productivity.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

CalendarGetTable (string table)

Get calendar metadata

ContactGetTable (string table)

Get folder metadata

GetEventsCalendarView (string calendarId, string startDateTimeOffset, string endDateTimeOffset)

Get calendar view of events

OnFilePickerOpen (string operation, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)

When the file picker is opened for the first time

OnFilePickerBrowse (string operation, string id, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)

When the file picker is open and being browsed

GetEmails ([Optional]string folderPath, [Optional]boolean fetchOnlyUnread, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top, [internal][Optional]integer skip)

Get emails

SendEmail (ClientSendMessage emailMessage)

Send an email

GetEmail (string messageId, [Optional]boolean includeAttachments)

Get email

DeleteEmail (string messageId)

Delete email

Move (string messageId, string folderPath)

Move email

Flag (string messageId)

Flag email

MarkAsRead (string messageId)

Mark as read

ReplyTo (string messageId, string comment, [Optional]boolean replyAll)

Reply to email

GetAttachment (string messageId, string attachmentId)

Get attachment

SetAutomaticRepliesSetting (AutomaticRepliesSettingClient clientSetting)

Set up automatic replies

GetMailTips (string mailboxAddress)

Get mail tips for a mailbox

GetDataSetsMetadata ()

 

SendMailWithOptions (OptionsEmailSubscription optionsEmailSubscription)

Send email with options

SendApprovalMail (ApprovalEmailSubscription approvalEmailSubscription)

Send approval email

DeleteApprovalMailSubscription (string id)

Delete approval email subscription

DeleteOptionsMailSubscription (string id)

Delete options email subscription

SharedMailboxSendEmail (SharedMailboxClientSendMessage emailMessage)

Send an email from a shared mailbox

DeleteOnNewEmailSubscription (string id, string options)

Delete mail subscription

RenewOnNewEmailSubscription (string id, string options, ClientSubscription subscription)

Update web hook

TestConnection ()

Tests the connection

CalendarGetTables ()

Get calendars

CalendarGetItems (string table, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get events (V1)

CalendarPostItem (string table, CalendarEventBackend item)

Create event (V1)

CalendarGetItem (string table, string id)

Get event (V1)

CalendarDeleteItem (string table, string id)

Delete event

CalendarPatchItem (string table, string id, CalendarEventBackend item)

Update event (V1)

V2CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get events (V2)

V2CalendarPostItem (string table, CalendarEventClient item)

Create event (V2)

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)

Get calendar view of events (V2)

V2CalendarGetItem (string table, string id)

Get event (V2)

V2CalendarPatchItem (string table, string id, CalendarEventClient item)

Update event (V2)

ContactGetTables ()

Get contact folders

ContactGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get contacts

ContactPostItem (string table, Contact item)

Create contact

ContactGetItem (string table, string id)

Get contact

ContactDeleteItem (string table, string id)

Delete contact

ContactPatchItem (string table, string id, Contact item)

Update contact

GetDataSets ()

Get datasets

ExportEmail (string messageId)

Export email

RespondToEvent (string event_id, string response, [Optional]ResponseToEventInvite body)

Respond to an event invite

ForwardEmail (string message_id, DirectForwardMessage body)

Forward an email

GetRoomLists ()

Get room lists

GetRooms ()

Get rooms

GetRoomsInRoomList (string room_list)

Get rooms in room list

FindMeetingTimes (FindMeetingTimesParameterBody body)

Find meeting times

ReceiveResponseGet (string state)

Receives response from user

ReceiveResponsePost (string state)

Receives response from user

ReceiveMailFromSubscription (string state, SubscriptionPayload subscriptionPayload, [Optional]string validationtoken)

Receive mail

 

Triggers:

Name

Summary

OnUpcomingEvents (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

When an upcoming event is starting soon

OnNewEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When a new email arrives

OnFlaggedEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When an email is flagged

OnNewMentionMeEmail ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When a new email mentioning me arrives

SharedMailboxOnNewEmail (string mailboxAddress, [Optional]string folderId, [advanced][Optional]string to, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean hasAttachments, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When a new email arrives in a shared mailbox

CreateOnNewEmailSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]string hasAttachment)

When a new email arrives (webhook)

CalendarGetOnNewItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When a new event is created (V1)

CalendarGetOnUpdatedItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an event is modified (V1)

ODataStyleGetOnNewItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When a new item is created in a table

ODataStyleCalendarGetOnUpdatedItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an item is modified

CalendarGetOnNewItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When a new event is created (V2)

CalendarGetOnUpdatedItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an event is modified (V2)

CalendarGetOnChangedItems (string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

When an event is added, updated or deleted

GetOnDeletedItems (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

ODataStyleGetOnDeletedItems (string dataset, string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

 

Objects:

Name

Summary

ApprovalEmailSubscription

 

ApprovalMessage

 

Attendee

 

AutomaticRepliesSettingClient

 

BlobDataSetsMetadata

 

CalendarEventBackend

 

CalendarEventClient

 

CalendarEventClientReceive

 

CalendarEventClientWithActionType

 

CalendarEventList

 

CalendarEventListClientReceive

 

CalendarEventListWithActionType

 

ClientReceiveFileAttachment

 

ClientReceiveMessage

 

ClientSendAttachment

 

ClientSendMessage

 

ClientSubscription

 

Contact

 

DataSet

 

DataSetsList

 

DataSetsMetadata

 

DateTimeTimeZone

DateTimeTimeZone

DirectForwardMessage

 

EmailAddress

 

EntityListResponse[CalendarEventBackend]

 

EntityListResponse[CalendarEventClientReceive]

 

EntityListResponse[Contact]

 

EntityListResponse[FilePickerFile]

 

EntityListResponse[Table]

 

FilePickerFile

 

FindMeetingTimesParameterBody

 

FindMeetingTimesResponse

 

GeoCoordinates

 

GetRoomListsResponse

 

GetRoomsInRoomListResponse

 

GetRoomsResponse

 

Item

 

ItemBody

 

ItemsList

 

Location

 

MailTipsAutomaticReplies

 

MailTipsClientReceive

 

MessageWithOptions

 

Object

 

OptionsEmailSubscription

 

OutlookReceiveAttachment

 

OutlookReceiveMessage

 

PaginatedListResponse[CalendarEventClientReceive]

 

PassThroughNativeQuery

 

PatternedRecurrence

 

PhysicalAddress

 

Recipient

 

RecurrencePattern

 

RecurrenceRange

 

ResponseStatus

 

ResponseToEventInvite

 

SharedMailboxClientSendMessage

 

SubscriptionPayload

 

SubscriptionPayloadEntity

 

SubscriptionResponse

 

Table

 

TableCapabilitiesMetadata

 

TableFilterRestrictionsMetadata

 

TableMetadata

 

TableSortRestrictionsMetadata

 

TabularDataSetsMetadata

 

TriggerBatchResponse[ClientReceiveMessage]

 

 

Actions:

CalendarGetTable

Summary: Get calendar metadata

Description: This operation gets metadata for a calendar.

 

Syntax:

Office365Outlook.CalendarGetTable (string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a calendar.

True

CalendarGetTables

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

ContactGetTable

Summary: Get folder metadata

Description: This operation gets metadata for a contacts folder.

 

Syntax:

Office365Outlook.ContactGetTable (string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder.

True

ContactGetTables

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

GetEventsCalendarView

Summary: Get calendar view of events

Description: Get calendar view of events.

 

Syntax:

Office365Outlook.GetEventsCalendarView (string calendarId, string startDateTimeOffset, string endDateTimeOffset)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar Id)

Select a calendar.

True

CalendarGetTables

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[CalendarEventClientReceive]

          Description: Response containing a list and next link

 

OnFilePickerOpen

Summary: When the file picker is opened for the first time

Description: When the file picker is opened for the first time.

 

Syntax:

Office365Outlook.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

 

OnFilePickerBrowse

Summary: When the file picker is open and being browsed

Description: When the file picker is open and being browsed.

 

Syntax:

Office365Outlook.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

 

GetEmails

Summary: Get emails

Description: This operation gets emails from a folder.

 

Syntax:

Office365Outlook.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 (ClientReceiveMessage)

 

SendEmail

Summary: Send an email

Description: This operation sends an email message.

 

Syntax:

Office365Outlook.SendEmail (ClientSendMessage emailMessage)

 

Parameters:

Name

Type

Summary

Required

Related Action

emailMessage

ClientSendMessage

 

Send Email Message

True

 

Returns:

 

GetEmail

Summary: Get email

Description: This operation gets an email by id.

 

Syntax:

Office365Outlook.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

 

DeleteEmail

Summary: Delete email

Description: This operation deletes an email by id.

 

Syntax:

Office365Outlook.DeleteEmail (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to delete.

True

 

Returns:

 

Move

Summary: Move email

Description: This operation moves an email to the specified folder.

 

Syntax:

Office365Outlook.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:

 

Flag

Summary: Flag email

Description: This operation flags an email.

 

Syntax:

Office365Outlook.Flag (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be flagged.

True

 

Returns:

 

MarkAsRead

Summary: Mark as read

Description: This operation marks an email as having been read.

 

Syntax:

Office365Outlook.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:

 

ReplyTo

Summary: Reply to email

Description: This operation replies to an email.

 

Syntax:

Office365Outlook.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:

 

GetAttachment

Summary: Get attachment

Description: This operation gets an email attachment by id.

 

Syntax:

Office365Outlook.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)

 

SetAutomaticRepliesSetting

Summary: Set up automatic replies

Description: Set the automatic replies setting for your mailbox.

 

Syntax:

Office365Outlook.SetAutomaticRepliesSetting (AutomaticRepliesSettingClient clientSetting)

 

Parameters:

Name

Type

Summary

Required

Related Action

clientSetting

AutomaticRepliesSettingClient

 

Automatic replies setting model for the connector

True

 

Returns:

 

GetMailTips

Summary: Get mail tips for a mailbox

Description: Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

 

Syntax:

Office365Outlook.GetMailTips (string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxAddress

string

(Mailbox Address)

Address of the mailbox to get mail tips for.

True

 

Returns:

          Type:MailTipsClientReceive

          Description: Mail tips client model returned to the caller

 

GetDataSetsMetadata

Summary:

Description:

 

Syntax:

Office365Outlook.GetDataSetsMetadata ()

 

Returns:

          Type:DataSetsMetadata

          Description: Dataset metadata

 

SendMailWithOptions

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.

 

Syntax:

Office365Outlook.SendMailWithOptions (OptionsEmailSubscription optionsEmailSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

optionsEmailSubscription

OptionsEmailSubscription

 

Model for Options Email Subscription

True

 

Returns:

          Type:SubscriptionResponse

          Description: Model for Approval Email Subscription

 

SendApprovalMail

Summary: Send approval email

Description: This operation sends an approval email and waits for a response from the recipient.

 

Syntax:

Office365Outlook.SendApprovalMail (ApprovalEmailSubscription approvalEmailSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

approvalEmailSubscription

ApprovalEmailSubscription

 

Model for Approval Email Subscription

True

 

Returns:

          Type:SubscriptionResponse

          Description: Model for Approval Email Subscription

 

DeleteApprovalMailSubscription

Summary: Delete approval email subscription

Description: This operation deletes a subscription of approval email.

 

Syntax:

Office365Outlook.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:

 

DeleteOptionsMailSubscription

Summary: Delete options email subscription

Description: This operation deletes a subscription of options email.

 

Syntax:

Office365Outlook.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:

 

SharedMailboxSendEmail

Summary: Send an email from a shared mailbox

Description: This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

 

Syntax:

Office365Outlook.SharedMailboxSendEmail (SharedMailboxClientSendMessage emailMessage)

 

Parameters:

Name

Type

Summary

Required

Related Action

emailMessage

SharedMailboxClientSendMessage

 

Shared Mailbox Send Email Message

True

 

Returns:

 

DeleteOnNewEmailSubscription

Summary: Delete mail subscription

Description: This operation deletes a mail subscription.

 

Syntax:

Office365Outlook.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:

 

RenewOnNewEmailSubscription

Summary: Update web hook

Description: Update web hook with renew interval.

 

Syntax:

Office365Outlook.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

ClientSubscription

 

Describes the subscription information for emails.

True

 

Returns:

 

TestConnection

Summary: Tests the connection

Description: Tests the connection.

 

Syntax:

Office365Outlook.TestConnection ()

 

Returns:

 

CalendarGetTables

Summary: Get calendars

Description: This operation lists available calendars.

 

Syntax:

Office365Outlook.CalendarGetTables ()

 

Returns:

          Type:EntityListResponse[Table]

          Description: Entity list response

 

CalendarGetItems

Summary: Get events (V1)

Description: This operation gets events from a calendar. (V1)

 

Syntax:

Office365Outlook.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

CalendarGetTables

$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

 

CalendarPostItem

Summary: Create event (V1)

Description: This operation creates a new event in a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarPostItem (string table, CalendarEventBackend item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

item

CalendarEventBackend

 

Connector specific calendar event model class for the backend

True

 

Returns:

          Type:CalendarEventBackend

          Description: Connector specific calendar event model class for the backend

 

CalendarGetItem

Summary: Get event (V1)

Description: This operation gets a specific event from a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Item id)

Select an event

True

 

Returns:

          Type:CalendarEventBackend

          Description: Connector specific calendar event model class for the backend

 

CalendarDeleteItem

Summary: Delete event

Description: This operation deletes an event in a calendar.

 

Syntax:

Office365Outlook.CalendarDeleteItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

 

Returns:

 

CalendarPatchItem

Summary: Update event (V1)

Description: This operation updates an event in a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarPatchItem (string table, string id, CalendarEventBackend item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

item

CalendarEventBackend

 

Connector specific calendar event model class for the backend

True

 

Returns:

          Type:CalendarEventBackend

          Description: Connector specific calendar event model class for the backend

 

V2CalendarGetItems

Summary: Get events (V2)

Description: This operation gets events from a calendar. (V2)

 

Syntax:

Office365Outlook.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

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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[CalendarEventClientReceive]

          Description: Entity list response

 

V2CalendarPostItem

Summary: Create event (V2)

Description: This operation creates a new event in a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarPostItem (string table, CalendarEventClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

item

CalendarEventClient

 

Connector specific calendar event model class for the client

True

 

Returns:

          Type:CalendarEventClientReceive

          Description: Connector specific calendar event model class for the client

 

GetEventsCalendarViewV2

Summary: Get calendar view of events (V2)

Description: This operation gets all events (including instances of recurrences) in a calendar. (V2)

 

Syntax:

Office365Outlook.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

CalendarGetTables

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.

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[CalendarEventClientReceive]

          Description: Entity list response

 

V2CalendarGetItem

Summary: Get event (V2)

Description: This operation gets a specific event from a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Item id)

Select an event

True

 

Returns:

          Type:CalendarEventClientReceive

          Description: Connector specific calendar event model class for the client

 

V2CalendarPatchItem

Summary: Update event (V2)

Description: This operation updates an event in a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarPatchItem (string table, string id, CalendarEventClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

item

CalendarEventClient

 

Connector specific calendar event model class for the client

True

 

Returns:

          Type:CalendarEventClientReceive

          Description: Connector specific calendar event model class for the client

 

ContactGetTables

Summary: Get contact folders

Description: This operation lists available contacts folders.

 

Syntax:

Office365Outlook.ContactGetTables ()

 

Returns:

          Type:EntityListResponse[Table]

          Description: Entity list response

 

ContactGetItems

Summary: Get contacts

Description: This operation gets contacts from a contacts folder.

 

Syntax:

Office365Outlook.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

ContactGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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[Contact]

          Description: Entity list response

 

ContactPostItem

Summary: Create contact

Description: This operation creates a new contact in a contacts folder.

 

Syntax:

Office365Outlook.ContactPostItem (string table, Contact item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

item

Contact

 

Contact

True

 

Returns:

          Type:Contact

          Description: Contact

 

ContactGetItem

Summary: Get contact

Description: This operation gets a specific contact from a contacts folder.

 

Syntax:

Office365Outlook.ContactGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

id

string

(Item id)

Unique identifier of a contact to retrieve

True

 

Returns:

          Type:Contact

          Description: Contact

 

ContactDeleteItem

Summary: Delete contact

Description: This operation deletes a contact from a contacts folder.

 

Syntax:

Office365Outlook.ContactDeleteItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

id

string

(Id)

Unique identifier of contact to delete

True

 

Returns:

 

ContactPatchItem

Summary: Update contact

Description: This operation updates a contact in a contacts folder.

 

Syntax:

Office365Outlook.ContactPatchItem (string table, string id, Contact item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

id

string

(Id)

Unique identifier of contact to update

True

item

Contact

 

Contact

True

 

Returns:

          Type:Contact

          Description: Contact

 

GetDataSets

Summary: Get datasets

Description: This operation gets Contacts or Calendars

 

Syntax:

Office365Outlook.GetDataSets ()

 

Returns:

          Type:DataSetsList

          Description: List of datasets

 

ExportEmail

Summary: Export email

Description: Export the content of the email.

 

Syntax:

Office365Outlook.ExportEmail (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to export.

True

 

Returns:

          Type:string(binary)

 

RespondToEvent

Summary: Respond to an event invite

Description: Respond to an event invite.

 

Syntax:

Office365Outlook.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

ResponseToEventInvite

 

Response to an event invite

False

 

Returns:

 

ForwardEmail

Summary: Forward an email

Description: Forward an email.

 

Syntax:

Office365Outlook.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

DirectForwardMessage

 

Directly forward message

True

 

Returns:

 

GetRoomLists

Summary: Get room lists

Description: Get all the room lists defined in the user's tenant

 

Syntax:

Office365Outlook.GetRoomLists ()

 

Returns:

          Type:GetRoomListsResponse

 

GetRooms

Summary: Get rooms

Description: Get all the meeting rooms defined in the user's tenant

 

Syntax:

Office365Outlook.GetRooms ()

 

Returns:

          Type:GetRoomsResponse

 

GetRoomsInRoomList

Summary: Get rooms in room list

Description: Get the meeting rooms in a specific room list

 

Syntax:

Office365Outlook.GetRoomsInRoomList (string room_list)

 

Parameters:

Name

Type

Summary

Required

Related Action

room_list

string

(Room list)

Room list to find rooms in

True

GetRoomLists

 

Returns:

          Type:GetRoomsInRoomListResponse

 

FindMeetingTimes

Summary: Find meeting times

Description: Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

 

Syntax:

Office365Outlook.FindMeetingTimes (FindMeetingTimesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FindMeetingTimesParameterBody

 

 

True

 

Returns:

          Type:FindMeetingTimesResponse

 

ReceiveResponseGet

Summary: Receives response from user

Description: This operation gets a response from the user.

 

Syntax:

Office365Outlook.ReceiveResponseGet (string state)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(callback state)

callback state.

True

 

Returns:

          Type:string

 

ReceiveResponsePost

Summary: Receives response from user

Description: This operation gets a response from the user.

 

Syntax:

Office365Outlook.ReceiveResponsePost (string state)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(callback state)

callback state.

True

 

Returns:

          Type:string

 

ReceiveMailFromSubscription

Summary: Receive mail

Description: This operation validates the subscription request.

 

Syntax:

Office365Outlook.ReceiveMailFromSubscription (string state, SubscriptionPayload subscriptionPayload, [Optional]string validationtoken)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

subscriptionPayload

SubscriptionPayload

 

Payload from backend containing subscription metadata as well as email

True

validationtoken

string

(Validation token)

Validation token.

False

 

Returns:

 

Triggers:

Trigger OnUpcomingEvents

Summary: When an upcoming event is starting soon

Description: This operation triggers a flow when an upcoming calendar event is starting.

 

Syntax:

Office365Outlook.OnUpcomingEvents (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar Id)

Unique identifier of the calendar.

True

CalendarGetTables

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

 

Trigger OnNewEmail

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.

 

Syntax:

Office365Outlook.OnNewEmail ([Optional]string folderPath, [advanced][Optional]string to, [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

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

(Has Attachment)

Should the email contain attachments.

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

 

Trigger OnFlaggedEmail

Summary: When an email is flagged

Description: This operation triggers a flow when an email is flagged.

 

Syntax:

Office365Outlook.OnFlaggedEmail ([Optional]string folderPath, [advanced][Optional]string to, [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

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

(Has Attachment)

Should the email contain attachments.

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

 

Trigger OnNewMentionMeEmail

Summary: When a new email mentioning me arrives

Description: This operation triggers a flow when a new email mentioning me arrives.

 

Syntax:

Office365Outlook.OnNewMentionMeEmail ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [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

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

(Has Attachment)

Should the email contain attachments.

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

 

Trigger SharedMailboxOnNewEmail

Summary: When a new email arrives in a shared mailbox

Description: This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

 

Syntax:

Office365Outlook.SharedMailboxOnNewEmail (string mailboxAddress, [Optional]string folderId, [advanced][Optional]string to, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean hasAttachments, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxAddress

string

(Mailbox Address)

Address of the shared mailbox.

True

folderId

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

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

hasAttachments

boolean

(Has Attachment)

Should the email contain attachments.

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

 

Trigger CreateOnNewEmailSubscription

Summary: When a new email arrives (webhook)

Description: This operation triggers a flow when a new email arrives.

 

Syntax:

Office365Outlook.CreateOnNewEmailSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]string hasAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information for emails.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the received email ("Any", "High", "Normal", "Low").

False

hasAttachment

string

(Has Attachment)Values: [Any, Yes, No]

Whether the email has attachments ("Any", "Yes", "No").

False

 

Returns:

          Type:SubscriptionResponse

          Description: Model for Approval Email Subscription

 

Trigger CalendarGetOnNewItems

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:

Office365Outlook.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

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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

 

Trigger CalendarGetOnUpdatedItems

Summary: When an event is modified (V1)

Description: This operation triggers a flow when an event is modified in a calendar. (V1)

 

Syntax:

Office365Outlook.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

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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

 

Trigger ODataStyleGetOnNewItems

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:

Office365Outlook.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.

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

 

Trigger ODataStyleCalendarGetOnUpdatedItems

Summary: When an item is modified

Description: This operation triggers a flow when an item is modified in a table.

 

Syntax:

Office365Outlook.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.

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

 

Trigger CalendarGetOnNewItemsV2

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:

Office365Outlook.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

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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

 

Trigger CalendarGetOnUpdatedItemsV2

Summary: When an event is modified (V2)

Description: This operation triggers a flow when an event is modified in a calendar. (V2)

 

Syntax:

Office365Outlook.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

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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

 

Trigger CalendarGetOnChangedItems

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:

Office365Outlook.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

CalendarGetTables

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

 

Trigger GetOnDeletedItems

Summary:

Description:

 

Syntax:

Office365Outlook.GetOnDeletedItems (string dataset, 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

dataset

string

 

 

True

GetDataSets

table

string

 

 

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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:ItemsList

          Description: List of Items

 

Trigger ODataStyleGetOnDeletedItems

Summary:

Description:

 

Syntax:

Office365Outlook.ODataStyleGetOnDeletedItems (string dataset, 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

dataset

string

 

 

True

table

string

 

 

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned.

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:ItemsList

          Description: List of Items

 


 

ApprovalEmailSubscription

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

ApprovalMessage

 

Approval Email Message. This is the message expected as part of user input


 

ApprovalMessage

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


 

Attendee

Summary:

Description:

 

          Properties:

Name

Type

Summary

Status

ResponseStatus

 

 

Type

string

 

Values: [Required, Optional, Resource]

EmailAddress

EmailAddress

 

 


 

AutomaticRepliesSettingClient

Summary:

Description: Automatic replies setting model for the connector

 

          Properties:

Name

Type

Summary

Status

string

Status

Automatic reply setting status  Values: [Disabled, AlwaysEnabled, Scheduled]

ExternalAudience

string

External Audience

The audience that will see the external reply message  Values: [None, ContactsOnly, All]

ScheduledStartDateTimeOffset

string

Start Time

Scheduled start time (example: '2016-11-01T15:30:00-00:00')

ScheduledEndDateTimeOffset

string

End Time

Scheduled end time (example: '2016-11-01T15:30:00-00:00')

InternalReplyMessage

string

Internal Reply Message

Message for people within your organization

ExternalReplyMessage

string

External Reply Message

Message for people outside your organization


 

BlobDataSetsMetadata

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


 

CalendarEventBackend

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

ItemBody

 

 

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

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

Location

 

 

Organizer

Recipient

 

 

Recurrence

PatternedRecurrence

 

 

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

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.


 

CalendarEventClient

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:00')

End

string(date-time)

End time

End time of the event (example: '2016-11-01T15:30:00')

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, Volgograd, (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) 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

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


 

CalendarEventClientReceive

Summary:

Description: Connector specific calendar event model class for the client

 

          Properties:

Name

Type

Summary

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

Subject

string

Subject

Event subject

Start

string(date-time)

Start time

Start time of the event (example: '2016-11-01T14:30:00')

End

string(date-time)

End time

End time of the event (example: '2016-11-01T15:30:00')

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

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


 

CalendarEventClientWithActionType

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]

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

Subject

string

Subject

Event subject

Start

string(date-time)

Start time

Start time of the event (example: '2016-11-01T14:30:00')

End

string(date-time)

End time

End time of the event (example: '2016-11-01T15:30:00')

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

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


 

CalendarEventList

Summary:

Description: The list of calendar items

 

          Properties:

Name

Type

Summary

value

array of (CalendarEventBackend)

 

List of calendar items


 

CalendarEventListClientReceive

Summary:

Description: The list of calendar items

 

          Properties:

Name

Type

Summary

value

array of (CalendarEventClientReceive)

 

List of calendar items


 

CalendarEventListWithActionType

Summary:

Description: The list of calendar items with action type

 

          Properties:

Name

Type

Summary

value

array of (CalendarEventClientWithActionType)

 

List of calendar items


 

ClientReceiveFileAttachment

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)

 

Attachment size in bytes


 

ClientReceiveMessage

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

Subject

string

Subject

The subject of the message

Body

string

Body

The body of the message

Importance

string

Importance

The importance of the message  Values: [Low, Normal, 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

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?


 

ClientSendAttachment

Summary:

Description: Attachment

 

          Properties:

Name

Type

Summary

Name

string

Name

Attachment name

ContentBytes

string(byte)

Content

Attachment content


 

ClientSendMessage

Summary:

Description: Send Email Message

 

          Properties:

Name

Type

Summary

From

string(email)

From (Send as)

Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox)

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

Importance

string

Importance

Importance  Values: [Low, Normal, High]

IsHtml

boolean

Is HTML

Is Html?


 

ClientSubscription

Summary:

Description: Describes the subscription information for emails.

 

          Properties:

Name

Type

Summary

NotificationUrl

string

 

Callback url to the flow engine. Expected as part of the request and provided by Flow.


 

Contact

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

PhysicalAddress

 

 

BusinessAddress

PhysicalAddress

 

 

OtherAddress

PhysicalAddress

 

 

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


 

DataSet

Summary:

Description: Dataset

 

          Properties:

Name

Type

Summary

Name

string

 

Dataset name

DisplayName

string

 

Dataset display name

query

array of (PassThroughNativeQuery)

 

Pass-through Native Queries


 

DataSetsList

Summary:

Description: List of datasets

 

          Properties:

Name

Type

Summary

value

array of (DataSet)

 

List of datasets


 

DataSetsMetadata

Summary:

Description: Dataset metadata

 

          Properties:

Name

Type

Summary

tabular

TabularDataSetsMetadata

 

Tabular dataset metadata

blob

BlobDataSetsMetadata

 

Blob dataset metadata


 

DateTimeTimeZone

Summary: DateTimeTimeZone

Description: DateTimeTimeZone

 

          Properties:

Name

Type

Summary

DateTime

string

DateTime

DateTime

TimeZone

string

TimeZone

TimeZone


 

DirectForwardMessage

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


 

EmailAddress

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

Address

string(email)

 

 


 

EntityListResponse[CalendarEventBackend]

Summary:

Description: Entity list response

 

          Properties:

Name

Type

Summary

value

array of (CalendarEventBackend)

 

List of values

@odata.nextLink

string

 

Next page link

@odata.deltaLink

string

 

Delta link


 

EntityListResponse[CalendarEventClientReceive]

Summary:

Description: Entity list response

 

          Properties:

Name

Type

Summary

value

array of (CalendarEventClientReceive)

 

List of values

@odata.nextLink

string

 

Next page link

@odata.deltaLink

string

 

Delta link


 

EntityListResponse[Contact]

Summary:

Description: Entity list response

 

          Properties:

Name

Type

Summary

value

array of (Contact)

 

List of values

@odata.nextLink

string

 

Next page link

@odata.deltaLink

string

 

Delta link


 

EntityListResponse[FilePickerFile]

Summary:

Description: Entity list response

 

          Properties:

Name

Type

Summary

value

array of (FilePickerFile)

 

List of values

@odata.nextLink

string

 

Next page link

@odata.deltaLink

string

 

Delta link


 

EntityListResponse[Table]

Summary:

Description: Entity list response

 

          Properties:

Name

Type

Summary

value

array of (Table)

 

List of values

@odata.nextLink

string

 

Next page link

@odata.deltaLink

string

 

Delta link


 

FilePickerFile

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


 

FindMeetingTimesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

RequiredAttendees

string

Required attendees

List of semicolon separated email addresses

OptionalAttendees

string

Optional attendees

List of semicolon separated email addresses

MeetingDuration

integer(int32)

Meeting duration

Duration of the meeting in minutes

Start

string(date-time)

Start time

Start time for meeting time suggestions

End

string(date-time)

End time

End time for meeting time suggestions

MaxCandidates

integer(int32)

Max Candidates

The maximum number of meeting suggestions to return in the response

MinimumAttendeePercentage

string

Minimum Attendee Percentage

The minimum required confidence for a time slot to be returned in the response

IsOrganizerOptional

boolean

Is Organizer Optional?

true if the organizer doesn't have to attend. The default is false

ActivityDomain

string

Activity Domain

Work, Personal, Unrestricted, or Unknown  Values: [Work, Personal, Unrestricted, Unknown]


 

FindMeetingTimesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

EmptySuggestionsReason

string

Empty Suggestions Reason

Empty Suggestions Reason

MeetingTimeSuggestions

array of (MeetingTimeSuggestionsItem)

Meeting Time Suggestions

Meeting Time Suggestions

 

MeetingTimeSuggestionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Confidence

number(float)

Confidence

Confidence

OrganizerAvailability

string

Organizer Availability

Organizer Availability

SuggestionReason

string

Suggestion Reason

Suggestion Reason

MeetingTimeSlot

MeetingTimeSlot

Meeting Time Slot

Meeting Time Slot

AttendeeAvailability

array of (AttendeeAvailabilityItem)

Attendee Availability

Attendee Availability

Locations

array of (LocationsItem)

Locations

Locations

 

MeetingTimeSlot

Summary: Meeting Time Slot

Description: Meeting Time Slot

 

          Properties:

Name

Type

Summary

Start

DateTimeTimeZone

DateTimeTimeZone

DateTimeTimeZone

End

DateTimeTimeZone

DateTimeTimeZone

DateTimeTimeZone

 

AttendeeAvailabilityItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Availability

string

Availability

Availability

Attendee

Attendee

Attendee

Attendee

 

Attendee

Summary: Attendee

Description: Attendee

 

          Properties:

Name

Type

Summary

Type

string

Type

Type

EmailAddress

EmailAddress

Email Address

Email Address

 

EmailAddress

Summary: Email Address

Description: Email Address

 

          Properties:

Name

Type

Summary

Address

string

Address

Address

 

LocationsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

DisplayName

string

Display Name

Display Name

LocationEmailAddress

string

Location Email Address

Location Email Address

Address

Address

Address

Address

 

Address

Summary: Address

Description: Address

 

          Properties:

Name

Type

Summary

Type

string

Type

Type

Street

string

Street

Street

City

string

City

City

State

string

State

State

CountryOrRegion

string

Country Or Region

Country Or Region

PostalCode

string

Postal Code

Postal Code

 


 

GeoCoordinates

Summary:

Description:

 

          Properties:

Name

Type

Summary

Altitude

number(double)

 

 

Latitude

number(double)

 

 

Longitude

number(double)

 

 

Accuracy

number(double)

 

 

AltitudeAccuracy

number(double)

 

 


 

GetRoomListsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

value

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

Name

Name

Address

string

Address

Address

 


 

GetRoomsInRoomListResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

value

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

Name

Name

Address

string

Address

Address

 


 

GetRoomsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

value

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

Name

Name

Address

string

Address

Address

 


 

Item

Summary:

Description: Table item entity

 

          Properties:

Name

Type

Summary

dynamicProperties

DynamicProperties

 

 

ItemInternalId

string

 

Table item internal id

 

DynamicProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

ItemBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

ContentType

string

 

Values: [Text, HTML]

Content

string

 

 


 

ItemsList

Summary:

Description: List of Items

 

          Properties:

Name

Type

Summary

value

array of (Item)

 

List of Items


 

Location

Summary:

Description:

 

          Properties:

Name

Type

Summary

DisplayName

string

 

 

Address

PhysicalAddress

 

 

Coordinates

GeoCoordinates

 

 


 

MailTipsAutomaticReplies

Summary:

Description: Automatic replies as part of mail tips

 

          Properties:

Name

Type

Summary

Message

string

 

Automatic replies message


 

MailTipsClientReceive

Summary:

Description: Mail tips client model returned to the caller

 

          Properties:

Name

Type

Summary

AutomaticReplies

MailTipsAutomaticReplies

 

Automatic replies as part of mail tips

DeliveryRestricted

boolean

 

Is delivery restricted

ExternalMemberCount

integer(int32)

 

Number of external members

IsModerated

boolean

 

Is moderated

MailboxFull

boolean

 

Is mailbox full

MaxMessageSize

integer(int64)

 

Maximum message size

TotalMemberCount

integer(int64)

 

Total member count


 

MessageWithOptions

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


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OptionsEmailSubscription

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

MessageWithOptions

 

User Options Email Message. This is the message expected as part of user input


 

OutlookReceiveAttachment

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


 

OutlookReceiveMessage

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

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

Subject

string

 

Subject

Body

ItemBody

 

 

From

Recipient

 

 

Importance

string

 

Importance  Values: [Low, Normal, High]


 

PaginatedListResponse[CalendarEventClientReceive]

Summary:

Description: Response containing a list and next link

 

          Properties:

Name

Type

Summary

Values

array of (CalendarEventClientReceive)

 

Values

NextLink

string

 

Next page link


 

PassThroughNativeQuery

Summary:

Description: static schema for pass-through native query execution

 

          Properties:

Name

Type

Summary

Language

string

 

Query language


 

PatternedRecurrence

Summary:

Description:

 

          Properties:

Name

Type

Summary

Pattern

RecurrencePattern

 

 

Range

RecurrenceRange

 

 


 

PhysicalAddress

Summary:

Description:

 

          Properties:

Name

Type

Summary

Street

string

 

 

City

string

 

 

State

string

 

 

CountryOrRegion

string

 

 

PostalCode

string

 

 


 

Recipient

Summary:

Description:

 

          Properties:

Name

Type

Summary

EmailAddress

EmailAddress

 

 


 

RecurrencePattern

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]


 

RecurrenceRange

Summary:

Description:

 

          Properties:

Name

Type

Summary

Type

string

 

Values: [EndDate, NoEnd, Numbered]

StartDate

string(date-time)

 

 

EndDate

string(date-time)

 

 

NumberOfOccurrences

integer(int32)

 

 


 

ResponseStatus

Summary:

Description:

 

          Properties:

Name

Type

Summary

Response

string

 

Values: [None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded]

Time

string(date-time)

 

 


 

ResponseToEventInvite

Summary:

Description: Response to an event invite

 

          Properties:

Name

Type

Summary

Comment

string

Comment

Comment

SendResponse

boolean

Send response?

Send response to organizer?


 

SharedMailboxClientSendMessage

Summary:

Description: Shared Mailbox Send Email Message

 

          Properties:

Name

Type

Summary

MailboxAddress

string(email)

Mailbox Address

Specify email address of a shared mailbox 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

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

Importance

string

Importance

Importance  Values: [Low, Normal, High]

IsHtml

boolean

Is HTML

Is Html?


 

SubscriptionPayload

Summary:

Description: Payload from backend containing subscription metadata as well as email

 

          Properties:

Name

Type

Summary

value

array of (SubscriptionPayloadEntity)

 

List of values


 

SubscriptionPayloadEntity

Summary:

Description: Subscription payload entity

 

          Properties:

Name

Type

Summary

SequenceNumber

integer(int32)

 

Sequence number

ChangeType

string

 

Change type

Resource

string

 

Resource

ResourceData

OutlookReceiveMessage

 

Received message from outlook rest api


 

SubscriptionResponse

Summary:

Description: Model for Approval Email Subscription

 

          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


 

Table

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.


 

TableCapabilitiesMetadata

Summary:

Description: Metadata for a table (capabilities)

 

          Properties:

Name

Type

Summary

sortRestrictions

TableSortRestrictionsMetadata

 

Metadata for a table (sort restrictions)

filterRestrictions

TableFilterRestrictionsMetadata

 

Metadata for a table (filter restrictions)

isOnlyServerPagable

boolean

 

Server paging restrictions

filterFunctionSupport

array of (string)

 

List of supported filter capabilities


 

TableFilterRestrictionsMetadata

Summary:

Description: Metadata for a table (filter restrictions)

 

          Properties:

Name

Type

Summary

filterable

boolean

 

Indicates whether this table has sortable columns

nonFilterableProperties

array of (string)

 

List of non filterable properties

requiredProperties

array of (string)

 

List of required properties


 

TableMetadata

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

TableCapabilitiesMetadata

 

Metadata for a table (capabilities)

schema

Object

 

 

referencedEntities

Object

 

 

webUrl

string

 

Url link


 

TableSortRestrictionsMetadata

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


 

TabularDataSetsMetadata

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


 

TriggerBatchResponse[ClientReceiveMessage]

Summary:

Description: Represents a wrapper object for batch trigger response

 

          Properties:

Name

Type

Summary

value

array of (ClientReceiveMessage)

 

A list of the response objects