创建 externalItem

命名空间:microsoft.graph.externalConnectors

重要

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

创建新的 externalItem

此 API 可用于创建自定义项。 包含 externalConnection架构 必须已注册相应类型。

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

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

权限

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

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

HTTP 请求

PUT /external/connections/{connection-id}/items/{item-id}

路径参数

参数 类型 说明
connection-id string id包含 externalConnection 的 属性
item-id string externalItem 的开发人员提供id的属性。 如果此 id已不存在任何项,则会创建一个新项。 如果已存在带有此 id的项,则正文中发送的对象会覆盖它。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供 externalItem 对象的 JSON 表示形式。 有效负载限制为 4 MB。

创建 externalItem

创建 externalItem时,需要以下字段: acl、 和 properties。 对象 properties 必须至少包含一个属性。

所有 DateTime 类型属性都必须采用 ISO 8601 格式。

在以下方案中, 上的 externalItem 属性应使用有效负载中的类型说明符:

  • 对于 String 类型属性,如果值包含非 ASCII 字符,则为 。

    "description@odata.type": "String",
    "description": "Kandierte Äpfel"
    
  • 对于所有集合类型。

    "categories@odata.type": "Collection(String)"
    "categories": [
      "red",
      "blue"
    ]
    

    重要

    当包含 类型的 Collection(DateTime)属性时,必须使用类型说明符 Collection(DateTimeOffset)

响应

如果成功,此方法返回 200 OK 响应代码。

示例

示例:创建自定义项

请求

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

PUT https://graph.microsoft.com/beta/external/connections/contosohr/items/TSP228082938
Content-type: application/json

{
  "acl": [
    {
      "type": "user",
      "value": "e811976d-83df-4cbd-8b9b-5215b18aa874",
      "accessType": "grant",
      "identitySource": "azureActiveDirectory"
    },
    {
      "type": "group",
      "value": "14m1b9c38qe647f6a",
      "accessType": "deny",
      "identitySource": "external"
    }
  ],
  "properties": {
    "title": "Error in the payment gateway",
    "priority": 1,
    "assignee": "john@contoso.com"
  },
  "content": {
    "value": "Error in payment gateway...",
    "type": "text"
  }
}

响应

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

HTTP/1.1 200 OK