反馈 编辑

更新工作人员集成

  • 项目

命名空间：microsoft.graph

更新 workforceIntegration 对象 的属性。

权限

要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型 权限（从最低特权到最高特权）
委派（工作或学校帐户） WorkforceIntegration.ReadWrite.All
委派（个人 Microsoft 帐户） 不支持。
应用程序 不支持。

注意：此 API 支持管理员权限。 全局管理员可以访问他们不是其成员组。

HTTP 请求

PATCH /teamwork/workforceIntegrations/{workforceIntegrationId}

请求标头

名称 说明
Authorization 持有者 {token}

请求正文

在请求正文中，提供应更新的相关字段的值。 请求正文中不包括的现有属性将保留其以前的值，或根据对其他属性值的更改重新计算。 为了获得最佳性能，请勿加入尚未更改的现有值。

属性 类型 说明
apiVersion Int32 用于回叫 URL 的 API 版本。 从 1 开始。
displayName String 员工集成的名称。
加密 workforceIntegrationEncryption 员工集成加密资源。
isActive 布尔 指示此员工集成当前是否处于活动状态且可用。
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 进行资格筛选的新员工社区，请参阅 创建。

当 SwapRequest 包含在 eligiblyFilteringEnabledEntities 中时提取合格班次的示例

班次应用和员工集成终结点之间的交互将遵循现有模式。

请求

下面是 Shifts 向员工集成终结点请求获取交换请求的合格班次的示例。

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