Show / Hide Table of Contents

Schedule.Read.All

Allows the app to read schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A DELETE /teams/{teamId}/schedule/shifts/{shiftId}
V1 A,D GET /teams/{id}/schedule/openShiftChangeRequests
V1 A,D GET /teams/{id}/schedule/openShiftChangeRequests/{openShiftsChangeRequestId}
V1 A,D GET /teams/{id}/schedule/openShifts
V1 A,D GET /teams/{id}/schedule/openShifts/{openShiftId}
V1 A,D GET /teams/{teamId}/schedule
V1 A,D GET /teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}
V1 A,D GET /teams/{teamId}/schedule/schedulingGroups
V1 A,D GET /teams/{teamId}/schedule/schedulingGroups/{schedulingGroupId}
V1 A,D GET /teams/{teamId}/schedule/shifts
V1 A,D GET /teams/{teamId}/schedule/shifts/{shiftId}
V1 A,D GET /teams/{teamId}/schedule/swapShiftsChangeRequests
V1 A,D GET /teams/{teamId}/schedule/timecards
V1 A,D GET /teams/{teamId}/schedule/timecards/{timecardID}
V1 A,D GET /teams/{teamId}/schedule/timeOffReasons
V1 A,D GET /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId}
V1 A,D GET /teams/{teamId}/schedule/timeOffRequests
V1 A,D GET /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}
V1 A,D GET /teams/{teamId}/schedule/timesOff
V1 A,D GET /teams/{teamId}/schedule/timesOff/{timeOffId}

Delegate Permission

Id fccf6dd8-5706-49fa-811f-69e2e1b585d0
Consent Type Admin
Display String Read user schedule items
Description Allows the app to read schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on behalf of the signed-in user.

Application Permission

Id 7b2ebf90-d836-437f-b90d-7b62722c4456
Display String Read all schedule items
Description Allows the app to read all schedules, schedule groups, shifts and associated entities in the Teams or Shifts application without a signed-in user.

Resources

offerShiftRequest

Property Type Description
recipientActionDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
recipientActionMessage String Custom message sent by recipient of the offer shift request.
recipientUserId String User ID of the recipient of the offer shift request.
senderShiftId String User ID of the sender of the offer shift request.

openShift

Property Type Description
draftOpenShift openShiftItem An unpublished open shift.
schedulingGroupId String ID for the scheduling group that the open shift belongs to.
sharedOpenShift openShiftItem A published open shift.

openShiftChangeRequest

Property Type Description
openShiftId String ID for the open shift.

schedule

schedulingGroup

shift

swapShiftsChangeRequest

Property Type Description
recipientShiftId String ShiftId for the recipient user with whom the request is to swap.

timecard

Property Type Description
id string ID of the timeCard.
userId string User ID to which the timeCard belongs.
state timeCardState The current state of the timeCard during its life cycle.Possible values are: clockedIn, onBreak, clockedOut, unknownFutureValue.
clockInEvent timeCardEvent The clock-in event of the timeCard.
clockOutEvent timeCardEvent The clock-out event of the timeCard.
notes itemBody Notes about the timeCard.
breaks timeCardBreak collection The list of breaks associated with the timeCard.
originalEntry timeCardEntry The original timeCardEntry of the timeCard, before user edits.
confirmedBy confirmedBy Indicate if this timeCard entry is confirmed. Possible values are none, user, manager, unknownFutureValue.
createdDateTime Edm.dateTimeOffset The timestamp in which the timeCard was created.
createdBy IdentitySet Identity of the person who created the entity.
lastModifiedDateTime dateTimeOffset The timestamp in which the timeCard was last modified.
lastModifiedBy IdentitySet Identity of the person who last modified the entity.

timeOff

timeOffReason

Property Type Description
createdDateTime DateTimeOffset The time stamp on which this timeOffReason was first created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
displayName String The name of the timeOffReason. Required.
iconType timeOffReasonIconType Supported icon types are: none, car, calendar, running, plane, firstAid, doctor, notWorking, clock, juryDuty, globe, cup, phone, weather, umbrella, piggyBank, dog, cake, trafficCone, pin, sunny. Required.
id String Unique identifier for the time-off reason.
isActive Boolean Indicates whether the timeOffReason can be used when creating new entities or updating existing ones. Required.
lastModifiedBy identitySet The identity that last updated this timeOffReason.
lastModifiedDateTime DateTimeOffset The time stamp on which this **t

timeOffRequest

Property Type Description
endDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
startDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
timeOffReasonId String The reason for the time off.
In This Article
Back to top Created by merill | Submit feedback