Edit

Share via


offerShiftRequest 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 type of shift request to offer a shift to another user in the team.

Base type of swapShiftsChangeRequest.

Inherits from scheduleChangeRequest.

Methods

Method Return Type Description
Create offerShiftRequest Create an instance of an offerShiftRequest object.
Get offerShiftRequest Read properties and relationships of offerShiftRequest object.
List Collection of offerShiftRequest Read properties and relationships of all offerShiftRequest objects in a team.
Approve None Approve an offerShiftRequest.
Approve for user None Approve an offerShiftRequest object for a user. This action only supports application permissions.
Decline None Decline an offerShiftRequest.
Decline for user None Decline an offerShiftRequest object for a user. This action only supports application permissions.

Properties

Property Type Description
assignedTo scheduleChangeRequestActor Indicates who the request is assigned to. Inherited from scheduleChangeRequest.The possible values are: sender, recipient, manager, system, unknownFutureValue.
createdBy identitySet The user who created the entity. Inherited from changeTrackedEntity.
createdDateTime DateTimeOffset The date and time when the entity was created. Inherited from changeTrackedEntity.
id String The unique identifier for the entity. Inherited from entity. Inherits from entity
lastModifiedBy identitySet The user who last modified the entity. Inherited from changeTrackedEntity.
lastModifiedDateTime DateTimeOffset The date and time when the entity was last modified. Inherited from changeTrackedEntity.
managerActionDateTime DateTimeOffset The date and time when the manager approved or declined the request. Inherited from scheduleChangeRequest.
managerActionMessage String The message sent by the manager regarding the request. Inherited from scheduleChangeRequest.
managerUserId String The user ID of the manager who approved or declined the request. Inherited from scheduleChangeRequest.
recipientActionDateTime DateTimeOffset The date and time when the recipient approved or declined the request.
recipientActionMessage String The message sent by the recipient regarding the request.
recipientUserId String The recipient's user ID.
senderDateTime DateTimeOffset The date and time when the sender sent the request. Inherited from scheduleChangeRequest.
senderMessage String The message sent by the sender of the request. Inherited from scheduleChangeRequest.
senderShiftId String The sender's shift ID.
senderUserId String The user ID of the sender of the request. Inherited from scheduleChangeRequest.
state scheduleChangeState The state of the entity. Inherited from scheduleChangeRequest.The possible values are: pending, approved, declined, unknownFutureValue.

Relationships

None

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.offerShiftRequest",
  "id": "String (identifier)",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "assignedTo": "String",
  "state": "String",
  "senderMessage": "String",
  "senderDateTime": "String (timestamp)",
  "managerActionMessage": "String",
  "managerActionDateTime": "String (timestamp)",
  "senderUserId": "String",
  "managerUserId": "String",
  "recipientActionMessage": "String",
  "recipientActionDateTime": "String (timestamp)",
  "senderShiftId": "String",
  "recipientUserId": "String"
}