openTypeExtension 资源类型（开放扩展）

  • 项目

命名空间：microsoft.graph

表示开放扩展 (也称为开放类型扩展，以前称为Office 365数据扩展插件) ，这是一种扩展性选项，提供了一种直接将非类型化属性添加到 Microsoft Graph 中的资源的简单方法。

添加到资源的任何打开扩展都显示在 扩展 导航属性中。 每个扩展都有一个 extensionName 属性，该属性是所有扩展以及自定义数据的唯一预定义的可写属性。 一种有助于确保扩展名称唯一性的方法是，使用反向域名系统 (DNS) 格式，此格式依赖用户自己的域。例如，com.contoso.ContactInfo。 请勿 在扩展名称中使用 Microsoft 域 (com.microsoft 或 com.onmicrosoft) 。

派生自 扩展 抽象类型。

以下资源支持开放扩展：

注意： * 由于现有服务限制，代理人无法在共享邮箱日历中创建打开的附加扩展事件。 尝试这样做将导致 ErrorAccessDenied 响应。

有关 Microsoft Graph 扩展性（包括开放扩展的限制）的详细信息，请参阅 使用扩展向资源添加自定义属性 ，以及 使用开放扩展向用户添加自定义数据。

Outlook 特定注意事项

Outlook 资源上每个打开的扩展 (事件、邮件或个人联系人) 存储在 MAPI 命名属性中。 为 Outlook 创建开放扩展时，请考虑 MAPI 命名属性为用户邮箱中的有限资源。 如果用户的命名属性配额已用完，则无法再为该用户创建命名属性。 这可能会导致依赖命名属性工作的客户端中出现异常行为。

在 Outlook 资源中创建开放扩展时，请遵循以下指导原则：

  • 创建所需的最少数量的扩展。 大多数应用程序只需要一个扩展。 扩展没有定义的属性或结构，因此可以在单个扩展中存储多个值。
  • 避免以可变方式命名扩展，如基于用户输入等。 每次使用之前未在用户邮箱中使用的新名称创建打开的扩展时，都会创建一个新的 MAPI 命名属性。 删除扩展不会删除命名属性。

使用开放扩展（针对 Outlook 资源）或扩展属性

开放扩展是大部分涉及存储和访问自定义数据的应用场景的推荐解决方案。 但是，如果需要访问尚未通过 Microsoft 图形 API 元数据公开的 Outlook MAPI 属性的自定义数据，则可以使用扩展属性及其 REST API。 若要确认元数据公开了哪些属性，请访问 https://graph.microsoft.com/v1.0/$metadata。

方法

方法 返回类型 说明
创建 openTypeExtension (现有资源实例) ，或者包含 openTypeExtension 对象的新的 todoTask、 todoTaskList联系人、 事件、 消息、 post、 todoTask 或 todoTaskList 。 在现有的或新的资源实例中创建 openTypeExtension 对象。
获取 openTypeExtension 读取 openTypeExtension 对象的属性和关系。
更新 openTypeExtension 更新 openTypeExtension 对象。
删除 无 删除 openTypeExtension 对象。

属性

属性 类型 说明
extensionName String 开放类型数据扩展的唯一文本标识符。 可选。
id String 连接具有 extensionName 扩展类型的完全限定的标识符 。 此为只读属性。

必须在创建操作期间通过以下方法之一定义 ID：
  • 在请求正文中显式定义 id 属性。
  • 在请求正文中定义 extensionName 属性，Microsoft Graph 会自动为 id 属性分配相同的值。
    • 在后续更新中，可以将 extensionName 属性值更改为不同于 ID 值的值。
    • 在后续更新中，在请求正文中仅指定 id 属性会自动从打开的扩展中删除 extensionName 属性。

关系

无

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "extensionName": "string",
  "id": "String (identifier)"
}

相关内容