Получение объекта multiValueLegacyExtendedProperty
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Предостережение
Задачи Outlook устарели и не возвращают данные 10 августа 2022 г. Обновите существующие приложения, использующие эту функцию, с задачами Outlook.
Получение экземпляра ресурса, который содержит расширенное свойство с несколькими значениями, с использованием параметра $expand
.
С помощью параметра запроса $expand
вы можете получить указанный экземпляр, дополненный указанным расширенным свойством. Это пока единственный способ получить объект multiValueLegacyExtendedProperty, представляющий расширенное свойство.
Поддерживаются следующие ресурсы пользователей:
Кроме того, поддерживаются следующие ресурсы групп:
Дополнительные сведения о том, когда следует использовать расширенные свойства или открытые расширения и как задавать расширенные свойства, см. в статье Обзор расширенных свойств.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
В зависимости от ресурса, из который вы получаете расширенное свойство, и типа разрешения (делегированного или приложения), которое вы запрашиваете, разрешение, указанное в следующей таблице, является минимальным, необходимым для вызова этого API. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.
Поддерживаемый ресурс | Делегированное (рабочая или учебная учетная запись) | Делегированное (личная учетная запись Майкрософт) | Приложение |
---|---|---|---|
calendar | Calendars.Read | Calendars.Read | Calendars.Read |
contact | Contacts.Read | Contacts.Read | Contacts.Read |
contactFolder | Contacts.Read | Contacts.Read | Contacts.Read |
event | Calendars.Read | Calendars.Read | Calendars.Read |
calendar для групп; | Group.Read.All | Не поддерживается | Не поддерживается |
group event; | Group.Read.All | Не поддерживается | Не поддерживается |
post для групп. | Group.Read.All | Не поддерживается | Group.Read.All |
mailFolder | Mail.Read | Mail.Read | Mail.Read |
message | Mail.Read | Mail.Read | Mail.Read |
Задача Outlook | Tasks.Read | Tasks.Read | Не поддерживается |
Папка задач Outlook | Tasks.Read | Tasks.Read | Не поддерживается |
HTTP-запрос
Вы можете получить экземпляр ресурса, дополненный расширенным свойством, которое соответствует фильтру по свойству id. Убедитесь, что вы применяете кодировку URL для символов пробелов в строке фильтра.
Получение экземпляра объекта message:
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}')
Получение экземпляра объекта 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}')
Получение экземпляра объекта event:
GET /me/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/events/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
Получение экземпляра объекта calendar:
GET /me/calendars/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
GET /users/{id|userPrincipalName}/calendars/{id}?$expand=multiValueExtendedProperties($filter=id eq '{id_value}')
Получение экземпляра объекта contact:
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}')
Получение экземпляра объекта 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}')
Получение экземпляра 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}')
Получите экземпляр 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}')
Получение экземпляра объекта event для группы:
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 | Идентификатор расширенного свойства для сопоставления. Он должен соответствовать одному из поддерживаемых форматов. Дополнительные сведения см. в статье Обзор расширенных свойств Outlook . Обязательный. |
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {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')
Отклик
Основной текст отклика включает в себя все свойства указанного события и расширенное свойство, возвращенное из фильтра.
Примечание. Объект события , показанный здесь, усечен для краткости. При фактическом вызове будут возвращены все свойства.
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"
]
}
]
}