更新架构

命名空间:microsoft.graph.externalConnectors

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

更新 externalConnection架构的属性。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All

HTTP 请求

PATCH /external/connections/{connectionId}/schema

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。
首选:respond-async 使用此方法可导致请求以异步方式执行。 可选。

请求正文

在请求正文中,提供 架构 对象的 JSON 表示形式。

注册自定义项架构时, 架构 对象 必须将baseType 属性设置为 microsoft.graph.externalItem ,并且 必须 包含 属性 属性。 properties 对象必须至少包含一个属性,最多 128 个。

响应

如果成功,此方法在 202 Accepted 响应标头中 Location 返回响应代码和 URL,可用于 获取操作状态

示例

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/beta/external/connections/contosohr/schema
Content-type: application/json

{
  "baseType": "microsoft.graph.externalItem",
  "properties": [
    {
      "name": "ticketTitle",
      "type": "string",
      "isSearchable": "true",
      "isRetrievable": "true",
      "labels": [
        "title"
      ]
    },
    {
      "name": "priority",
      "type": "string",
      "isQueryable": "true",
      "isRetrievable": "true",
      "isSearchable": "false"
    },
    {
      "name": "assignee",
      "type": "string",
      "isRetrievable": "true"
    }
  ]
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/beta/external/connections/contosohr/operations/616bfeed-666f-4ce0-8cd9-058939010bfc