workforceIntegration resource type

Namespace: microsoft.graph

Represents an instance of a workforce integration with shifts.

Methods

Method	Return Type	Description
Create	workforceIntegration	Create a new workforceIntegration object.
List	workforceIntegration collection	Get the list of workforceIntegration objects associated with this schedule.
Get	workforceIntegration	Read the properties and relationships of a workforceIntegration object.
Update	workforceIntegration	Update a workforceIntegration object.
Delete	None	Delete a workforceIntegration object.

Properties

Property	Type	Description
apiVersion	Int32	API version for the call back URL. Start with 1.
createdDateTime	DateTimeOffset	The timestamp on which this workforceIntegration 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.
displayName	String	Name of the workforce integration.
eligibilityFilteringEnabledEntities	eligibilityFilteringEnabledEntities	Support to view eligibility-filtered results. Possible values are: none, swapRequest, offerShiftRequest, unknownFutureValue, timeOffReason. You must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: timeOffReason.
encryption	workforceIntegrationEncryption	The workforce integration encryption resource.
isActive	Boolean	Indicates whether this workforce integration is currently active and available.
supportedEntities	workforceIntegrationSupportedEntities	The Shifts entities supported for synchronous change notifications. Shifts call back to the provided URL when client changes occur to the entities specified in this property. By default, no entities are supported for change notifications. Possible values are: none, shift, swapRequest, userShiftPreferences, openShift, openShiftRequest, offerShiftRequest, unknownFutureValue, timeOffReason, timeOff, timeOffRequest. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: timeOffReason, timeOff, timeOffRequest.
url	String	Workforce Integration URL for callbacks from the Shifts service.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.workforceIntegration",
  "apiVersion": "Int32",
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "eligibilityFilteringEnabledEntities": "String",
  "encryption": {"@odata.type": "microsoft.graph.workforceIntegrationEncryption"},
  "id": "String (identifier)",
  "isActive": "Boolean",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "supportedEntities": "String",
  "url": "String"
}