Connectors Reference
Microsoft Teams enables you to get all your content, tools and conversations in the Team workspace with Office 365.
|
Status: Preview |
Tier: Standard |
Version: 1.0.4 |
|
Name |
Summary |
|
Create a Teams meeting |
|
|
List teams |
|
|
List channels |
|
|
CreateChannel (string groupId, CreateChannelParameterBody body) |
Create a channel |
|
PostMessageToChannelV2 (string groupId, string channelId, PostMessageToChannelV2ParameterBody body) |
Post a message (V2) |
|
Get messages |
|
|
PostMessageToChannelV3 (string groupId, string channelId, PostMessageToChannelV3ParameterBody body) |
Post a message (V3) |
|
Post a reply to a message |
|
|
Post a reply to a message (V2) |
|
|
PostMessageToChannel (string groupId, string channelId, PostMessageToChannelParameterBody body) |
Post a message |
|
PostUserNotification (DynamicUserNotificationRequest PostNotificationRequest) |
Post a message as the Flow bot to a user |
|
PostChannelNotification (string groupId, DynamicChannelNotificationRequest PostNotificationRequest) |
Post a message as the Flow bot to a channel |
|
PostUserAdaptiveCard (DynamicUserAdaptiveCardRequest PostAdaptiveCardRequest) |
Post your own adaptive card as the Flow bot to a user |
|
PostChannelAdaptiveCard (string groupId, DynamicChannelAdaptiveCardRequest PostAdaptiveCardRequest) |
Post your own adaptive card as the Flow bot to a channel |
|
Get adptive card input metadata |
|
|
Get notification input metadata |
|
|
Post a choice of options as the Flow bot to a user |
|
|
Post an Adaptive Card to a Teams user and wait for a response |
|
|
Post an Adaptive Card to a Teams channel and wait for a response |
|
|
UnsubscribeMessageWithOptions (string recipientType, string subscriptionId) |
Unsubscribe from a choice of options |
|
UnsubscribeFlowContinuation (string recipientType, string subscriptionId) |
Unsubscribe from a flow continuation |
|
Get message with options input metadata |
|
|
Get flow continuation input metadata |
|
|
GetMessageWithOptionsSubscriptionInputMetadata (string recipientType) |
Get message with options subscription input metadata |
|
GetFlowContinuationSubscriptionInputMetadata (string recipientType) |
Get flow continuation subscription input metadata |
|
GetMessageWithOptionsSubscriptionOutputMetadata (string recipientType) |
Get message with options subscription output metadata |
|
GetFlowContinuationSubscriptionOutputMetadata (string recipientType, string body) |
Get flow continuation subscription output metadata |
|
Get selected message hybrid trigger output metadata |
|
|
Get compose message hybrid trigger output metadata |
|
|
Get a team |
|
|
Get @mention token for a user |
|
|
ListTimeOffReasons (string teamId, [advanced][Optional]integer $top) |
Shifts: List all Time Off reasons |
|
Shifts: List all shifts |
|
|
Shifts: Get a shift |
|
|
Shifts: Delete a shift |
|
|
Shifts: List all Open Shifts |
|
|
CreateOpenShift (string teamId, EditOpenShiftRequest request) |
Shifts: Create a new Open Shift |
|
Shifts: Get an open shift |
|
|
UpdateOpenShift (string teamId, string openShiftId, EditOpenShiftRequest request) |
Shifts: Update an Open Shift |
|
Shifts: Delete an open shift |
|
|
ListSchedulingGroups (string teamId, [advanced][Optional]integer $top) |
Shifts: List all scheduling groups |
|
GetSchedulingGroup (string teamId, string schedulingGroupId) |
Shifts: Get a scheduling group |
|
Shifts: List all Time Off requests |
|
|
Shifts: Approve a Time Off request |
|
|
Shifts: Decline a Time Off request |
|
|
Shifts: List all Offer Shift requests |
|
|
Shifts: Approve an Offer Shift request |
|
|
Shifts: Decline an Offer Shift request |
|
|
Shifts: List all Swap Shifts requests |
|
|
Shifts: Approve a Swap Shifts request |
|
|
Shifts: Decline a Swap Shifts request |
|
|
Shifts: List all Open Shift requests |
|
|
Shifts: Approve an Open Shift request |
|
|
Shifts: Decline an Open Shift request |
|
|
Shifts: Get a schedule's details |
|
|
Create a team |
|
|
Get Teams async result |
|
|
AddMemberToTeam (string teamId, AddMemberToTeamParameterBody body) |
Add a member to a team |
|
PostMessageToConversation (string poster, string location, DynamicPostMessageRequest body) |
Post message in a chat or channel |
|
ReplyWithMessageToConversation (string poster, string location, DynamicReplyMessageRequest body) |
Reply with a message in a channel |
|
PostCardToConversation (string poster, string location, DynamicPostCardRequest body) |
Post adaptive card in a chat or channel |
|
Post adaptive card and wait for a response |
|
|
ReplyWithCardToConversation (string poster, string location, DynamicReplyCardRequest body) |
Reply with adaptive card in a channel |
|
Conversation location for where to post |
|
|
Conversation location for where to reply |
|
|
Get message input metadata |
|
|
GetReplyWithMessageInputSchema (string poster, string location) |
Get reply to message input metadata |
|
Get adaptive card input metadata |
|
|
GetReplyWithCardInputSchema (string poster, string location) |
Get reply with adaptive card input metadata |
|
GetPostCardAndWaitInputSchema (string poster, string location) |
Get adaptive card input metadata |
|
Name |
Summary |
|
OnNewChannelMessage (string groupId, string channelId, [internal][Optional]integer $top) |
When a new channel message is added |
|
OnNewChannelMessageMentioningMe (string groupId, string channelId, [internal][Optional]integer $top) |
When I am mentioned in a channel message |
|
For a selected message |
|
|
From the compose box |
|
|
OnGroupMembershipRemoval (string groupId, [internal][Optional]string $select) |
When a new team member is removed |
|
OnGroupMembershipAdd (string groupId, [internal][Optional]string $select) |
When a new team member is added |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Draft Open Shift |
|
|
Draft Shift |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List of time off reasons associated with a team |
|
|
|
|
|
Last Modified By |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Offer Shift Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Open Shift Change Request |
|
|
Open Shift |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Scheduling Group |
|
|
|
|
|
Shared Open Shift |
|
|
Shared Shift |
|
|
Shift |
|
|
SubscribeChannelFlowContinuationParameterChannelFlowContinuationSubscriptionRequest |
|
|
SubscribeUserFlowContinuationParameterUserFlowContinuationSubscriptionRequest |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Swap Shift Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TimeOff Request |
Summary: Create a Teams meeting
Description: Create a meeting with a link at the bottom of the invite to join the meeting online on Teams
Syntax:
MicrosoftTeams.CreateTeamsMeeting (string calendarid, NewMeeting item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
calendarid |
string (Calendar id)Values: [Birthdays, Calendar, United States holidays] |
Select a Value |
True |
|
|
item |
|
New meeting event model |
True |
Returns:
Type:NewMeetingRespone
Description: Response for new meeting that was created
Summary: List teams
Description: This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of.
Syntax:
MicrosoftTeams.GetAllTeams ()
Returns:
Type:GetAllTeamsResponse
Summary: List channels
Description: This operation retrieves a list of all the channels for a specific Team.
Syntax:
MicrosoftTeams.GetChannelsForGroup (string groupId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
Returns:
Type:GetChannelsForGroupResponse
Summary: Create a channel
Description: This operation is used to create a new channel for a specific Team.
Syntax:
MicrosoftTeams.CreateChannel (string groupId, CreateChannelParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
body |
|
|
True |
Returns:
Summary: Post a message (V2)
Description: This operation is used to post a message to a channel in a specific Team.
Syntax:
MicrosoftTeams.PostMessageToChannelV2 (string groupId, string channelId, PostMessageToChannelV2ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
body |
PostMessageToChannelV2ParameterBody
|
|
True |
Returns:
Summary: Get messages
Description: This operation is used to get messages from a channel in a specific Team.
Syntax:
MicrosoftTeams.GetMessagesFromChannel (string groupId, string channelId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
Returns:
Type:GetMessagesFromChannel_Response
Summary: Post a message (V3)
Description: This operation is used to post a message to a channel in a specific Team.
Syntax:
MicrosoftTeams.PostMessageToChannelV3 (string groupId, string channelId, PostMessageToChannelV3ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
body |
PostMessageToChannelV3ParameterBody
|
|
True |
Returns:
Type:MessageId
Summary: Post a reply to a message
Description: This operation is used to post a reply to a message in a channel in a specific Team.
Syntax:
MicrosoftTeams.PostReplyToMessage (string groupId, string channelId, string messageId, PostReplyToMessageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
messageId |
string (Message) |
Add Teams message ID |
True |
|
|
body |
PostReplyToMessageParameterBody
|
|
True |
Returns:
Summary: Post a reply to a message (V2)
Description: This operation is used to post a reply to a message in a channel in a specific Team.
Syntax:
MicrosoftTeams.PostReplyToMessageV2 (string groupId, string channelId, string messageId, PostReplyToMessageV2ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
messageId |
string (Message) |
Add Teams message ID |
True |
|
|
body |
PostReplyToMessageV2ParameterBody
|
|
True |
Returns:
Summary: Post a message
Description: This operation is used to post a message to a channel in a specific Team.
Syntax:
MicrosoftTeams.PostMessageToChannel (string groupId, string channelId, PostMessageToChannelParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
body |
PostMessageToChannelParameterBody
|
|
True |
Returns:
Summary: Post a message as the Flow bot to a user
Description: Easily automate the process of sending a message to someone in Teams.
Syntax:
MicrosoftTeams.PostUserNotification (DynamicUserNotificationRequest PostNotificationRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
PostNotificationRequest |
DynamicUserNotificationRequest
|
|
True |
Returns:
Summary: Post a message as the Flow bot to a channel
Description: Easily automate the process of posting a message to a Teams channel.
Syntax:
MicrosoftTeams.PostChannelNotification (string groupId, DynamicChannelNotificationRequest PostNotificationRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
PostNotificationRequest |
DynamicChannelNotificationRequest
|
|
True |
Returns:
Summary: Post your own adaptive card as the Flow bot to a user
Description: Add the JSON card definition to create a custom message for a Teams user. The message can contain images, graphs, text, and more.
Syntax:
MicrosoftTeams.PostUserAdaptiveCard (DynamicUserAdaptiveCardRequest PostAdaptiveCardRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
PostAdaptiveCardRequest |
DynamicUserAdaptiveCardRequest
|
|
True |
Returns:
Type:MessageId
Summary: Post your own adaptive card as the Flow bot to a channel
Description: Add the JSON card definition to create a custom post for a Teams channel. The post can contain images, graphs, text, and more.
Syntax:
MicrosoftTeams.PostChannelAdaptiveCard (string groupId, DynamicChannelAdaptiveCardRequest PostAdaptiveCardRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
PostAdaptiveCardRequest |
DynamicChannelAdaptiveCardRequest
|
|
True |
Returns:
Type:MessageId
Summary: Get adptive card input metadata
Description: Get the schema information for adaptive card inputs
Syntax:
MicrosoftTeams.GetAdaptiveCardInputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Get notification input metadata
Description: Get the schema information for notification inputs
Syntax:
MicrosoftTeams.GetNotificationInputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Post a choice of options as the Flow bot to a user
Description: Easily automate the process of sending a message to a Teams user that contains a set of options they must choose from before they respond.
Syntax:
MicrosoftTeams.SubscribeUserMessageWithOptions (DynamicUserMessageWithOptionsSubscriptionRequest UserMessageWithOptionsSubscriptionRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
UserMessageWithOptionsSubscriptionRequest |
DynamicUserMessageWithOptionsSubscriptionRequest
|
|
True |
Returns:
Summary: Post an Adaptive Card to a Teams user and wait for a response
Description: Easily automate the process of sending a message to a Teams user that contains actions to continue a waiting flow.
Syntax:
MicrosoftTeams.SubscribeUserFlowContinuation (SubscribeUserFlowContinuationParameterUserFlowContinuationSubscriptionRequest UserFlowContinuationSubscriptionRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
UserFlowContinuationSubscriptionRequest |
SubscribeUserFlowContinuationParameterUserFlowContinuationSubscriptionRequest
|
|
True |
Returns:
Summary: Post an Adaptive Card to a Teams channel and wait for a response
Description: Easily automate the process of sending a message to a Teams channel that contains actions to continue a waiting flow.
Syntax:
MicrosoftTeams.SubscribeChannelFlowContinuation (string groupId, SubscribeChannelFlowContinuationParameterChannelFlowContinuationSubscriptionRequest ChannelFlowContinuationSubscriptionRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
ChannelFlowContinuationSubscriptionRequest |
SubscribeChannelFlowContinuationParameterChannelFlowContinuationSubscriptionRequest
|
|
True |
Returns:
Summary: Unsubscribe from a choice of options
Description: Unsubscribes from a message with options
Syntax:
MicrosoftTeams.UnsubscribeMessageWithOptions (string recipientType, string subscriptionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
|
|
subscriptionId |
string (ID of subscription to be deleted) |
ID of subscription to be deleted |
True |
Returns:
Summary: Unsubscribe from a flow continuation
Description: Unsubscribes from a flow continuation
Syntax:
MicrosoftTeams.UnsubscribeFlowContinuation (string recipientType, string subscriptionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
|
|
subscriptionId |
string (ID of subscription to be deleted) |
ID of subscription to be deleted |
True |
Returns:
Summary: Get message with options input metadata
Description: Get the schema information for the message with options inputs
Syntax:
MicrosoftTeams.GetMessageWithOptionsInputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Get flow continuation input metadata
Description: Get the schema information for the flow continuation inputs
Syntax:
MicrosoftTeams.GetFlowContinuationInputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Get message with options subscription input metadata
Description: Get the schema information for the message with options subscription inputs
Syntax:
MicrosoftTeams.GetMessageWithOptionsSubscriptionInputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Get flow continuation subscription input metadata
Description: Get the schema information for the flow continuation subscription inputs
Syntax:
MicrosoftTeams.GetFlowContinuationSubscriptionInputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Get message with options subscription output metadata
Description: Get the schema information for the message with options subscription outputs.
Syntax:
MicrosoftTeams.GetMessageWithOptionsSubscriptionOutputMetadata (string recipientType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
Returns:
Type:ConnectorMetadata
Summary: Get flow continuation subscription output metadata
Description: Get the schema information for the flow continuation subscription outputs.
Syntax:
MicrosoftTeams.GetFlowContinuationSubscriptionOutputMetadata (string recipientType, string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipientType |
string (Type of the recipient of the action) |
Type of the recipient of the action |
True |
|
|
body |
string (Message) |
|
True |
Returns:
Type:ConnectorMetadata
Summary: Get selected message hybrid trigger output metadata
Description: Get the schema information for the selected message hybrid trigger outputs.
Syntax:
MicrosoftTeams.GetSelectedMessageTriggerOutputsMetadata (string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
string (InputsAdaptiveCard) |
|
True |
Returns:
Type:SelectedMessageTriggerMetadata
Description: Metadata of data coming from Microsoft Teams for a selected message
Summary: Get compose message hybrid trigger output metadata
Description: Get the schema information for the compose message hybrid trigger outputs.
Syntax:
MicrosoftTeams.GetComposeMessageTriggerOutputsMetadata (string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
string (InputsAdaptiveCard) |
|
True |
Returns:
Type:ComposeMessageTriggerMetadata
Description: Metadata of data coming from Microsoft Teams for composing a message
Summary: Get a team
Description: This operation returns details for a team using the team's unique ID.
Syntax:
MicrosoftTeams.GetTeam (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
Returns:
Type:GetTeamResponse
Description: Get team response
Summary: Get @mention token for a user
Description: This operation creates a token that can be inserted into a message or adaptive card to @mention a user.
Syntax:
MicrosoftTeams.AtMentionUser (string userId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userId |
string (User) |
Specify a user principal or user ID to @mention |
True |
Returns:
Type:AtMentionUser_V1
Description: @mention Token
Summary: Shifts: List all Time Off reasons
Description: This operation returns the list of time off reasons associated with a team.
Syntax:
MicrosoftTeams.ListTimeOffReasons (string teamId, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
$top |
integer(int32) (Top Count) |
Total number of Time Off reasons to retrieve |
False |
Returns:
Type:GetTimeOffReasonsResponse
Summary: List of time off reasons associated with a team
Description: The list of Time Off Reasons.
Summary: Shifts: List all shifts
Description: This operation returns all shifts assigned to members of a team
Syntax:
MicrosoftTeams.ListShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
startTime |
string(date-time) (From Start Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
|
endTime |
string(date-time) (To End Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of shifts to retrieve |
False |
Returns:
Type:ListShiftsResponse
Summary: Shifts: Get a shift
Description: This operation returns details for a shift using the shift's unique ID.
Syntax:
MicrosoftTeams.GetShift (string teamId, string shiftId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
shiftId |
string (Shift ID) |
The unique ID of the shift. |
True |
Returns:
Type:ShiftResponse
Summary: Shift
Description: Shift Entity
Summary: Shifts: Delete a shift
Description: This operation deletes a shift using the shift's unique ID.
Syntax:
MicrosoftTeams.DeleteShift (string teamId, string shiftId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
shiftId |
string (Shift ID) |
The unique ID of the shift. |
True |
Returns:
Summary: Shifts: List all Open Shifts
Description: This operation returns all open shifts in a team
Syntax:
MicrosoftTeams.ListOpenShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
startTime |
string(date-time) (From Start Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
|
endTime |
string(date-time) (To End Time) |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
False |
|
|
$top |
integer(int32) (Top Count) |
Total number of open shifts to retrieve |
False |
Returns:
Summary: Shifts: Create a new Open Shift
Description: Create a new open shift in a schedule
Syntax:
MicrosoftTeams.CreateOpenShift (string teamId, EditOpenShiftRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
request |
|
|
True |
Returns:
Type:OpenShiftResponse
Summary: Open Shift
Description: Open Shift Entity
Summary: Shifts: Get an open shift
Description: This operation returns details for an open shift.
Syntax:
MicrosoftTeams.GetOpenShift (string teamId, string openShiftId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
openShiftId |
string (Open Shift ID) |
The unique ID of the open shift. |
True |
Returns:
Type:OpenShiftResponse
Summary: Open Shift
Description: Open Shift Entity
Summary: Shifts: Update an Open Shift
Description: Update an open shift in a schedule.
Syntax:
MicrosoftTeams.UpdateOpenShift (string teamId, string openShiftId, EditOpenShiftRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
openShiftId |
string (Open Shift ID) |
The unique ID of the open shift. |
True |
|
|
request |
|
|
True |
Returns:
Type:OpenShiftResponse
Summary: Open Shift
Description: Open Shift Entity
Summary: Shifts: Delete an open shift
Description: This operation deletes an open shift.
Syntax:
MicrosoftTeams.DeleteOpenShift (string teamId, string openShiftId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
openShiftId |
string (Open Shift ID) |
The unique ID of the open shift. |
True |
Returns:
Summary: Shifts: List all scheduling groups
Description: This operation returns all scheduling groups in a schedule
Syntax:
MicrosoftTeams.ListSchedulingGroups (string teamId, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
$top |
integer(int32) (Top Count) |
Total number of entries to retrieve |
False |
Returns:
Type:ListSchedulingGroupsResponse
Summary: Shifts: Get a scheduling group
Description: This operation returns details for a scheduling group using its unique ID.
Syntax:
MicrosoftTeams.GetSchedulingGroup (string teamId, string schedulingGroupId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
schedulingGroupId |
string (Scheduling Group ID) |
The unique ID of the Scheduling Group. |
True |
Returns:
Summary: Scheduling Group
Description: Scheduling Group Entity
Summary: Shifts: List all Time Off requests
Description: This operation returns all time off requests in a schedule
Syntax:
MicrosoftTeams.ListTimeOffRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
$top |
integer(int32) (Top Count) |
Total number of requests to retrieve |
False |
|
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListTimeOffRequestsResponse
Summary: Shifts: Approve a Time Off request
Description: This operation allows managers to approve a time off request.
Syntax:
MicrosoftTeams.TimeOffRequestApprove (string teamId, string timeOffRequestId, TimeOffRequestApproveParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
timeOffRequestId |
string (Time Off Request ID) |
The unique ID of the time off request |
True |
|
|
request |
TimeOffRequestApproveParameterRequest
|
Manager approves a time off request. |
True |
Returns:
Type:TimeOffRequestApproveResponse
Summary: Shifts: Decline a Time Off request
Description: This operation allows managers to decline a time off request.
Syntax:
MicrosoftTeams.TimeOffRequestDecline (string teamId, string timeOffRequestId, TimeOffRequestDeclineParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
timeOffRequestId |
string (Time Off Request ID) |
The unique ID of the time off request |
True |
|
|
request |
TimeOffRequestDeclineParameterRequest
|
Manager declines a time off request. |
True |
Returns:
Type:TimeOffRequestDeclineResponse
Summary: Shifts: List all Offer Shift requests
Description: This operation returns all offer shift requests in a schedule
Syntax:
MicrosoftTeams.ListOfferShiftRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
$top |
integer(int32) (Top Count) |
Total number of requests to retrieve |
False |
|
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListOfferShiftRequestsResponse
Summary: Shifts: Approve an Offer Shift request
Description: This operation allows recipients/managers to approve an offer shift request.
Syntax:
MicrosoftTeams.OfferShiftRequestApprove (string teamId, string offerShiftRequestId, OfferShiftRequestApproveParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
offerShiftRequestId |
string (Offer Shift Request ID) |
The unique ID of the offer shift request |
True |
|
|
request |
OfferShiftRequestApproveParameterRequest
|
Approve an offer shift request. |
True |
Returns:
Type:OfferShiftRequestApproveResponse
Summary: Shifts: Decline an Offer Shift request
Description: This operation allows users to decline an offer shift request.
Syntax:
MicrosoftTeams.OfferShiftRequestDecline (string teamId, string offerShiftRequestId, OfferShiftRequestDeclineParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
offerShiftRequestId |
string (Offer Shift Request ID) |
The unique ID of the offer shift request |
True |
|
|
request |
OfferShiftRequestDeclineParameterRequest
|
Recipient/Manager declines an offer shift request. |
True |
Returns:
Type:OfferShiftRequestDeclineResponse
Summary: Shifts: List all Swap Shifts requests
Description: This operation returns all swap shifts requests in a schedule
Syntax:
MicrosoftTeams.ListSwapShiftsChangeRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
$top |
integer(int32) (Top Count) |
Total number of requests to retrieve |
False |
|
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListSwapShiftsChangeRequestsResponse
Summary: Shifts: Approve a Swap Shifts request
Description: This operation allows a user to approve a Swap Shifts request.
Syntax:
MicrosoftTeams.SwapShiftsChangeRequestApprove (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestApproveParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
swapShiftsChangeRequestId |
string (Swap Shifts Change Request ID) |
The unique ID of the request |
True |
|
|
request |
SwapShiftsChangeRequestApproveParameterRequest
|
Approve a swap shifts change request. |
True |
Returns:
Type:SwapShiftsChangeRequestApproveResponse
Summary: Shifts: Decline a Swap Shifts request
Description: This operation allows users to decline a swap shifts request.
Syntax:
MicrosoftTeams.SwapShiftsChangeRequestDecline (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestDeclineParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
swapShiftsChangeRequestId |
string (Swap Shifts Change Request ID) |
The unique ID of the request |
True |
|
|
request |
SwapShiftsChangeRequestDeclineParameterRequest
|
Decline a Swap Shifts change request. |
True |
Returns:
Type:SwapShiftsChangeRequestDeclineResponse
Summary: Shifts: List all Open Shift requests
Description: This operation returns all open shift change requests in a schedule
Syntax:
MicrosoftTeams.ListOpenShiftChangeRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
$top |
integer(int32) (Top Count) |
Total number of requests to retrieve |
False |
|
|
state |
string (Request State)Values: [pending, approved, declined] |
Request state filter |
False |
Returns:
Type:ListOpenShiftChangeRequestsResponse
Summary: Shifts: Approve an Open Shift request
Description: This operation allows managers to approve an Open Shift request.
Syntax:
MicrosoftTeams.OpenShiftChangeRequestApprove (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestApproveParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
openShiftChangeRequestId |
string (Open Shift Change Request ID) |
The unique ID of the request |
True |
|
|
request |
OpenShiftChangeRequestApproveParameterRequest
|
Manager approves an open shift change request. |
True |
Returns:
Type:OpenShiftChangeRequestApproveResponse
Summary: Shifts: Decline an Open Shift request
Description: This operation allows managers to decline an open shift request.
Syntax:
MicrosoftTeams.OpenShiftChangeRequestDecline (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestDeclineParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
openShiftChangeRequestId |
string (Open Shift Change Request ID) |
The unique ID of the request |
True |
|
|
request |
OpenShiftChangeRequestDeclineParameterRequest
|
Manager declines an Open Shift change request. |
True |
Returns:
Type:OpenShiftChangeRequestDeclineResponse
Summary: Shifts: Get a schedule's details
Description: This operation returns details of a schedule using the schedule's unique ID.
Syntax:
MicrosoftTeams.GetSchedule (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
Returns:
Type:ScheduleResponse
Description: Schedule Entity
Summary: Create a team
Description: This operation a creates a new team.
Syntax:
MicrosoftTeams.CreateATeam (CreateATeamParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:CreateATeamResponse
Summary: Get Teams async result
Description: This operation gets the result of an asynchronous operation within teams.
Syntax:
MicrosoftTeams.GetTeamsAsyncResult ()
Returns:
Type:CreateATeamResponse
Summary: Add a member to a team
Description: This operation adds a member to a team.
Syntax:
MicrosoftTeams.AddMemberToTeam (string teamId, AddMemberToTeamParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team) |
Add Team ID |
True |
|
|
body |
|
|
True |
Returns:
Summary: Post message in a chat or channel
Description: This operation posts a message to a chat or a channel.
Syntax:
MicrosoftTeams.PostMessageToConversation (string poster, string location, DynamicPostMessageRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
|
|
body |
|
|
True |
Returns:
Type:PostToConversationResponse
Summary: Reply with a message in a channel
Description: This operation replies with a message in a channel.
Syntax:
MicrosoftTeams.ReplyWithMessageToConversation (string poster, string location, DynamicReplyMessageRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
|
|
body |
|
|
True |
Returns:
Type:PostToConversationResponse
Summary: Post adaptive card in a chat or channel
Description: This operation posts an adaptive card to a chat or a channel.
Syntax:
MicrosoftTeams.PostCardToConversation (string poster, string location, DynamicPostCardRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
|
|
body |
|
|
True |
Returns:
Type:PostToConversationResponse
Summary: Post adaptive card and wait for a response
Description: This operation posts an adaptive card to a chat or a channel and waits for a response.
Syntax:
MicrosoftTeams.PostCardAndWaitForResponse (string poster, string location, PostCardAndWaitForResponseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
|
|
body |
PostCardAndWaitForResponseParameterBody
|
|
True |
Returns:
Type:PostToConversationResponse
Summary: Reply with adaptive card in a channel
Description: This operation replies with an adaptive card to a channel.
Syntax:
MicrosoftTeams.ReplyWithCardToConversation (string poster, string location, DynamicReplyCardRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
|
|
body |
|
|
True |
Returns:
Type:PostToConversationResponse
Summary: Conversation location for where to post
Description: Returns a list of locations to post a message based on who the user is posting as
Syntax:
MicrosoftTeams.GetPostMessageLocations (string poster)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
Returns:
Type:GetPostMessageLocationsResponse
Summary: Conversation location for where to reply
Description: Returns a list of locations to reply to a message based on who the user is posting as
Syntax:
MicrosoftTeams.GetReplyLocations (string poster)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
Returns:
Type:GetReplyLocationsResponse
Summary: Get message input metadata
Description: Get the schema information for message inputs
Syntax:
MicrosoftTeams.GetPostMessageInputSchema (string poster, string location)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
Returns:
Type:PostMessageSchema
Summary: Get reply to message input metadata
Description: Get the schema information for reply to message inputs
Syntax:
MicrosoftTeams.GetReplyWithMessageInputSchema (string poster, string location)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
Returns:
Type:PostMessageSchema
Summary: Get adaptive card input metadata
Description: Get the schema information for adaptive card inputs
Syntax:
MicrosoftTeams.GetPostCardInputSchema (string poster, string location)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
Returns:
Type:PostCardSchema
Summary: Get reply with adaptive card input metadata
Description: Get the schema information for reply with adaptive card inputs
Syntax:
MicrosoftTeams.GetReplyWithCardInputSchema (string poster, string location)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
Returns:
Type:PostCardSchema
Summary: Get adaptive card input metadata
Description: Get the schema information for adaptive card inputs
Syntax:
MicrosoftTeams.GetPostCardAndWaitInputSchema (string poster, string location)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
poster |
string (Post as)Values: [Flow bot, User] |
Select an option |
True |
|
|
location |
string (Post in) |
Select an option |
True |
Returns:
Summary: When a new channel message is added
Description: This operation triggers when a new message is posted to a channel in a Team. Note that this trigger only fires when a root messages is added in the channel. Replies to an existing channel message will not result in the trigger event firing.
Syntax:
MicrosoftTeams.OnNewChannelMessage (string groupId, string channelId, [internal][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
$top |
integer(int32) (Top) |
|
False |
Returns:
Type:array of (ValueItem)
Summary: Message List
Description: List of one or more messages for a specific channel in a Team.
Summary: When I am mentioned in a channel message
Description: This operation triggers when a new message is added to a channel in a Team, that mentions the current user.
Syntax:
MicrosoftTeams.OnNewChannelMessageMentioningMe (string groupId, string channelId, [internal][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
channelId |
string (Channel) |
Add Teams channel ID |
True |
|
|
$top |
integer(int32) (Top) |
|
False |
Returns:
Type:array of (ValueItem)
Summary: Message List
Description: List of one or more messages for a specific channel in a Team.
Summary: For a selected message
Description: For internal use with the on selected message hybrid trigger.
Syntax:
MicrosoftTeams.ForASelectedMessage ([Optional]string inputsAdaptiveCard, [advanced][Optional]integer taskModuleWidth, [advanced][Optional]integer taskModuleHeight)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputsAdaptiveCard |
string (Inputs Adaptive Card) |
|
False |
|
|
taskModuleWidth |
integer(int32) (Dialog width (px)) |
|
False |
|
|
taskModuleHeight |
integer(int32) (Dialog height (px)) |
|
False |
Returns:
Type:ForASelectedMessageResponse
Summary: From the compose box
Description: For internal use with the compose message hybrid trigger.
Syntax:
MicrosoftTeams.ComposeAMessage ([Optional]string inputsAdaptiveCard, [advanced][Optional]integer taskModuleWidth, [advanced][Optional]integer taskModuleHeight)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputsAdaptiveCard |
string (Inputs Adaptive Card) |
|
False |
|
|
taskModuleWidth |
integer(int32) (Dialog width (px)) |
|
False |
|
|
taskModuleHeight |
integer(int32) (Dialog height (px)) |
|
False |
Returns:
Summary: When a new team member is removed
Description: This operation triggers when a member is removed from the given team.
Syntax:
MicrosoftTeams.OnGroupMembershipRemoval (string groupId, [internal][Optional]string $select)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
$select |
string (Select) |
|
False |
Returns:
Type:array of (OnGroupMembershipRemovalResponseItem)
Description: value
Summary: When a new team member is added
Description: This operation triggers when a member is added to the given team.
Syntax:
MicrosoftTeams.OnGroupMembershipAdd (string groupId, [internal][Optional]string $select)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Team) |
Add Team ID |
True |
|
|
$select |
string (Select) |
|
False |
Returns:
Type:array of (OnGroupMembershipRemovalResponseItem)
Description: value
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userId |
string A user AAD ID for the user to add to a team |
User AAD ID to add |
|
owner |
boolean Should the newly added user be an owner of the team |
The new member should be an owner |
Summary:
Description: @mention Token
Properties:
|
Name |
Type |
Summary |
|
atMention |
string @mention |
An @mention token for the user. This property can be inserted into messages and adaptive cards. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Metadata of data coming from Microsoft Teams for composing a message
Properties:
|
Name |
Type |
Summary |
|
TeamsFlowRunContext |
|
|
|
CardOutputs |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
metadatatype |
string
|
|
|
activitytype |
string
|
|
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Team Name |
Name of the team |
|
description |
string Description |
Description of the team |
|
visibility |
string Visibility |
The visibility of the the team Values: [Private, Public] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
newTeamId |
string New Team ID |
Team ID of the team that was just created |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
More information about the channel. |
|
displayName |
string Display Name |
Name of the channel. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
More information about the channel. |
|
displayName |
string Display Name |
Name of the channel. |
|
id |
string Id |
Unique ID of the channel. |
Summary:
Description: Guest Settings Entity
Properties:
|
Name |
Type |
Summary |
|
showInTeamsSearchAndSuggestions |
boolean Show In Teams Search And Suggestions |
Show In Teams Search And Suggestions |
Summary: Draft Open Shift
Description: Preliminary version of the open shift
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Display Name |
Display Name |
|
notes |
string Notes |
Notes |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
theme |
string Theme |
Theme |
|
openSlotCount |
integer Open Slot Count |
Open Slot Count |
|
activities |
array of (ActivitiesItem)
|
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
|
Name |
Type |
Summary |
|
isPaid |
boolean Is Paid |
Is Paid |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
code |
string Code |
Code |
|
displayName |
string Display Name |
Display Name |
Summary: Draft Shift
Description: Preliminary version of the shift
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Display Name |
Display Name |
|
notes |
string Notes |
Notes |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
theme |
string Theme |
Theme |
|
activities |
array of (ActivitiesItem)
|
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
|
Name |
Type |
Summary |
|
isPaid |
boolean Is Paid |
Is Paid |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
code |
string Code |
Code |
|
displayName |
string Display Name |
Display Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schedulingGroupId |
string Scheduling Group ID |
Scheduling Group ID |
|
sharedOpenShift |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Display Name |
Display Name |
|
notes |
string Notes |
Notes |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
theme |
string Theme |
Theme Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow] |
|
openSlotCount |
integer Open Slot Count |
Open Slot Count |
|
activities |
array of (ActivitiesItem)
|
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
|
Name |
Type |
Summary |
|
isPaid |
boolean Is Paid |
Is Paid |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
code |
string Code |
Code |
|
displayName |
string Display Name |
Display Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Guest Settings Entity
Properties:
|
Name |
Type |
Summary |
|
allowGiphy |
boolean Allow Giphy |
Allow Giphy |
|
giphyContentRating |
string Giphy Content Rating |
Giphy Content Rating |
|
allowStickersAndMemes |
boolean Allow Stickers And Memes |
Allow Stickers And Memes |
|
allowCustomMemes |
boolean Allow Custom Memes |
Allow Custom Memes |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (ValueItem) Teams List |
List of one or more Teams you are a part of. |
Summary: Team
Description: Team Entity
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
More information about the Team. |
|
displayName |
string Name |
Brief summary of the Team. |
|
id |
string Id |
Unique ID of the Team (O365 group). |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (ValueItem) Channel List |
List of one or more channels for a specific Team. |
Summary: Channel
Description: Properties associated with a single channel.
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
More information about the channel. |
|
displayName |
string Name |
Brief summary of the channel. |
|
id |
string Id |
Unique ID of the channel. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string @odata.context |
@odata.context |
|
@odata.count |
integer(int32) @odata.count |
@odata.count |
|
@odata.nextLink |
string @odata.nextLink |
@odata.nextLink |
|
value |
array of (ValueItem) Message List |
List of one or more messages for a specific channel in a Team. |
Summary: Message
Description: Properties associated with a single message.
Properties:
|
Name |
Type |
Summary |
|
attachments |
array of (AttachmentsItem) attachments |
attachments |
|
body |
body |
Plaintext representation of the content of the message. |
|
createdDateTime |
string(date-time) createdDateTime |
createdDateTime |
|
deleted |
boolean deleted |
deleted |
|
etag |
string etag |
etag |
|
from |
from |
from |
|
id |
string id |
Unique ID of the message. |
|
importance |
string importance |
importance |
|
lastModifiedDateTime |
string lastModifiedDateTime |
lastModifiedDateTime |
|
locale |
string locale |
locale |
|
mentions |
array of (MentionsItem) mentions |
mentions |
|
messageType |
string messageType |
messageType |
|
reactions |
array of (ReactionsItem) reactions |
reactions |
|
replyToId |
string replyToId |
ID of the parent message of the thread |
|
subject |
string subject |
Message subject line. Optional. |
|
summary |
string summary |
Summary text of the message that could be used for push notifications and summary views or fall back views. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: body
Description: Plaintext representation of the content of the message.
Properties:
|
Name |
Type |
Summary |
|
content |
string content |
content |
|
contentType |
string contentType |
contentType |
Summary: from
Description: from
Properties:
|
Name |
Type |
Summary |
|
application |
application |
application |
|
device |
string device |
device |
|
user |
user |
user |
Summary: application
Description: application
Properties:
|
Name |
Type |
Summary |
Summary: user
Description: user
Properties:
|
Name |
Type |
Summary |
|
displayName |
string displayName |
displayName |
|
id |
string id |
ID |
|
identityProvider |
string identityProvider |
identityProvider |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
locations |
array of (LocationsItem)
|
valid locations to post a message, make verbose |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
locations |
array of (LocationsItem)
|
valid locations to reply with a message, make verbose |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Get team response
Properties:
|
Name |
Type |
Summary |
|
id |
string Team ID |
The unique ID of the team. |
|
displayName |
string Display Name |
The name of the team. |
|
description |
string Description of team |
The description of the Team. |
|
internalId |
string Internal Id |
The Internal Id of the Team. |
|
webUrl |
string Web Url of team |
The Web Url of the Team. |
|
isArchived |
boolean Is Archived |
Is Archived |
|
memberSettings |
|
Member Settings Entity |
|
guestSettings |
|
Guest Settings Entity |
|
messagingSettings |
|
Messaging Settings Entity |
|
funSettings |
|
Guest Settings Entity |
|
discoverySettings |
|
Guest Settings Entity |
Summary: List of time off reasons associated with a team
Description: The list of Time Off Reasons.
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (ValueItem) Array containing time off reasons |
The list of time off reasons. |
Summary: Single time off reason.
Description: Time off reason.
Properties:
|
Name |
Type |
Summary |
|
id |
string Time Off Reason ID |
The unique ID of the time off reason. |
|
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
displayName |
string Display Name |
Display Name |
|
iconType |
string Icon Type |
Icon Type |
|
isActive |
boolean Is Active |
Is Active |
|
lastModifiedBy |
Last Modified By |
Last Modified By |
Summary:
Description: Guest Settings Entity
Properties:
|
Name |
Type |
Summary |
|
allowCreateUpdateChannels |
boolean Allow Create Update Channels |
Allow to create and update channels |
|
allowDeleteChannels |
boolean Allow Delete Channels |
Allow to delete channels |
Summary: Last Modified By
Description: Last Modified By
Properties:
|
Name |
Type |
Summary |
|
application |
string Application |
Application |
|
device |
string Device |
Device |
|
conversation |
string Conversation |
Conversation |
|
user |
User |
User |
Summary: User
Description: User
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Id |
|
displayName |
string Display Name |
Display Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (OfferShiftRequestResponse) Offer Shift Requests List |
List of Offer Shift requests in the schedule |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (OpenShiftChangeRequestResponse) Open Shift Change Requests List |
List of Open Shift Change Requests in the schedule |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (OpenShiftResponse) Open Shifts List |
List of open shifts in the schedule |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (SchedulingGroupResponse) Scheduling Groups List |
List of schedule groups in the schedule |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (ShiftResponse) Shifts List |
List of shifts in the schedule |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (SwapShiftsChangeRequestResponse) Swap Shifts Change Requests List |
List of Swap Shifts Change Requests in the schedule |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
|
|
value |
array of (TimeOffRequestResponse) TimeOff Requests List |
List of Time Off requests in the schedule |
Summary:
Description: Member Settings Entity
Properties:
|
Name |
Type |
Summary |
|
allowCreateUpdateChannels |
boolean Allow Create Update Channels |
Allow to create and update channels |
|
allowDeleteChannels |
boolean Allow Delete Channels |
Allow to delete channels |
|
allowAddRemoveApps |
boolean Allow Add Remove Apps |
Allow to add and remove apps |
|
allowCreateUpdateRemoveTabs |
boolean Allow Create Update Remove Tabs |
Allow to create, update and remove tabs |
|
allowCreateUpdateRemoveConnectors |
boolean Allow Create Update Remove Connectors |
Allow to create, update and remove connectors |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Message Id |
Unique Message Id |
Summary:
Description: Messaging Settings Entity
Properties:
|
Name |
Type |
Summary |
|
allowUserEditMessages |
boolean Allow User Edit Messages |
Allow User Edit Messages |
|
allowUserDeleteMessages |
boolean Allow User Delete Messages |
Allow User Delete Messages |
|
allowOwnerDeleteMessages |
boolean Allow Owner Delete Messages |
Allow Owner Delete Messages |
|
allowTeamMentions |
boolean Allow Team Mentions |
Allow Team Mentions |
|
allowChannelMentions |
boolean Allow Channel Mentions |
Allow Channel Mentions |
Summary:
Description: New meeting event model
Properties:
|
Name |
Type |
Summary |
|
subject |
string Subject |
Event subject |
|
body |
|
body |
|
timeZone |
string
|
Time zone of the event Values: [, Pacific Standard Time, Central Standard Time, U.S. Eastern Standard Time, Dateline Standard Time, Samoa Standard Time, Hawaiian Standard Time, Alaskan Standard Time, Mountain Standard Time, Mexico Standard Time 2, U.S. Mountain Standard Time, Canada Central Standard Time, Mexico Standard Time, Central America Standard Time, Eastern Standard Time, S.A. Pacific Standard Time, Atlantic Standard Time, S.A. Western Standard Time, Pacific S.A. Standard Time, Newfoundland and Labrador Standard Time, E. South America Standard Time, S.A. Eastern Standard Time, Greenland Standard Time, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, GMT Standard Time, Greenwich Standard Time, Central Europe Standard Time, Central European Standard Time, Romance Standard Time, W. Europe Standard Time, W. Central Africa Standard Time, E. Europe Standard Time, Egypt Standard Time, FLE Standard Time, GTB Standard Time, Israel Standard Time, South Africa Standard Time, Russian Standard Time, Arab Standard Time, E. Africa Standard Time, Arabic Standard Time, Iran Standard Time, Arabian Standard Time, Caucasus Standard Time, Transitional Islamic State of Afghanistan Standard Time, Ekaterinburg Standard Time, West Asia Standard Time, India Standard Time, Nepal Standard Time, Central Asia Standard Time, Sri Lanka Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, S.E. Asia Standard Time, North Asia Standard Time, China Standard Time, Singapore Standard Time, Taipei Standard Time, W. Australia Standard Time, North Asia East Standard Time, Korea Standard Time, Tokyo Standard Time, Yakutsk Standard Time, A.U.S. Central Standard Time, Cen. Australia Standard Time, A.U.S. Eastern Standard Time, E. Australia Standard Time, Tasmania Standard Time, Vladivostok Standard Time, West Pacific Standard Time, Central Pacific Standard Time, Fiji Islands Standard Time, New Zealand Standard Time, Tonga Standard Time, Azerbaijan Standard Time, Middle East Standard Time, Jordan Standard Time, Central Standard Time (Mexico), Mountain Standard Time (Mexico), Pacific Standard Time (Mexico), Namibia Standard Time, Georgian Standard Time, Central Brazilian Standard Time, Montevideo Standard Time, Armenian Standard Time, Venezuela Standard Time, Argentina Standard Time, Morocco Standard Time, Pakistan Standard Time, Mauritius Standard Time, UTC, Paraguay Standard Time, Kamchatka Standard Time] |
|
start |
|
|
|
end |
|
|
|
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 |
|
location |
|
Location |
|
importance |
string Importance |
The importance of the event: low, normal or high Values: [low, normal, high] |
|
recurrence |
|
The recurrence pattern for the meeting |
|
isAllDay |
boolean Is all day event? |
Set to true if the event lasts all day |
|
reminderMinutesBeforeStart |
integer Reminder |
Time in minutes before event start to remind |
|
isReminderOn |
boolean Is reminder on |
Set to true if an alert is set to remind the user of the event. |
|
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. |
|
isOnlineMeeting |
boolean Online Meeting Enabled |
isOnlineMeeting |
|
onlineMeetingProvider |
string Online Meeting Provider |
onlineMeetingProvider |
Summary:
Description: body
Properties:
|
Name |
Type |
Summary |
|
content |
string Message |
Body of the message. |
|
contentType |
string Type |
Content type: html or text. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dateTime |
string(date-no-tz) Start time |
Start time of the event (example: '2017-08-29T04:00:00') |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dateTime |
string(date-no-tz) End time |
End time of the event (example: '2017-08-29T05:00:00') |
Summary:
Description: Location
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Location |
Location |
Summary:
Description: The recurrence pattern for the meeting
Properties:
|
Name |
Type |
Summary |
|
pattern |
|
|
|
range |
|
The recurrence pattern for the meeting |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string Recurrence pattern |
Pattern for the recurrence. Required when meeting is a recurrence Values: [, daily, weekly, relativeMonthly, relativeYearly] |
|
interval |
integer(int32) Number of recurrences |
Number of recurrences. Required when meeting is a recurrence |
|
daysOfWeek |
array of (string) Days of week |
Comma separated days of weeks (example: 'Monday,Wednesday,Friday') |
Summary:
Description: The recurrence pattern for the meeting
Properties:
|
Name |
Type |
Summary |
|
startDate |
string(date) Recurrence start date |
Start Date of the recurrence, format YYYY-MM-DD. Required when meeting is a recurrence |
|
endDate |
string(date) Recurrence end date |
End Date of the recurrence, format YYYY-MM-DD |
Summary:
Description: Response for new meeting that was created
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id |
|
createdDateTime |
string
|
Created DateTime |
|
lastModifiedDateTime |
string
|
Last Modified DateTime |
|
categories |
array of (CategoriesItem)
|
Categories |
|
timeZone |
string
|
Time Zone |
|
reminderMinutesBeforeStart |
integer(int32)
|
Reminder Minutes Before Start |
|
isReminderOn |
boolean
|
Is Reminder On |
|
hasAttachments |
boolean
|
Has Attachments |
|
subject |
string
|
Subject |
|
bodyPreview |
string
|
Body Preview |
|
importance |
string
|
Importance |
|
sensitivity |
string
|
Sensitivity |
|
isAllDay |
boolean
|
Is All Day |
|
isCancelled |
boolean
|
Is Cancelled |
|
isOrganizer |
boolean
|
Is Organizer |
|
responseRequested |
boolean
|
Response Requested |
|
showAs |
string
|
Show As |
|
type |
string
|
Type |
|
webLink |
string
|
Web Link |
|
onlineMeetingUrl |
string
|
Online Meeting Url |
|
allowNewTimeProposals |
boolean
|
Allow New Time Proposals |
|
recurrence |
|
Recurrence |
|
responseStatus |
|
Response Status |
|
body |
|
Body |
|
start |
|
Start |
|
end |
|
End |
|
location |
|
Location |
|
attendees |
array of (AttendeesItem)
|
Attendees |
|
organizer |
|
Organizer |
|
onlineMeeting |
|
Online Meeting |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Recurrence
Properties:
|
Name |
Type |
Summary |
|
pattern |
|
Recurrence Pattern |
|
range |
|
Recurrence Range |
Summary:
Description: Recurrence Pattern
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Recurrence Range
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Response Status
Properties:
|
Name |
Type |
Summary |
|
response |
string
|
Response |
|
time |
string
|
Time |
Summary:
Description: Body
Properties:
|
Name |
Type |
Summary |
|
contentType |
string
|
Content Type |
|
content |
string
|
Content |
Summary:
Description: Start
Properties:
|
Name |
Type |
Summary |
|
dateTime |
string
|
DateTime |
Summary:
Description: End
Properties:
|
Name |
Type |
Summary |
|
dateTime |
string
|
DateTime |
Summary:
Description: Location
Properties:
|
Name |
Type |
Summary |
|
displayName |
string
|
Display Name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
Type |
|
status |
|
Status |
|
emailAddress |
|
Email Address |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
response |
string
|
Response |
|
time |
string
|
Time |
Summary:
Description: Email Address
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name |
|
address |
string
|
Address |
Summary:
Description: Organizer
Properties:
|
Name |
Type |
Summary |
|
emailAddress |
|
Email Address |
Summary:
Description: Email Address
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name |
|
address |
string
|
Address |
Summary:
Description: Online Meeting
Properties:
|
Name |
Type |
Summary |
|
joinUrl |
string
|
Join Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Approve an offer shift request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Recipient/Manager |
A message when a request is accepted. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Recipient/Manager declines an offer shift request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Recipient/Manager |
A message when a request is declined. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Offer Shift Request
Description: Offer Shift Request Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the Offer Shift request. |
|
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' |
|
state |
string State |
'approved', 'pending' or 'declined' |
|
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
|
senderMessage |
string Sender Message |
The message from the request sender |
|
senderUserId |
string Sender ID |
The ID of the user that sent the request |
|
senderShiftId |
string Sender Shift ID |
The ID of the shift from the sender |
|
recipientActionDateTime |
string(date-time) Receiver Time |
Time when the recipient responded |
|
recipientActionMessage |
string Recipient Message |
The message from the recipient |
|
recipientUserId |
string Recipient ID |
The ID of the recipient of the request |
|
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
|
managerActionMessage |
string Manager Message |
The message from the manager |
|
managerUserId |
string Manager ID |
The ID of the manager that responded |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string User Id |
Unique id of the user. |
Summary:
Description: Manager approves an open shift change request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is accepted. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Manager declines an Open Shift change request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is declined. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Open Shift Change Request
Description: Open Shift Change Request Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the Open Shift Change request. |
|
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' |
|
state |
string State |
'approved', 'pending' or 'declined' |
|
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
|
senderMessage |
string Sender Message |
The message from the request sender |
|
senderUserId |
string Sender ID |
The ID of the user that sent the request |
|
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
|
managerActionMessage |
string Manager Message |
The message from the manager |
|
managerUserId |
string Manager ID |
The ID of the manager that responded |
|
openShiftId |
string Open Shift ID |
The ID of the open shift being requested |
Summary: Open Shift
Description: Open Shift Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the open shift. |
|
createdDateTime |
string(date-time) Created Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
schedulingGroupId |
string Scheduling Group ID |
Scheduling Group ID |
|
lastModifiedBy |
Last Modified By |
Last Modified By |
|
sharedOpenShift |
Shared Open Shift |
Shared version of the open shift |
|
draftOpenShift |
Draft Open Shift |
Preliminary version of the open shift |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
notificationUrl |
string
|
|
|
body |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipient |
|
|
|
messageBody |
string Message |
|
|
updateMessage |
string Update message |
Message to show as an update in the original card following response |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
rootMessage |
|
rootMessage |
Summary:
Description: rootMessage
Properties:
|
Name |
Type |
Summary |
|
body |
|
body |
Summary:
Description: body
Properties:
|
Name |
Type |
Summary |
|
content |
string(html) Message |
Body of the message. |
|
contentType |
integer(int32) Type |
0 for text or 1 for html. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
subject |
string Subject |
Subject of the message. |
|
body |
|
body |
Summary:
Description: body
Properties:
|
Name |
Type |
Summary |
|
content |
string Message |
Body of the message. |
|
contentType |
string Type |
Content type: html or text. Values: [html, text] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
subject |
string Subject |
Subject of the message. |
|
body |
|
body |
Summary:
Description: body
Properties:
|
Name |
Type |
Summary |
|
content |
string(html) Message |
Body of the message. |
|
contentType |
string Type |
Content type: html or text. Values: [html, text] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
subject |
string Subject |
Subject of the message. |
|
body |
|
body |
Summary:
Description: body
Properties:
|
Name |
Type |
Summary |
|
content |
string Reply |
Body of the message. |
|
contentType |
string Type |
Content type: html or text. Values: [html, text] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
subject |
string Subject |
Subject of the message. |
|
body |
|
body |
Summary:
Description: body
Properties:
|
Name |
Type |
Summary |
|
content |
string(html) Reply |
Body of the message. |
|
contentType |
string Type |
Content type: html or text. Values: [html, text] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Message Id |
Unique Message Id |
|
messageLink |
string Message Link |
Link to the message |
Summary:
Description: Schedule Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string Schedule ID |
The unique ID of the schedule. |
|
timeZone |
string Schedule Time Zone |
The Time Zone of the schedule. |
|
provisionStatus |
string Schedule Provision Status |
The Provision Status of the schedule. |
|
provisionStatusCode |
string Schedule Provision Status Code |
The Provision Status Code of the schedule. |
Summary: Scheduling Group
Description: Scheduling Group Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the scheduling group. |
|
displayName |
string Display Name |
The display name for the scheduling group. |
|
isActive |
boolean Is Active |
Indicates whether the scheduling group can be used when creating new entities or updating existing ones. |
|
userIds |
array of (string) User IDs |
List of IDs of users in the scheduling group. |
Summary:
Description: Metadata of data coming from Microsoft Teams for a selected message
Properties:
|
Name |
Type |
Summary |
|
TeamsFlowRunContext |
|
|
|
CardOutputs |
|
|
Summary: Shared Open Shift
Description: Shared version of the open shift
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Display Name |
Display Name |
|
notes |
string Notes |
Notes |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
theme |
string Theme |
Theme |
|
openSlotCount |
integer Open Slot Count |
Open Slot Count |
|
activities |
array of (ActivitiesItem)
|
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
|
Name |
Type |
Summary |
|
isPaid |
boolean Is Paid |
Is Paid |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
code |
string Code |
Code |
|
displayName |
string Display Name |
Display Name |
Summary: Shared Shift
Description: Shared version of the shift
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Display Name |
Display Name |
|
notes |
string Notes |
Notes |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
theme |
string Theme |
Theme |
|
activities |
array of (ActivitiesItem)
|
Shift activities |
Summary: Activity
Description: Shift activity
Properties:
|
Name |
Type |
Summary |
|
isPaid |
boolean Is Paid |
Is Paid |
|
startDateTime |
string(date-time) From Start Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
endDateTime |
string(date-time) To End Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
code |
string Code |
Code |
|
displayName |
string Display Name |
Display Name |
Summary: Shift
Description: Shift Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the shift. |
|
createdDateTime |
string(date-time) Created Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
userId |
string Assigned To User ID |
Assigned To User ID |
|
schedulingGroupId |
string Scheduling Group ID |
Scheduling Group ID |
|
lastModifiedBy |
Last Modified By |
Last Modified By |
|
sharedShift |
Shared Shift |
Shared version of the shift |
|
draftShift |
Draft Shift |
Preliminary version of the shift |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
notificationUrl |
string
|
|
|
body |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
updateMessage |
string Update message |
Message to be included in an update to the original card following response |
|
shouldUpdateCard |
boolean Should update card |
Whether or not to update the card following response |
|
recipient |
|
|
|
messageBody |
string Message |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
groupId |
string
|
|
|
channelId |
string Channel |
Add Teams channel ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
notificationUrl |
string
|
|
|
body |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
updateMessage |
string Update message |
Message to be included in an update to the original card following response |
|
shouldUpdateCard |
boolean Should update card |
Whether or not to update the card following response |
|
recipient |
|
|
|
messageBody |
string Message |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
string Recipient |
Add an email address |
|
summary |
string Summary |
The message summary |
|
isAlert |
boolean IsAlert |
If the message will be shown in the activity feed |
Summary:
Description: Approve a swap shifts change request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Recipient/Manager |
A message when a request is accepted. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Decline a Swap Shifts change request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Recipient/Manager |
A message when a request is declined. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Swap Shift Request
Description: Swap Shift Request Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the Swap Shift request. |
|
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' |
|
state |
string State |
'approved', 'pending' or 'declined' |
|
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
|
senderMessage |
string Sender Message |
The message from the request sender |
|
senderUserId |
string Sender ID |
The ID of the user that sent the request |
|
senderShiftId |
string Sender Shift ID |
The ID of the shift from the sender |
|
recipientActionDateTime |
string(date-time) Receiver Time |
Time when the recipient responded |
|
recipientActionMessage |
string Recipient Message |
The message from the recipient |
|
recipientUserId |
string Recipient ID |
The ID of the recipient of the request |
|
recipientShiftId |
string Recipient Shift ID |
The ID of the shift from the recipient |
|
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
|
managerActionMessage |
string Manager Message |
The message from the manager |
|
managerUserId |
string Manager ID |
The ID of the manager that responded |
Summary:
Description: Manager approves a time off request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is accepted. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Manager declines a time off request.
Properties:
|
Name |
Type |
Summary |
|
message |
string Message From Manager |
A message from the manager to the sender/recipient when a request is declined. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: TimeOff Request
Description: TimeOff Request Entity
Properties:
|
Name |
Type |
Summary |
|
id |
string ID |
The unique ID of the TimeOff request. |
|
createdDateTime |
string(date-time) Created Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
lastModifiedDateTime |
string(date-time) Modified Time |
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
|
assignedTo |
string Assigned To |
The person the request is assigned to: 'manager' or 'recipient' |
|
state |
string State |
'approved', 'pending' or 'declined' |
|
senderDateTime |
string(date-time) Sender Time |
Time when the request was sent |
|
senderMessage |
string Sender Message |
The message from the request sender |
|
senderUserId |
string Sender ID |
The ID of the user that sent the request |
|
managerActionDateTime |
string(date-time) Manager Action Time |
Time when the manager responded |
|
managerActionMessage |
string Manager Message |
The message from the manager |
|
managerUserId |
string Manager ID |
The ID of the manager that responded |
|
startDateTime |
string(date-time) From Start Time |
Start of time requested off |
|
endDateTime |
string(date-time) To End Time |
End of time requested off |
|
timeOffReasonId |
string TimeOff Reason ID |
The ID of the TimeOff Reason |