Freigeben über


Erstellen von workforceIntegration

Namespace: microsoft.graph

Erstellen Sie ein neues workforceIntegration-Objekt .

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) WorkforceIntegration.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application WorkforceIntegration.ReadWrite.All Nicht verfügbar.

Hinweis: Diese API unterstützt Administratorberechtigungen. Benutzer mit Administratorrollen können auf Gruppen zugreifen, in denen sie kein Mitglied sind.

HTTP-Anforderung

POST /teamwork/workforceIntegrations

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-type application/json. Erforderlich.
MS-APP-ACTS-AS (veraltet) Eine Benutzer-ID (GUID). Nur erforderlich, wenn das Autorisierungstoken ein Anwendungstoken ist. andernfalls optional. Der MS-APP-ACTS-AS Header ist veraltet und für Anwendungstoken nicht mehr erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des workforceIntegration-Objekts an.

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die Sie beim Erstellen eines workforceIntegration-Objekts verwenden können.

Eigenschaft Typ Beschreibung
apiVersion Int32 API-Version für die Rückruf-URL. Beginnen Sie mit 1.
displayName Zeichenfolge Name der Personalintegration.
eligibilityFilteringEnabledEntities eligibilityFilteringEnabledEntities Unterstützung zum Anzeigen von berechtigungsgefilterten Ergebnissen. Mögliche Werte sind: none, swapRequest, offerShiftRequest, unknownFutureValue, timeOffReason. Verwenden Sie den Anforderungsheader Prefer: include-unknown-enum-members , um die folgenden Member in dieser verteilbaren Enumeration abzurufen: timeOffReason.
Verschlüsselung workforceIntegrationEncryption Die Verschlüsselungsressource für die Personalintegration.
isActive Boolean Gibt an, ob diese Personalintegration derzeit aktiv und verfügbar ist.
supportedEntities workforceIntegrationSupportedEntities Die für synchrone Änderungsbenachrichtigungen unterstützten Schichtenentitäten. Schichten rufen die angegebene URL auf, wenn Clientänderungen an den in dieser Eigenschaft angegebenen Entitäten auftreten. Standardmäßig werden keine Entitäten für Änderungsbenachrichtigungen unterstützt. Die möglichen Werte sind: none, shift, swapRequest, userShiftPreferences, openShift, , offerShiftRequestopenShiftRequest, unknownFutureValue, timeCard, timeOffReason, timeOff, . timeOffRequest Verwenden Sie den Anforderungsheader Prefer: include-unknown-enum-members , um die folgenden Werte in dieser verwertbaren Enumeration abzurufen: timeCard, timeOffReason , timeOff , timeOffRequest.
url Zeichenfolge Url für die Mitarbeiterintegration, die für Rückrufe aus dem Schichtdienst verwendet wird.

Antwort

Bei erfolgreicher Ausführung gibt die Methode einen 201 Created Antwortcode und ein neues workforceIntegration-Objekt im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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"
}

Beispiele für Anwendungsfälle der WorkforceIntegration-Entität für die Berechtigungsfilterung nach WFM-Regeln (Workforce Management System)

Anwendungsfall: Erstellen einer neuen WorkforceIntegration mit aktiviertem SwapRequest für die Berechtigungsfilterung

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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"
}

Informationen zum Aktualisieren einer vorhandenen WorkforceIntegration mit aktiviertem SwapRequest für die Berechtigungsfilterung finden Sie unter Aktualisieren.

Beispiel für das Abrufen berechtigter Schichten, wenn SwapRequest in "eligibilityFilteringEnabledEntities" enthalten ist

Die Interaktion zwischen der Schichten-App und den Endpunkten für die Integration von Mitarbeitern folgt dem vorhandenen Muster.

Anforderung

Dieses Beispiel zeigt eine Anforderung, die von Schichten an den Workforce Integration-Endpunkt gesendet wird, um berechtigte Schichten für eine Austauschanforderung abzurufen.

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}”
   }]
}

Antwort

Das folgende Beispiel zeigt die Antwort des Personalintegrationsdiensts.

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