Connectors Reference

Shifts for Microsoft Teams

For managers, plan shift schedules, broadcast open and unfilled shifts to your team. For team members, easily view your shifts and make schedule-change requests (swap/offer/time off).

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetAllTeams ()

List teams

GetSchedule (string teamId)

Get a Schedule's details

ListTimesOff (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)

List all Time Off instances

GetTimeOff (string teamId, string timeOffId)

Get a Time Off instance

DeleteTimeOff (string teamId, string timeOffId)

Delete a Time Off instance

ListShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)

List all Shifts

GetShift (string teamId, string shiftId)

Get a Shift

DeleteShift (string teamId, string shiftId)

Delete a Shift

ListOpenShifts (string teamId, [advanced][Optional]string startTime, [advanced][Optional]string endTime, [advanced][Optional]integer $top)

List all Open Shifts

CreateOpenShift (string teamId, EditOpenShiftRequest request)

Create a new Open Shift

GetOpenShift (string teamId, string openShiftId)

Get an Open Shift

UpdateOpenShift (string teamId, string openShiftId, EditOpenShiftRequest request)

Update an Open Shift

DeleteOpenShift (string teamId, string openShiftId)

Delete an Open Shift

ListTimeOffReasons (string teamId, [advanced][Optional]integer $top)

List all Time Off Reasons

ListSchedulingGroups (string teamId, [advanced][Optional]integer $top)

List all Scheduling Groups

GetSchedulingGroup (string teamId, string schedulingGroupId)

Get a Scheduling Group

ListTimeOffRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)

List all Time Off requests

GetTimeOffShiftRequest (string teamId, string timeOffRequestId)

Get a Time Off request

TimeOffRequestApprove (string teamId, string timeOffRequestId, TimeOffRequestApproveParameterRequest request)

Approve a Time Off request

TimeOffRequestDecline (string teamId, string timeOffRequestId, TimeOffRequestDeclineParameterRequest request)

Decline a Time Off request

ListOfferShiftRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)

List all Offer Shift requests

GetOfferShiftRequest (string teamId, string offerShiftRequestId)

Get an Offer Shift request

OfferShiftRequestApprove (string teamId, string offerShiftRequestId, OfferShiftRequestApproveParameterRequest request)

Approve an Offer Shift request

OfferShiftRequestDecline (string teamId, string offerShiftRequestId, OfferShiftRequestDeclineParameterRequest request)

Decline an Offer Shift request

ListSwapShiftsChangeRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)

List all Swap Shifts requests

GetSwapShiftsChangeRequest (string teamId, string swapShiftsChangeRequestId)

Get a Swap Shifts request

SwapShiftsChangeRequestApprove (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestApproveParameterRequest request)

Approve a Swap Shifts request

SwapShiftsChangeRequestDecline (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestDeclineParameterRequest request)

Decline a Swap Shifts request

ListOpenShiftChangeRequests (string teamId, [advanced][Optional]integer $top, [advanced][Optional]string state)

List all Open Shift requests

GetOpenShiftChangeRequest (string teamId, string openShiftChangeRequestId)

Get an Open Shift request

OpenShiftChangeRequestApprove (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestApproveParameterRequest request)

Approve an Open Shift request

OpenShiftChangeRequestDecline (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestDeclineParameterRequest request)

Decline an Open Shift request

DeleteWebHookSubscription (string subscriptionId)

Delete WebHook Subscription

RenewWebHookSubscription (string subscriptionId, [Optional]RenewWebHookSubscriptionParameterBody body)

Update subscription

WebhookResponse ()

Proxy endpoint to validate subscriptions and forward notifications

 

Triggers:

Name

Summary

TriggerForOpenShiftChangeRequests (string teamId, WebHookRequest request)

When an Open Shift request is created, updated or deleted

TriggerForSwapShiftsChangeRequests (string teamId, WebHookRequest request)

When a Swap Shifts request is created, updated or deleted

TriggerForOfferShiftRequests (string teamId, WebHookRequest request)

When an Offer Shift request is created, updated or deleted

TriggerForTimeOffRequests (string teamId, WebHookRequest request)

When a Time Off request is created, updated or deleted

TriggerForShifts (string teamId, WebHookRequest request)

When a Shift is created, updated or deleted

 

Objects:

Name

Summary

DraftOpenShift

Draft Changes >

DraftShift

Draft Changes >

DraftTimeOff

Draft Changes >

EditOpenShiftRequest

 

GetAllTeamsResponse

 

GetTimeOffReasonsResponse

List of Time Off Reasons associated with a team

ListOfferShiftRequestsResponse

 

ListOpenShiftChangeRequestsResponse

 

ListOpenShiftsResponse

 

ListSchedulingGroupsResponse

 

ListShiftsResponse

 

ListSwapShiftsChangeRequestsResponse

 

ListTimeOffRequestsResponse

 

ListTimesOffResponse

 

OfferShiftRequestApproveParameterRequest

 

OfferShiftRequestApproveResponse

 

OfferShiftRequestDeclineParameterRequest

 

OfferShiftRequestDeclineResponse

 

OfferShiftRequestResponse

Offer Shift Request

OpenShiftChangeRequestApproveParameterRequest

 

OpenShiftChangeRequestApproveResponse

 

OpenShiftChangeRequestDeclineParameterRequest

 

OpenShiftChangeRequestDeclineResponse

 

OpenShiftChangeRequestResponse

Open Shift Change Request

OpenShiftResponse

Open Shift

RenewWebHookSubscriptionParameterBody

 

ScheduleResponse

 

SchedulingGroupResponse

Scheduling Group

SharedOpenShift

 

SharedShift

 

SharedTimeOff

 

ShiftResponse

Shift

SwapShiftsChangeRequestApproveParameterRequest

 

SwapShiftsChangeRequestApproveResponse

 

SwapShiftsChangeRequestDeclineParameterRequest

 

SwapShiftsChangeRequestDeclineResponse

 

SwapShiftsChangeRequestResponse

Swap Shift Request

TimeOffRequestApproveParameterRequest

 

TimeOffRequestApproveResponse

 

TimeOffRequestDeclineParameterRequest

 

TimeOffRequestDeclineResponse

 

TimeOffRequestResponse

Time Off Request

TimeOffResponse

Time Off

TriggerForOfferShiftRequestsResponse

 

TriggerForOpenShiftChangeRequestsResponse

 

TriggerForShiftsResponse

 

TriggerForSwapShiftsChangeRequestsResponse

 

TriggerForTimeOffRequestsResponse

 

WebHookRequest

 

 

Actions:

GetAllTeams

Summary: List teams

Description: This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of.

 

Syntax:

ShiftsforMicrosoftTeams.GetAllTeams ()

 

Returns:

          Type:GetAllTeamsResponse

 

GetSchedule

Summary: Get a Schedule's details

Description: This operation returns details of a Schedule using the Schedule's unique ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetSchedule (string teamId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

 

Returns:

          Type:ScheduleResponse

          Description: Schedule Entity.

 

ListTimesOff

Summary: List all Time Off instances

Description: This operation returns all Time Off instances in a Schedule

 

Syntax:

ShiftsforMicrosoftTeams.ListTimesOff (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

GetAllTeams

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)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

 

Returns:

          Type:ListTimesOffResponse

 

GetTimeOff

Summary: Get a Time Off instance

Description: This operation returns details for a Time Off using its unique ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetTimeOff (string teamId, string timeOffId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

timeOffId

string

(Time Off ID)

The unique ID of the Time Off.

True

 

Returns:

          Type:TimeOffResponse

          Summary: Time Off

          Description: Time Off Entity.

 

DeleteTimeOff

Summary: Delete a Time Off instance

Description: This operation deletes a Time Off using its unique ID.

 

Syntax:

ShiftsforMicrosoftTeams.DeleteTimeOff (string teamId, string timeOffId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

timeOffId

string

(Time Off ID)

The unique ID of the Time Off.

True

 

Returns:

 

ListShifts

Summary: List all Shifts

Description: This operation returns all Shifts assigned to members of a team

 

Syntax:

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

GetAllTeams

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)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

 

Returns:

          Type:ListShiftsResponse

 

GetShift

Summary: Get a Shift

Description: This operation returns details for a Shift using the Shift's unique ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetShift (string teamId, string shiftId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

shiftId

string

(Shift ID)

The unique ID of the Shift.

True

 

Returns:

          Type:ShiftResponse

          Summary: Shift

          Description: Shift Entity.

 

DeleteShift

Summary: Delete a Shift

Description: This operation deletes a Shift using the Shift's unique ID.

 

Syntax:

ShiftsforMicrosoftTeams.DeleteShift (string teamId, string shiftId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

shiftId

string

(Shift ID)

The unique ID of the Shift.

True

 

Returns:

 

ListOpenShifts

Summary: List all Open Shifts

Description: This operation returns all Open Shifts in a team.

 

Syntax:

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

GetAllTeams

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)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

 

Returns:

          Type:ListOpenShiftsResponse

 

CreateOpenShift

Summary: Create a new Open Shift

Description: Create a new Open Shift in a Schedule.

 

Syntax:

ShiftsforMicrosoftTeams.CreateOpenShift (string teamId, EditOpenShiftRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

request

EditOpenShiftRequest

 

 

True

 

Returns:

          Type:OpenShiftResponse

          Summary: Open Shift

          Description: Open Shift Entity

 

GetOpenShift

Summary: Get an Open Shift

Description: This operation returns details for an Open Shift.

 

Syntax:

ShiftsforMicrosoftTeams.GetOpenShift (string teamId, string openShiftId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

openShiftId

string

(Open Shift ID)

The unique ID of the Open Shift.

True

 

Returns:

          Type:OpenShiftResponse

          Summary: Open Shift

          Description: Open Shift Entity

 

UpdateOpenShift

Summary: Update an Open Shift

Description: Update an Open Shift in a Schedule.

 

Syntax:

ShiftsforMicrosoftTeams.UpdateOpenShift (string teamId, string openShiftId, EditOpenShiftRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

openShiftId

string

(Open Shift ID)

The unique ID of the Open Shift.

True

request

EditOpenShiftRequest

 

 

True

 

Returns:

          Type:OpenShiftResponse

          Summary: Open Shift

          Description: Open Shift Entity

 

DeleteOpenShift

Summary: Delete an Open Shift

Description: This operation deletes an Open Shift.

 

Syntax:

ShiftsforMicrosoftTeams.DeleteOpenShift (string teamId, string openShiftId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

openShiftId

string

(Open Shift ID)

The unique ID of the Open Shift.

True

 

Returns:

 

ListTimeOffReasons

Summary: List all Time Off Reasons

Description: This operation returns the list of Time Off Reasons associated with a team.

 

Syntax:

ShiftsforMicrosoftTeams.ListTimeOffReasons (string teamId, [advanced][Optional]integer $top)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

$top

integer(int32)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

 

Returns:

          Type:GetTimeOffReasonsResponse

          Summary: List of Time Off Reasons associated with a team

          Description: The list of Time Off Reasons.

 

ListSchedulingGroups

Summary: List all Scheduling Groups

Description: This operation returns all Scheduling Groups in a Schedule.

 

Syntax:

ShiftsforMicrosoftTeams.ListSchedulingGroups (string teamId, [advanced][Optional]integer $top)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

$top

integer(int32)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

 

Returns:

          Type:ListSchedulingGroupsResponse

 

GetSchedulingGroup

Summary: Get a Scheduling Group

Description: This operation returns details for a Scheduling Group using its unique ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetSchedulingGroup (string teamId, string schedulingGroupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

schedulingGroupId

string

(Scheduling Group ID)

The unique ID of the Scheduling Group.

True

 

Returns:

          Type:SchedulingGroupResponse

          Summary: Scheduling Group

          Description: Scheduling Group Entity

 

ListTimeOffRequests

Summary: List all Time Off requests

Description: This operation returns all Time Off requests in a Schedule.

 

Syntax:

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

GetAllTeams

$top

integer(int32)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

state

string

(Request State)Values: [pending, approved, declined]

Request state filter

False

 

Returns:

          Type:ListTimeOffRequestsResponse

 

GetTimeOffShiftRequest

Summary: Get a Time Off request

Description: This operation returns a Time Off request by ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetTimeOffShiftRequest (string teamId, string timeOffRequestId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

timeOffRequestId

string

(Time Off Request ID)

The unique ID of the Time Off request

True

 

Returns:

          Type:TimeOffRequestResponse

          Summary: Time Off Request

          Description: Time Off Request Entity

 

TimeOffRequestApprove

Summary: Approve a Time Off request

Description: This operation allows managers to approve a Time Off request.

 

Syntax:

ShiftsforMicrosoftTeams.TimeOffRequestApprove (string teamId, string timeOffRequestId, TimeOffRequestApproveParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

TimeOffRequestDecline

Summary: Decline a Time Off request

Description: This operation allows managers to decline a Time Off request.

 

Syntax:

ShiftsforMicrosoftTeams.TimeOffRequestDecline (string teamId, string timeOffRequestId, TimeOffRequestDeclineParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

ListOfferShiftRequests

Summary: List all Offer Shift requests

Description: This operation returns all Offer Shift requests in a Schedule.

 

Syntax:

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

GetAllTeams

$top

integer(int32)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

state

string

(Request State)Values: [pending, approved, declined]

Request state filter

False

 

Returns:

          Type:ListOfferShiftRequestsResponse

 

GetOfferShiftRequest

Summary: Get an Offer Shift request

Description: This operation returns an Offer Shift request by ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetOfferShiftRequest (string teamId, string offerShiftRequestId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

offerShiftRequestId

string

(Offer Shift Request ID)

The unique ID of the Offer Shift request

True

 

Returns:

          Type:OfferShiftRequestResponse

          Summary: Offer Shift Request

          Description: Offer Shift Request Entity

 

OfferShiftRequestApprove

Summary: Approve an Offer Shift request

Description: This operation allows recipients/managers to approve an Offer Shift request.

 

Syntax:

ShiftsforMicrosoftTeams.OfferShiftRequestApprove (string teamId, string offerShiftRequestId, OfferShiftRequestApproveParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

OfferShiftRequestDecline

Summary: Decline an Offer Shift request

Description: This operation allows users to decline an Offer Shift request.

 

Syntax:

ShiftsforMicrosoftTeams.OfferShiftRequestDecline (string teamId, string offerShiftRequestId, OfferShiftRequestDeclineParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

ListSwapShiftsChangeRequests

Summary: List all Swap Shifts requests

Description: This operation returns all Swap Shifts requests in a Schedule.

 

Syntax:

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

GetAllTeams

$top

integer(int32)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

state

string

(Request State)Values: [pending, approved, declined]

Request state filter

False

 

Returns:

          Type:ListSwapShiftsChangeRequestsResponse

 

GetSwapShiftsChangeRequest

Summary: Get a Swap Shifts request

Description: This operation returns a Swap Shifts request by ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetSwapShiftsChangeRequest (string teamId, string swapShiftsChangeRequestId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

swapShiftsChangeRequestId

string

(Swap Shifts Change Request ID)

The unique ID of the request

True

 

Returns:

          Type:SwapShiftsChangeRequestResponse

          Summary: Swap Shift Request

          Description: Swap Shift Request Entity

 

SwapShiftsChangeRequestApprove

Summary: Approve a Swap Shifts request

Description: This operation allows a user to approve a Swap Shifts request.

 

Syntax:

ShiftsforMicrosoftTeams.SwapShiftsChangeRequestApprove (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestApproveParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

SwapShiftsChangeRequestDecline

Summary: Decline a Swap Shifts request

Description: This operation allows users to decline a Swap Shifts request.

 

Syntax:

ShiftsforMicrosoftTeams.SwapShiftsChangeRequestDecline (string teamId, string swapShiftsChangeRequestId, SwapShiftsChangeRequestDeclineParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

ListOpenShiftChangeRequests

Summary: List all Open Shift requests

Description: This operation returns all Open Shift change requests in a Schedule.

 

Syntax:

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

GetAllTeams

$top

integer(int32)

(Page Size)

Items per page (enable Pagination under .../Settings)

False

state

string

(Request State)Values: [pending, approved, declined]

Request state filter

False

 

Returns:

          Type:ListOpenShiftChangeRequestsResponse

 

GetOpenShiftChangeRequest

Summary: Get an Open Shift request

Description: This operation returns an Open Shift change request by ID.

 

Syntax:

ShiftsforMicrosoftTeams.GetOpenShiftChangeRequest (string teamId, string openShiftChangeRequestId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

openShiftChangeRequestId

string

(Open Shift Change Request ID)

The unique ID of the request

True

 

Returns:

          Type:OpenShiftChangeRequestResponse

          Summary: Open Shift Change Request

          Description: Open Shift Change Request Entity

 

OpenShiftChangeRequestApprove

Summary: Approve an Open Shift request

Description: This operation allows managers to approve an Open Shift request.

 

Syntax:

ShiftsforMicrosoftTeams.OpenShiftChangeRequestApprove (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestApproveParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

OpenShiftChangeRequestDecline

Summary: Decline an Open Shift request

Description: This operation allows managers to decline an Open Shift request.

 

Syntax:

ShiftsforMicrosoftTeams.OpenShiftChangeRequestDecline (string teamId, string openShiftChangeRequestId, OpenShiftChangeRequestDeclineParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

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

 

DeleteWebHookSubscription

Summary: Delete WebHook Subscription

Description: Delete WebHook Subscription

 

Syntax:

ShiftsforMicrosoftTeams.DeleteWebHookSubscription (string subscriptionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriptionId

string

 

 

True

 

Returns:

 

RenewWebHookSubscription

Summary: Update subscription

Description: Renew a Microsoft Graph webhook subscription by updating its expiration time.

 

Syntax:

ShiftsforMicrosoftTeams.RenewWebHookSubscription (string subscriptionId, [Optional]RenewWebHookSubscriptionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriptionId

string

 

 

True

body

RenewWebHookSubscriptionParameterBody

 

 

False

 

Returns:

 

WebhookResponse

Summary: Proxy endpoint to validate subscriptions and forward notifications

Description: Proxy endpoint that receives notifications from the GraphAPI and validates subscriptions.

 

Syntax:

ShiftsforMicrosoftTeams.WebhookResponse ()

 

Returns:

 

Triggers:

Trigger TriggerForOpenShiftChangeRequests

Summary: When an Open Shift request is created, updated or deleted

Description: This operation triggers when an Open Shift request is created, updated or deleted.

 

Syntax:

ShiftsforMicrosoftTeams.TriggerForOpenShiftChangeRequests (string teamId, WebHookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

request

WebHookRequest

 

 

True

 

Returns:

          Type:TriggerForOpenShiftChangeRequestsResponse

 

Trigger TriggerForSwapShiftsChangeRequests

Summary: When a Swap Shifts request is created, updated or deleted

Description: This operation triggers when a Swap Shifts request is created, updated or deleted.

 

Syntax:

ShiftsforMicrosoftTeams.TriggerForSwapShiftsChangeRequests (string teamId, WebHookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

request

WebHookRequest

 

 

True

 

Returns:

          Type:TriggerForSwapShiftsChangeRequestsResponse

 

Trigger TriggerForOfferShiftRequests

Summary: When an Offer Shift request is created, updated or deleted

Description: This operation triggers when an Offer Shift request is created, updated or deleted.

 

Syntax:

ShiftsforMicrosoftTeams.TriggerForOfferShiftRequests (string teamId, WebHookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

request

WebHookRequest

 

 

True

 

Returns:

          Type:TriggerForOfferShiftRequestsResponse

 

Trigger TriggerForTimeOffRequests

Summary: When a Time Off request is created, updated or deleted

Description: This operation triggers when a Time Off request is created, updated or deleted.

 

Syntax:

ShiftsforMicrosoftTeams.TriggerForTimeOffRequests (string teamId, WebHookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

request

WebHookRequest

 

 

True

 

Returns:

          Type:TriggerForTimeOffRequestsResponse

 

Trigger TriggerForShifts

Summary: When a Shift is created, updated or deleted

Description: This operation triggers when a Shift is created, updated or deleted.

 

Syntax:

ShiftsforMicrosoftTeams.TriggerForShifts (string teamId, WebHookRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team)

Add Team ID

True

GetAllTeams

request

WebHookRequest

 

 

True

 

Returns:

          Type:TriggerForShiftsResponse

 


 

DraftOpenShift

Summary: Draft Changes >

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)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  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)

Activities

Shift activities

 

ActivitiesItem

Summary: Activity

Description: Shift activity

 

          Properties:

Name

Type

Summary

isPaid

boolean

Is Paid

Is Paid

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

code

string

Code

Code

displayName

string

Display Name

Display Name

 


 

DraftShift

Summary: Draft Changes >

Description: Preliminary version of the Shift

 

          Properties:

Name

Type

Summary

displayName

string

Display Name

Display Name

notes

string

Notes

Notes

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow]

activities

array of (ActivitiesItem)

Activities

Shift activities

 

ActivitiesItem

Summary: Activity

Description: Shift activity

 

          Properties:

Name

Type

Summary

isPaid

boolean

Is Paid

Is Paid

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

code

string

Code

Code

displayName

string

Display Name

Display Name

 


 

DraftTimeOff

Summary: Draft Changes >

Description: Preliminary version of the Time Off

 

          Properties:

Name

Type

Summary

timeOffReasonId

string

Time Off Reason ID

Time Off Reason ID.

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow]


 

EditOpenShiftRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

schedulingGroupId

string

Scheduling Group ID

Scheduling Group ID

sharedOpenShift

SharedOpenShift

 

 

 

SharedOpenShift

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Display Name

Display Name

notes

string

Notes

Notes

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  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)

Activities

Shift activities

 

ActivitiesItem

Summary: Activity

Description: Shift activity

 

          Properties:

Name

Type

Summary

isPaid

boolean

Is Paid

Is Paid

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

code

string

Code

Code

displayName

string

Display Name

Display Name

 


 

GetAllTeamsResponse

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.

 

ValueItem

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

 


 

GetTimeOffReasonsResponse

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.

 

ValueItem

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

 


 

ListOfferShiftRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (OfferShiftRequestResponse)

Offer Shift Requests List

List of Offer Shift requests.


 

ListOpenShiftChangeRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (OpenShiftChangeRequestResponse)

Open Shift Change Requests List

List of Open Shift Change Requests.


 

ListOpenShiftsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (OpenShiftResponse)

Open Shifts List

List of Open Shifts


 

ListSchedulingGroupsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (SchedulingGroupResponse)

Scheduling Groups List

List of Scheduling Groups.


 

ListShiftsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (ShiftResponse)

Shifts List

List of Shifts


 

ListSwapShiftsChangeRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (SwapShiftsChangeRequestResponse)

Swap Shifts Change Requests List

List of Swap Shifts Change Requests.


 

ListTimeOffRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (TimeOffRequestResponse)

Time Off Requests List

List of Time Off requests.


 

ListTimesOffResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

 

 

value

array of (TimeOffResponse)

Time Off Instances List

List of Time Off instances


 

OfferShiftRequestApproveParameterRequest

Summary:

Description: Approve an Offer Shift request.

 

          Properties:

Name

Type

Summary

message

string

Message From Recipient/Manager

A message when a request is accepted.


 

OfferShiftRequestApproveResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OfferShiftRequestDeclineParameterRequest

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.


 

OfferShiftRequestDeclineResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OfferShiftRequestResponse

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'  Values: [mananger, 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


 

OpenShiftChangeRequestApproveParameterRequest

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.


 

OpenShiftChangeRequestApproveResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OpenShiftChangeRequestDeclineParameterRequest

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.


 

OpenShiftChangeRequestDeclineResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OpenShiftChangeRequestResponse

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'  Values: [mananger, 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


 

OpenShiftResponse

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

sharedOpenShift

SharedOpenShift

 

Shared version of the Open Shift

draftOpenShift

DraftOpenShift

Draft Changes >

Preliminary version of the Open Shift


 

RenewWebHookSubscriptionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

expirationDateTime

string

 

Specify the date and time, in UTC format, of when the Microsoft Graph webhook subscription expires. The maximum expiration time for security alerts is 43200 minutes (under 30 days).


 

ScheduleResponse

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.


 

SchedulingGroupResponse

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.


 

SharedOpenShift

Summary:

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)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  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)

Activities

Shift activities

 

ActivitiesItem

Summary: Activity

Description: Shift activity

 

          Properties:

Name

Type

Summary

isPaid

boolean

Is Paid

Is Paid

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

code

string

Code

Code

displayName

string

Display Name

Display Name

 


 

SharedShift

Summary:

Description: Shared version of the Shift.

 

          Properties:

Name

Type

Summary

displayName

string

Display Name

Display Name.

notes

string

Notes

Shift Notes.

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow]

activities

array of (ActivitiesItem)

Activities

Shift activities

 

ActivitiesItem

Summary: Activity

Description: Shift activity

 

          Properties:

Name

Type

Summary

isPaid

boolean

Is Paid

Is Paid

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

code

string

Code

Code

displayName

string

Display Name

Display Name

 


 

SharedTimeOff

Summary:

Description: Shared version of the Time Off.

 

          Properties:

Name

Type

Summary

timeOffReasonId

string

Time Off Reason ID

Time Off Reason ID.

startDateTime

string(date-time)

Start Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

endDateTime

string(date-time)

End Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme

string

Theme

Theme color.  Values: [white, blue, green, purple, pink, yellow, gray, darkblue, darkgreen, darkpurple, darkpink, darkyellow]


 

ShiftResponse

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.

sharedShift

SharedShift

 

Shared version of the Shift.

draftShift

DraftShift

Draft Changes >

Preliminary version of the Shift


 

SwapShiftsChangeRequestApproveParameterRequest

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.


 

SwapShiftsChangeRequestApproveResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SwapShiftsChangeRequestDeclineParameterRequest

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.


 

SwapShiftsChangeRequestDeclineResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SwapShiftsChangeRequestResponse

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'  Values: [mananger, 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


 

TimeOffRequestApproveParameterRequest

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.


 

TimeOffRequestApproveResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TimeOffRequestDeclineParameterRequest

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.


 

TimeOffRequestDeclineResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TimeOffRequestResponse

Summary: Time Off Request

Description: Time Off Request Entity

 

          Properties:

Name

Type

Summary

id

string

ID

The unique ID of the Time Off 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'  Values: [mananger, 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)

Start Time

Start of time requested off

endDateTime

string(date-time)

End Time

End of time requested off

timeOffReasonId

string

Time Off Reason ID

The ID of the Time Off Reason


 

TimeOffResponse

Summary: Time Off

Description: Time Off Entity.

 

          Properties:

Name

Type

Summary

id

string

ID

The unique ID of the Time Off.

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.

sharedTimeOff

SharedTimeOff

 

Shared version of the Time Off.

draftTimeOff

DraftTimeOff

Draft Changes >

Preliminary version of the Time Off


 

TriggerForOfferShiftRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TriggerForOpenShiftChangeRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TriggerForShiftsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TriggerForSwapShiftsChangeRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TriggerForTimeOffRequestsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

WebHookRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

notificationUrl

string

 

Specify a well-formed URL of the endpoint that will receive notifications.