workforceIntegration 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.
An instance of a workforce integration with shifts.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | workforceIntegration collection | Get the list of workforceIntegration objects associated with this schedule. |
| Create | workforceIntegration | Create a new workforceIntegration object. |
| 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 callback URL. Start with 1. |
| displayName | String | Name of the workforce integration. |
| encryption | workforceIntegrationEncryption | The workforce integration encryption resource. |
| isActive | Boolean | Indicates whether this workforce integration is currently active and available. |
| supports | workforceIntegrationSupportedEntities | The Shifts entities supported for synchronous change notifications. Shifts make a callback to the url provided on client changes on those entities added here. By default, no entities are supported for change notifications. The possible values are: none, shift, swapRequest, openshift, openShiftRequest, userShiftPreferences, offerShiftRequest, unknownFutureValue, timeCard, timeOffReason, timeOff, timeOffRequest. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: timeCard, timeOffReason, timeOff, timeOffRequest. If selecting more than one value, all values must start with the first letter in uppercase. |
| supportedEntities | workforceIntegrationSupportedEntities | This property has replaced supports in v1.0. We recommend that you use this property instead of supports. The supports property is still supported in beta for the time being. The possible values are: none, shift, swapRequest, openshift, openShiftRequest, userShiftPreferences, offerShiftRequest, unknownFutureValue, timeCard, timeOffReason, timeOff, timeOffRequest. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: timeCard, timeOffReason, timeOff, timeOffRequest. If selecting more than one value, all values must start with the first letter in uppercase. |
| url | String | Workforce Integration URL for callbacks from the Shifts service. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"apiVersion": 1024,
"displayName": "String",
"encryption": {"@odata.type": "microsoft.graph.workforceIntegrationEncryption"},
"isActive": true,
"supports": "string",
"supportedEntities": "string",
"url": "String"
}