Partager via


Mettre à jour workforceIntegration

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet workforceIntegration .

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 WorkforceIntegration.ReadWrite.All Non disponible.

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

PATCH /teamwork/workforceIntegrations/{workforceIntegrationId}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
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 uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

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 appellent l’URL fournie lorsque le client change les entités spécifiées dans cette propriété. Les valeurs possibles sont les suivantes : none, shift, swapRequest, userShiftPreferences, openShift, openShiftRequest, offerShiftRequest, unknownFutureValue, timeCard, timeOffReason, timeOff et timeOffRequest. Utilisez l’en-tête Prefer: include-unknown-enum-members de requête pour obtenir la valeur suivante dans cette énumération évolutive : timeCard, timeOffReason , timeOff , timeOffRequest.
url Chaîne URL d’intégration de la main-d’œuvre pour les rappels à partir du service Shifts.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet workforceIntegration mis à jour dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations/{workforceIntegrationId}
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 200 OK
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 l’éligibilité Filtrage par les règles du système de gestion de la main-d’œuvre (WFM)

Cas d’usage : Remplacez un WorkforceIntegration existant pour activer SwapRequest pour le filtrage de l’éligibilité

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations/{workforceIntegrationid}
{
  "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
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"
}

Pour savoir comment créer une intégration de main-d’œuvre avec SwapRequest activé pour le filtrage d’éligibilité, consultez Créer.

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

L’exemple suivant montre la réponse du service d’intégration de main-d’œuvre.

HTTP/1.1 200 OK
{
  "responses": [
    "id": "{shiftId}",
    "status: 200,
    "body": {
       "data": [{shiftId}, {shiftId}...]
       "error": null
    }
  ]
}