获取 multiValueLegacyExtendedProperty

命名空间：microsoft.graph

重要

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

警告

Outlook 任务在 2022 年 8 月 10 日已弃用并停止返回数据。 通过 Outlook 任务更新使用此功能的现有应用。

使用 $expand 获取包含多值扩展属性的资源实例。

使用查询参数 $expand，可以获取使用指明的扩展属性扩展的指定实例。 这是当前获取 multiValueLegacyExtendedProperty 对象（表示扩展属性）的唯一方式。

支持以下用户资源：

• 日历
• 联系人
• contactFolder
• 事件
• mailFolder
• 邮件
• Outlook 任务
• Outlook 任务文件夹

以及以下组资源：

• 组 日历
• 组 事件
• 组帖子

有关何时使用开放扩展或扩展属性，以及如何指定扩展属性的详细信息，请参阅扩展属性概述。

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

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

权限

根据要从中获取扩展属性的资源以及请求 (委托或应用程序) 的权限类型，下表中指定的权限是调用此 API 所需的最低权限。 若要了解详细信息，包括如何选择权限的信息，请参阅权限。

支持的资源	委派（工作或学校帐户）	委派（个人 Microsoft 帐户）	应用程序
calendar	Calendars.Read	Calendars.Read	Calendars.Read
联系人	Contacts.Read	Contacts.Read	Contacts.Read
contactFolder	Contacts.Read	Contacts.Read	Contacts.Read
event	Calendars.Read	Calendars.Read	Calendars.Read
组 日历	Group.Read.All	不支持	不支持
组 事件	Group.Read.All	不支持	不支持
组帖子	Group.Read.All	不支持	Group.Read.All
mailFolder	Mail.Read	Mail.Read	Mail.Read
邮件	Mail.Read	Mail.Read	Mail.Read
Outlook 任务	Tasks.Read	Tasks.Read	不支持
Outlook 任务文件夹	Tasks.Read	Tasks.Read	不支持

HTTP 请求

获取通过与 id 属性中的筛选器匹配的扩展属性展开的资源实例。 请确保对筛选器字符串中的空白字符应用 URL 编码。

获取邮件实例：

GET /me/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/mailFolders/{id}/messages/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取 mailFolder 实例：

GET /me/mailFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/mailFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取事件实例：

GET /me/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取日历实例：

GET /me/calendars/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/calendars/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取联系人实例：

GET /me/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/contactFolders/{id}/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}/contacts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取 contactFolder 实例：

GET /me/contactfolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/contactFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取 outlookTask 实例：

GET /me/outlook/tasks/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/outlook/tasks/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/outlook/taskFolders/{id}/tasks/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/outlook/taskFolders/{id}/tasks/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/outlook/taskGroups/{id}/taskFolders/{id}/tasks/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}/tasks/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取 outlookTaskFolder 实例：

GET /me/outlook/taskFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/outlook/taskFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /me/outlook/taskGroups/{id}/taskFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

注意

调用 /me 终结点需要已登录的用户，因此需要委派权限。 使用 /me 终结点时，不支持应用程序权限。

获取组事件实例：

GET /groups/{id}/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

获取组 post 实例：

GET /groups/{id}/threads/{id}/posts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /groups/{id}/conversations/{id}/threads/{id}/posts/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')

路径参数

参数	类型	说明
id_value	String	要匹配的扩展属性的 ID。 它必须遵照其中一种支持的格式。 有关详细信息，请参阅 Outlook 扩展属性概述。 必需。

请求标头

名称	说明
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。

请求正文

请勿提供此方法的请求正文。

响应

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

响应正文包括通过匹配的 multiValueLegacyExtendedProperty 对象扩展的对象，此对象表示请求的资源实例。

示例

请求

此示例通过包含一个多值扩展属性获取并扩展指定的事件。 此筛选器返回其 id 与字符串 StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation（包含 URL 编码，此处为了便于阅读，已将其删除）匹配的扩展属性。

GET https://graph.microsoft.com/beta/me/events('AAMkAGE1M2_bs88AACbuFiiAAA=')?$expand=multiValueExtendedProperties($filter=id%20eq%20'StringArray%20{66f5a359-4659-4830-9070-00050ec6ac6e}%20Name%20Recreation')

响应

响应正文包括指定事件的所有属性以及此筛选器返回的扩展属性。

注意：为了简单起见，会将此处所示的 event 对象截断。 将从实际调用中返回所有属性。

HTTP/1.1 200 OK
Content-type: application/json
{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Me/events/$entity",
    "@odata.id": "https://graph.microsoft.com/beta/users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/events('AAMkAGE1M2_bs88AACbuFiiAAA=')",
    "@odata.etag": "W/\"mODEKWhc/Um6lA3uPm7PPAAAm8k15A==\"",
    "id": "AAMkAGE1M2_bs88AACbuFiiAAA=",
    "start": {
        "dateTime": "2015-11-26T17:00:00.0000000",
        "timeZone": "UTC"
    },
    "end": {
        "dateTime": "2015-11-30T05:00:00.0000000",
        "timeZone": "UTC"
    },
    "organizer": {
        "emailAddress": {
            "name": "Christine Irwin",
            "address": "christine@contoso.com"
        }
    },
    "multiValueExtendedProperties": [
        {
            "id": "StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation",
            "value": [
                "Food",
                "Hiking",
                "Swimming"
            ]
        }
    ]
}