フィードバック 編集

workforceIntegration の更新

  • [アーティクル]

名前空間: microsoft.graph

workforceIntegration オブジェクトのプロパティを更新します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) WorkforceIntegration.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション サポートされていません。

注: この API は、管理者のアクセス許可をサポートします。 グローバル管理者は、メンバーではないグループにアクセスできます。

HTTP 要求

PATCH /teamwork/workforceIntegrations/{workforceIntegrationId}

要求ヘッダー

名前 説明
Authorization ベアラー {トークン}

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

プロパティ 種類 説明
apiVersion Int32 呼び出しの URL の API バージョン。 1 から始める。
displayName 文字列 従業員統合の名前。
暗号化 workforceIntegrationEncryption 従業員統合暗号化リソース。
isActive Boolean この従業員統合が現在アクティブで使用可能かどうかを示します。
supportedEntities string 使用可能な値: none、shift、swapRequest、openshift、openShiftRequest、userShiftPreferences。 複数の値を選択する場合、すべての値は大文字の最初の文字で始まる必要があります。
url String シフト サービスからのコールバックのワークフォース統合 URL。

応答

成功した場合、このメソッドは応答コードと、応答本文で 200 OK 更新された workforceIntegration オブジェクトを返します。

例

要求

要求の例を次に示します。

PATCH https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations/{workforceIntegrationId}
Content-type: application/json

{
  "displayName": "displayName-value",
  "apiVersion": 99,
  "encryption": {
    "protocol": "protocol-value",
    "secret": "secret-value"
  },
  "isActive": true,
  "url": "url-value",
  "supportedEntities": "supportedEntities-value"
}

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
  "displayName": "displayName-value",
  "apiVersion": 99,
  "encryption": {
    "protocol": "protocol-value",
    "secret": "secret-value"
  },
  "isActive": true,
  "url": "url-value",
  "supportedEntities": "supportedEntities-value"
}

例 WFM ルールの適格性によるフィルター処理の WorkforceIntegration エンティティの使用例

使用例: 既存の WorkforceIntegration を置き換え、SwapRequest で適格性フィルターを有効にする

要求

要求の例を次に示します。

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/",
  "supports": "Shift,SwapRequest",
  "eligibilityFilteringEnabledEntities": "SwapRequest"
}

応答

応答の例を次に示します。

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/",
  "supports": "Shift,SwapRequest",
  "eligibilityFilteringEnabledEntities": "SwapRequest"
}

SwapRequest が適格性フィルターに対して有効になっている新しい workforceintegration を作成する方法については、「Create」を 参照してください。

SwapRequest が eligibilityFilteringEnabledEntities に含まれている場合の適格シフトのフェッチの例

Shifts アプリとワークフォース統合エンドポイントの間の相互作用は、既存のパターンに従います。

要求

以下は、スワップ要求の適格なシフトをフェッチするために Shifts が workforce 統合エンドポイントに対して行った要求の例です。

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

応答

従業員統合サービスからの応答の例を次に示します。

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