Тип ресурса event
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Событие в календаре ресурса user или стандартный календарь для ресурса group, представляющего группу Microsoft 365.
Максимальное количество участников в ресурсе event и максимальное количество получателей в ресурсе eventMessage, отправленном из почтового ящика Exchange Online, составляет 500. Дополнительные сведения см. в разделе Ограничения на отправку.
Этот ресурс поддерживает:
- добавление собственных данных к настраиваемым свойствам в виде расширений;
- подписку на уведомления об изменениях;
- отслеживание дополнений, удалений и обновлений с помощью запроса изменений (функция delta).
Примечание. Существует несколько незначительных различий в способе взаимодействия с календарями пользователей, календарями групп и их событиями:
- В ресурсе calendarGroup можно упорядочить только календари пользователей.
- Объекты attachment можно добавлять только в события календарей пользователей, но не в события календарей групп.
- Outlook автоматически принимает все приглашения на собрания от имени группы. Вы можете принимать, предварительно принимать или отклонять приглашения на собрания только для пользовательских календарей.
- Outlook не поддерживает напоминания о событиях группы. Напоминание можно отложить или отключить только для календарей пользователя.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Перечисление событий | Коллекция Event | Получение списка объектов event в почтовом ящике пользователя. В этом списке указаны единичные собрания и главные собрания в соответствующих сериях. |
| Создание события | event | Создание события путем записи в коллекцию экземпляров. |
| Получение события | event | Считывание свойств и отношений объекта event. |
| Обновление события | event | Обновление объекта event. |
| Удаление события | Нет | Удаление объекта event. |
| Получение дельты | Коллекция объектов event | Получение списка событий, которые были добавлены в calendarView (диапазон событий) основного календаря пользователя, обновлены в нем или удалены из него. |
| Пересылка события | Нет | Позволяет организатору или участнику собрания пересылать приглашение на собрание новому получателю. |
| Отмена события | Нет | Отправка сообщения об отмене от организатора всем участникам и отмена указанного собрания. |
| Принять событие | Нет | Принятие указанного события в календаре пользователя. |
| Предварительное принятие | Нет | Принятие под вопросом указанного события в календаре пользователя. |
| Событие "Отклонение" | Нет | Отклонение приглашения на указанное событие в календаре пользователя. |
| Отмена напоминания | Нет | Отключение напоминания для указанного события в календаре пользователя. |
| Откладывание напоминания | Нет | Откладывание напоминания для указанного события в календаре пользователя на другое время. |
| Вывод списка экземпляров события | Коллекция Event | Получение коллекции объектов Event. |
| Вложения | ||
| Список вложений | Коллекция Attachment | Получение всех вложений, добавленных к данным о событии. |
| Добавление вложения | Attachment | Добавление нового вложения к данным о событии путем публикации в коллекции вложений. |
| Открытые расширения | ||
| Создание открытого расширения | openTypeExtension | Создание открытого расширения и добавление настраиваемых свойств в новый или существующий ресурс. |
| Получение открытого расширения | Коллекция объектов openTypeExtension | Получение открытого расширения, определяемого именем расширения. |
| Расширенные свойства | ||
| Создание однозначного свойства | event | Создание одного или нескольких расширенных свойств с одним значением в новом или существующем событии. |
| Получение однозначного свойства | event | Получение событий, которые содержат расширенное свойство с одним значением, с помощью параметра $expand или $filter. |
| Создание свойства с несколькими значениями | event | Создание одного или нескольких расширенных свойств с несколькими значениями в новом или существующем событии. |
| Получение свойства с несколькими значениями | event | Получение события, которое содержит расширенное свойство с несколькими значениями, с помощью параметра $expand. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| allowNewTimeProposals | Boolean |
true Если организатор собрания позволяет приглашенным предложить новое время при ответе; В противном случае — falseзначение . Необязательный параметр. Значение по умолчанию: true. |
| attendees | Коллекция Attendee | Коллекция участников события. |
| body | ItemBody | Текст сообщения, связанного с событием. В формате HTML или текстовом формате. |
| bodyPreview | String | Предварительный просмотр сообщения, связанного с событием. В текстовом формате. |
| categories | Коллекция String | Категории, связанные с событием. Каждая категория соответствует свойству displayName объекта outlookCategory, определенного для пользователя. |
| changeKey | String | Указывает версию объекта события. При каждом изменении события также меняется значение ChangeKey. Благодаря этому Exchange может применять изменения к правильной версии объекта. |
| createdDateTime | DateTimeOffset | Тип Timestamp представляет сведения о времени и дате с использованием формата ISO 8601 (всегда применяется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z. |
| end | DateTimeTimeZone | Дата, время и часовой пояс завершения события. По умолчанию время завершения указано в формате UTC. |
| hasAttachments | Boolean | Задайте значение true, если у события есть вложения. |
| hideAttendees | Boolean | Если присвоено значение true, каждый участник видит только себя в приглашении на собрание и списке собрания Отслеживание. Значение по умолчанию: false. |
| iCalUId | String | Уникальный идентификатор для события в календарях. Этот идентификатор отличается для каждого вхождения повторяющегося ряда. Только для чтения. |
| id | String | Уникальный идентификатор события.
По умолчанию это значение изменяется при перемещении элемента из одного контейнера (например, папки или календаря) в другой. Чтобы изменить это поведение, используйте заголовок Prefer: IdType="ImmutableId". Дополнительные сведения см. в статье Получение неизменяемых идентификаторов для ресурсов Outlook. С учетом регистра и только для чтения. |
| importance | String | Важность события. Допустимые значения: low, normal, high. |
| isAllDay | Boolean | Задайте значение true, если событие длится весь день. Если значение равно true, то независимо от того, один или несколько дней длится событие, время его начала и окончания должно быть установлено на полночь в одном и том же часовом поясе. |
| isCancelled | Boolean | Задайте значение true, если событие отменено. |
| isDraft | Логический | Присвоено значение true, если пользователь обновил собрание в Outlook, но не отправил обновления участникам. Присвоено значение false, если все изменения отправлены или событие является встречей без участников. |
| isOnlineMeeting | Логический |
True, если событие содержит информацию о собрании по сети (т. е. onlineMeeting указывает на ресурс onlineMeetingInfo), в противном случае — false. Значение по умолчанию — false (onlineMeeting — null). Необязательное свойство. После настройки isOnlineMeeting на true Microsoft Graph инициализирует onlineMeeting. Outlook будет игнорировать любые последующие изменения isOnlineMeeting, и собрание останется доступным по сети. |
| isOrganizer | Boolean | Присвоено значение true, если владелец календаря (указанный свойством owner объекта calendar) является организатором события (определятся свойством organizer объекта event). Это также применимо, если делегат организовал событие от имени владельца. |
| isReminderOn | Boolean | Задайте значение true, если установлено напоминание пользователю о событии. |
| lastModifiedDateTime | DateTimeOffset | Тип Timestamp представляет сведения о времени и дате с использованием формата ISO 8601 (всегда применяется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z. |
| location | Location | Место проведения события. |
| locations | Коллекция Location | Места проведения события или участия в нем. Свойства location и locations всегда совпадают друг с другом. Если вы обновите свойство location, предыдущие места в коллекции locations будут удалены и заменены новым значением location. |
| onlineMeeting | OnlineMeetingInfo | Сведения, необходимые участнику, чтобы присоединиться к собранию по сети. Значение по умолчанию — null. Только для чтения. После настройки свойств isOnlineMeeting и onlineMeetingProvider для разрешения собрания по сети Microsoft Graph инициализирует onlineMeeting. После завершения настройки собрание останется доступным по сети, и вы не сможете изменить свойства isOnlineMeeting, onlineMeetingProvider и onlneMeeting. |
| onlineMeetingProvider | onlineMeetingProviderType | Представляет поставщика службы собраний по сети. По умолчанию onlineMeetingProvider — unknown. Возможные значения: unknown, teamsForBusiness, skypeForBusiness и skypeForConsumer. Необязательное свойство. После настройки onlineMeetingProvider Microsoft Graph инициализирует onlineMeeting. После этого вы не сможете изменить onlineMeetingProvider и собрание останется доступным по сети. |
| onlineMeetingUrl | String | URL-адрес для собрания по сети. Свойство будет задано только в том случае, если организатор определяет в Outlook, что событие является собранием по сети, например в Skype. Только для чтения. Чтобы получить доступ к URL-адресу и присоединиться к собранию по сети, воспользуйтесь joinUrl, который предоставляется через свойство event, onlineMeeting. В дальнейшем использовать свойство onlineMeetingUrl не рекомендуется. |
| organizer | Recipient | Организатор события. |
| originalEndTimeZone | String | Часовой пояс завершения, указанный при создании события. Значение tzone://Microsoft/Custom указывает, что традиционный часовой пояс был задан в классическом приложении Outlook. |
| originalStart | DateTimeOffset | Представляет время начала события, когда оно изначально создается как вхождение или исключение в повторяющемся ряду. Это свойство не возвращается для событий, которые являются одиночными экземплярами. Сведения времени и даты представлены в формате ISO 8601 (всегда используется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z. |
| originalStartTimeZone | String | Часовой пояс начала события, указанный при его создании. Значение tzone://Microsoft/Custom указывает, что в классическом приложении Outlook задан традиционный пользовательский часовой пояс. |
| recurrence | PatternedRecurrence | Расписание повторения события. |
| reminderMinutesBeforeStart | Int32 | Позволяет указать, за сколько минут до начала события появляется напоминание. |
| responseRequested | Логический | По умолчанию используется значение true, означающее, что организатор запрашивает у приглашенного отправку ответа для события. |
| responseStatus | ResponseStatus | Указывает тип отклика, отправленного в ответ на сообщение о событии. |
| sensitivity | String | Возможные значения: normal, personal, private, confidential. |
| seriesMasterId | String | Идентификатор для элемента образца повторяющегося ряда, если это событие входит в повторяющийся ряд. |
| showAs | String | Отображаемое состояние. Возможные значения: free, tentative, busy, oof, workingElsewhere, unknown. |
| start | DateTimeTimeZone | Дата, время и часовой пояс начала события. По умолчанию время начала указано в формате UTC. |
| subject | String | Текст в строке темы сообщения о событии. |
| transactionId | Строка | Настраиваемый идентификатор, указанный клиентским приложением серверу во избежание лишних операций POST в том случае, если клиент попробует снова создать одно и то же событие. Это полезно в тех случаях, когда из-за плохого сетевого подключения клиент отключается, не успев получить от сервера ответ на предыдущий запрос клиента на создание события. После того, как при создании события вы настроили transactionId, вы можете изменить transactionId в последующем обновлении. Это свойство возвращается только в полезных данных ответа, если такая настройка была сделана в приложении. Необязательное свойство. |
| type | String | Тип события. Возможные значения: singleInstance, occurrence, exception, seriesMaster. Только для чтения |
| webLink | String | URL-адрес для открытия события в Outlook в Интернете. Outlook в Интернете открывает это событие в браузере, если выполнен вход в почтовый ящик. В противном случае Outlook в Интернете предлагает выполнить вход. Доступ к этому URL-адресу невозможно получить из элемента iFrame. |
Примечание.
Свойство webLink указывает URL-адрес, по которому можно открыть событие только в более ранних версиях Outlook в Интернете. Ниже представлен формат URL-адреса, где {event-id} — это зашифрованное в виде URL-адреса значение свойства id.
Для рабочих или учебных учетных записей:
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemДля учетных записей Майкрософт:
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Чтобы открыть событие в текущей версии Outlook в Интернете, преобразуйте URL-адрес в один из следующих форматов и используйте этот URL-адрес для открытия события:
Для рабочих или учебных учетных записей:
https://outlook.office365.com/calendar/item/{event-id}Для учетных записей Майкрософт:
https://outlook.live.com/calendar/item/{event-id}
Связи
| Связь | Тип | Описание |
|---|---|---|
| attachments | Коллекция Attachment | Коллекция вложений FileAttachment, ItemAttachment и referenceAttachment для события. Свойство навигации. Только для чтения. Допускается значение null. |
| calendar | Calendar | Календарь, который содержит событие. Свойство навигации. Только для чтения. |
| extensions | Коллекция extension | Коллекция открытых расширений, определенных для события. Допускается значение null. |
| instances | Коллекция Event | Вхождения в повторяющемся ряду, если событие является основным в ряду. Это свойство включает вхождения, которые являются частью расписания повторения, и исключения, которые были изменены, но не включает повторения, которые были отменены в ряду. Свойство навигации. Только для чтения. Допускается значение null. |
| multiValueExtendedProperties | Коллекция multiValueLegacyExtendedProperty | Коллекция расширенных свойств с несколькими значениями, определенных для события. Только для чтения. Допускается значение null. |
| singleValueExtendedProperties | Коллекция singleValueLegacyExtendedProperty | Коллекция расширенных свойств с одним значением, определенных для события. Только для чтения. Допускается значение null. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"allowNewTimeProposals": "Boolean",
"attendees": [{"@odata.type": "microsoft.graph.attendee"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"categories": ["string"],
"changeKey": "string",
"createdDateTime": "String (timestamp)",
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"hasAttachments": true,
"hideAttendees": false,
"id": "string (identifier)",
"importance": "String",
"isAllDay": true,
"isCancelled": true,
"isDraft": false,
"isOnlineMeeting": true,
"isOrganizer": true,
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"locations": [{"@odata.type": "microsoft.graph.location"}],
"onlineMeeting": {"@odata.type": "microsoft.graph.onlineMeetingInfo"},
"onlineMeetingProvider": "string",
"onlineMeetingUrl": "string",
"organizer": {"@odata.type": "microsoft.graph.recipient"},
"originalEndTimeZone": "string",
"originalStart": "String (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderMinutesBeforeStart": 1024,
"responseRequested": true,
"responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
"sensitivity": "String",
"seriesMasterId": "string",
"showAs": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"type": "String",
"webLink": "string",
"attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"extensions": [ { "@odata.type": "microsoft.graph.extension" } ],
"instances": [ { "@odata.type": "microsoft.graph.event" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }]
}
Связанные материалы
- Отслеживание изменений данных Microsoft Graph с помощью запроса изменений
- Получение добавочных изменений для событий в папке
- Добавление пользовательских данных в ресурсы с помощью расширений
- Добавление пользовательских данных в ресурсы user с помощью открытых расширений
- Добавление пользовательских данных в группы с помощью расширений схемы
- Пример массовых собраний на C#
- Пример массовых собраний Node.js