timeOff resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a unit of nonwork in a schedule.
Inherits from changeTrackedEntity.
Methods
| Method | Return type | Description |
|---|---|---|
| List | timeOff collection | Get the list of timeOff objects in a schedule. |
| Create | timeOff | Create a new timeOff object. |
| Get | timeOff | Get a timeOff object by ID. |
| Replace | timeOff | Replace a timeOff object. |
| Delete | None | Delete a timeOff object from the schedule. |
| Stage for deletion | None | Stage the deletion of a timeOff in a schedule in draft mode. |
Properties
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | Identity of the user who created the timeOff object. Inherited from changeTrackedEntity. |
| createdDateTime | DateTimeOffset | The date and time when this timeOff was first created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from changeTrackedEntity. |
| draftTimeOff | timeOffItem | The draft version of this timeOff item that is viewable by managers. It must be shared before it is visible to team members. Required. |
| id | String | The unique identifier for the timeOff. Inherited from changeTrackedEntity. |
| isStagedForDeletion | Boolean | The timeOff is marked for deletion, a process that is finalized when the schedule is shared. |
| lastModifiedBy | identitySet | The identity of the user who last updated this timeOff. Inherited from changeTrackedEntity. |
| lastModifiedDateTime | DateTimeOffset | The date and time when this timeOff was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from changeTrackedEntity. |
| sharedTimeOff | timeOffItem | The shared version of this timeOff that is viewable by both employees and managers. Updates to the sharedTimeOff property send notifications to users in the Teams client. Required. |
| teamInfo | shiftsTeamInfo | Information of the team that the timeOff is in. |
| userId | String | ID of the user assigned to the timeOff. Required. |
| userInfo | shiftsUserInfo | Information of the user assigned to the timeOff. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.timeOff",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"draftTimeOff": {"@odata.type": "microsoft.graph.timeOffItem"},
"id": "String (identifier)",
"isStagedForDeletion": "Boolean",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"sharedTimeOff": {"@odata.type": "microsoft.graph.timeOffItem"},
"teamInfo": "microsoft.graph.shiftsTeamInfo",
"userId": "String",
"userInfo": "microsoft.graph.shiftsUserInfo"
}