Créer workforceIntegration
Espace de noms: microsoft.graph
Créez un objet workforceIntegration . Vous pouvez configurer les entités sur lesquelles vous souhaitez recevoir des notifications de modification synchrones Shifts et définir des entités pour configurer le filtrage par WFM règles d’éligibilité, y compris les demandes d’échange.
Cette API est disponible dans les déploiements de cloud national suivants.
Service global | Gouvernement des États-Unis L4 | Us Government L5 (DOD) | Chine gérée par 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
Type d’autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées plus élevées |
---|---|---|
Déléguée (compte professionnel ou scolaire) | WorkforceIntegration.ReadWrite.All | Non disponible. |
Déléguée (compte Microsoft personnel) | Non prise en charge. | Non prise en charge. |
Application | Non prise en charge. | Non prise en charge. |
Remarque: cet API prend en charge les autorisations d’administrateur. Les utilisateurs disposant de rôles d’administrateur peuvent accéder à des groupes dont ils ne sont pas membres.
Requête HTTP
POST /teamwork/workforceIntegrations
En-têtes de demande
Nom | Description |
---|---|
Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
Content-type | application/json. Obligatoire. |
MS-APP-ACTS-AS | UN ID d’utilisateur (GUID). Obligatoire uniquement si le jeton d’autorisation est un jeton d’application ; sinon, facultatif. |
Corps de la demande
Dans le corps de la demande, fournissez une représentation JSON de l’objet workforceIntegration .
Le tableau suivant répertorie les propriétés que vous pouvez utiliser lorsque vous créez un objet workforceIntegration .
Propriété | Type | Description |
---|---|---|
apiVersion | Int32 | Version de l’API pour l’URL de rappel. Commencez par 1. |
displayName | String | Nom de l’intégration de la main-d’œuvre. |
eligibilityFilteringEnabledEntities | eligibilityFilteringEnabledEntities | Prise en charge de l’affichage des résultats filtrés sur l’éligibilité. Les valeurs possibles sont les suivantes : none , swapRequest , offerShiftRequest , unknownFutureValue , timeOffReason . Utilisez l’en-tête Prefer: include-unknown-enum-members de requête pour obtenir la valeur suivante dans cette énumération évolutive : timeOffReason . |
chiffrement | workforceIntegrationEncryption | Ressource de chiffrement d’intégration de la main-d’œuvre. |
isActive | Boolean | Indique si cette intégration de la main-d’œuvre est actuellement active et disponible. |
supportedEntities | workforceIntegrationSupportedEntities | Entités Shifts prises en charge pour les notifications de modifications synchrones. Les décalages rappellent l’URL fournie lorsque le client change les entités spécifiées dans cette propriété. Par défaut, aucune entité n’est prise en charge pour les notifications de modification. Valeurs possibles : none , shift , swapRequest , userShiftPreferences , openShift , openShiftRequest , offerShiftRequest , unknownFutureValue , timeOffReason , timeOff , timeOffRequest . Utilisez l’en-tête Prefer: include-unknown-enum-members de requête pour obtenir les valeurs suivantes dans cette énumération évolutive : timeOffReason , timeOff , timeOffRequest . |
url | Chaîne | URL d’intégration de la main-d’œuvre utilisée pour les rappels à partir du service Shifts. |
Réponse
Si elle réussit, cette méthode renvoie un 201 Created
code de réponse et un nouvel objet workforceIntegration dans le corps de la réponse.
Exemples
Demande
L’exemple suivant illustre une demande.
POST https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations
Content-Type: application/json
{
"displayName": "ABCWorkforceIntegration",
"apiVersion": 1,
"isActive": true,
"encryption": {
"protocol": "sharedSecret",
"secret": "My Secret"
},
"url": "https://ABCWorkforceIntegration.com/Contoso/",
"supportedEntities": "Shift,SwapRequest",
"eligibilityFilteringEnabledEntities": "SwapRequest"
}
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "c5d0c76b-80c4-481c-be50-923cd8d680a1",
"displayName": "ABCWorkforceIntegration",
"apiVersion": 1,
"isActive": true,
"encryption": {
"protocol": "sharedSecret",
"secret": null
},
"url": "https://abcWorkforceIntegration.com/Contoso/",
"supportedEntities": "Shift,SwapRequest",
"eligibilityFilteringEnabledEntities": "SwapRequest"
}
Exemples de cas d’utilisation de l’entité WorkforceIntegration pour le filtrage par éligibilité aux règles WFM
Cas d’usage : Créer un WorkforceIntegration avec SwapRequest activé pour le filtrage de l’éligibilité
Demande
L’exemple suivant illustre une demande.
POST https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations/
Authorization: Bearer {token}
Content-type: application/json
{
"displayName": "ABCWorkforceIntegration",
"apiVersion": 1,
"isActive": true,
"encryption": {
"protocol": "sharedSecret",
"secret": "My Secret"
},
"url": "https://ABCWorkforceIntegration.com/Contoso/",
"supportedEntities": "Shift,SwapRequest",
"eligibilityFilteringEnabledEntities": "SwapRequest"
}
Réponse
L’exemple suivant illustre la réponse.
HTTP/1.1 200 OK
{
"id": "c5d0c76b-80c4-481c-be50-923cd8d680a1",
"displayName": "ABCWorkforceIntegration",
"apiVersion": 1,
"isActive": true,
"encryption": {
"protocol": "sharedSecret",
"secret": null
},
"url": "https://abcWorkforceIntegration.com/Contoso/",
"supportedEntities": "Shift,SwapRequest",
"eligibilityFilteringEnabledEntities": "SwapRequest"
}
Pour savoir comment mettre à jour une intégration de main-d’œuvre existante avec SwapRequest activé pour le filtrage de l’éligibilité, consultez Mettre à jour.
Exemple de récupération de shifts éligibles lorsque SwapRequest est inclus dans eligibilityFilteringEnabledEntities
L’interaction entre l’application Shifts et les points de terminaison d’intégration de la main-d’œuvre suit le modèle existant.
Demande
L’exemple suivant montre une demande effectuée par Shifts vers le point de terminaison d’intégration de la main-d’œuvre pour extraire les shifts éligibles pour une demande d’échange.
POST https://abcWorkforceIntegration.com/Contoso/{apiVersion}/team/{teamId}/read
Accept-Language: en-us
{
"requests": [
{
"id": "{shiftId}",
"method": "GET”,
"url": “/shifts/{shiftId}/requestableShifts?requestType={requestType}&startDateTime={startDateTime}&endDateTime={endDateTime}”
}]
}
Réponse
Voici un exemple de la réponse du service d’intégration de la main-d’œuvre.
HTTP/1.1 200 OK
{
"responses": [
{
"body": {
"SHFT_6548f642-cbc1-4228-8621-054327576457",
"SHFT_6548f642-cbc1-4228-8621-054327571234"
}
"id": "{shiftId}",
"status: 200,
"body": {
"data": [{ShiftId}, {ShiftId}...]
"error": null
}
]
}