Заметка
Доступ к этой странице требует авторизации. Вы можете попробовать войти в систему или изменить каталог.
Доступ к этой странице требует авторизации. Вы можете попробовать сменить директорию.
API календаря Microsoft Graph предоставляет календарь, calendarGroup, события и другие ресурсы, которые позволяют создавать события и собрания, находить рабочее время собраний, управлять участниками и многое другое. С помощью API календаря можно создавать различные возможности для работы с данными календаря.
Управление событиями и собраниями
Тип события представляет запланированное событие в календаре, например собрание, праздник или временной блок. Собрания, такие как собрания группы или собрания один на один, представлены ресурсами событий . Вы можете напрямую управлять жизненным циклом событий, создавая, отменяя и удаляя события напрямую, помимо других действий. Кроме того, можно создавать черновики сообщений о событиях, отправлять их, пересылать их, а также создавать черновики ответов и многое другое. Работая с сообщениями о событиях, пользователь может принимать активную роль в создании событий и собраний. Вы также позволяете им общаться с источниками собраний, другими получателями и участниками.
Прямая работа с событиями
Microsoft API Graph предоставляет методы для таких операций, как создание, обновление, удаление и отмена событий. В следующей таблице перечислены некоторые распространенные варианты использования событий жизненного цикла и API, предоставляемые Microsoft Graph для работы с ними.
| Вариант использования | Глагол | Пример URL-адреса |
|---|---|---|
| Создайте событие. | POST | /users/{id | userPrincipalName}/events |
| Удаление события из календаря. | DELETE | /users/{id | userPrincipalName}/events/{id} |
|
Отмена события и отправка сообщения об отмене. Примечание. Укажите необязательное сообщение об отмене в тексте запроса. |
POST | /users/{id | userPrincipalName}/events/{id}/cancel |
|
Обновление события. Примечание. Укажите сведения о событии для обновления в тексте запроса. |
PATCH | /users/{id | userPrincipalName}/events/{id} |
| Примите событие. | POST | /users/{id | userPrincipalName}/events/{id}/accept |
| Предварительно примите событие. | POST | /users/{id | userPrincipalName}/events/{id}/tentativelyAccept |
| Отклонить событие. | POST | /users/{id | userPrincipalName}/events/{id}/decline |
| Закрыть напоминание о событии. | POST | /users/{id | userPrincipalName}/events/{id}/dismissReminder |
| Откладывать напоминание о событии. | POST | /users/{id | userPrincipalName}/events/{id}/snoozeReminder |
Работа с сообщениями о событиях
Ресурс eventMessage — это абстрактный тип, представляющий приглашения на собрания, отмены и ответы. Ответы создаются, когда получатель сообщения принимает, предварительно принимает или отклоняет запрос. Обработка eventMessageRequest и eventMessageResponse перемещает событие через его жизненный цикл. API обмена сообщениями в API календаря поддерживают содержимое MIME и JSON.
В следующей таблице перечислены некоторые распространенные варианты использования сообщений о событиях и API для работы с ними.
| Вариант использования | Глагол | Пример URL-адреса |
|---|---|---|
| Отправка существующего черновика сообщения. | POST | /users/{id | userPrincipalName}/messages/{id}/send |
| Создайте черновик ответа. | POST | /users/{id | userPrincipalName}/messages/{id}/createReply |
| Ответ на сообщение о событии. | POST | /users/{id | userPrincipalName}/messages/{id}/reply |
| Создайте черновик сообщения для всех ответов. | POST | /users/{id | userPrincipalName}/messages/{id}/createReplyAll |
| Ответ всем в сообщении о событии. | POST | /users/{id | userPrincipalName}/messages/{id}/replyAll |
| Создайте черновик пересылки. | POST | /users/{id | userPrincipalName}/messages/{id}/createForward |
| Пересылка сообщения о событии. | POST | /users/{id | userPrincipalName}/messages/{id}/forward |
Добавление и удаление вложений
Абстрактный тип вложения служит основой для файлов, элементов и ссылок, которые присоединяются к событиям, сообщениям и публикациям. Вы можете просмотреть вложения для события, например с помощью метода List attachments . Вы можете удалить вложение с помощью метода Delete attachment . События в групповых календарях не поддерживают вложения.
Типы вложений
Типы fileAttachment, itemAttachment и referenceAttatchment представляют три типа элементов, которые могут быть присоединены к элементам календаря. Объект itemAttachment представляет контакт, событие или сообщение, которое напрямую связано с событием пользователя, сообщением или публикацией. FileAttachment представляет файл, который подключен напрямую. ReferenceAttachment представляет элемент, например Word документ или текстовый файл, который находится на рабочем или учебном облачном диске OneDrive или другом поддерживаемом расположении хранилища. Например, чтобы просмотреть все вложения для события, можно использовать конечную точку GET /users/{id | userPrincipalName}/events/{id}/attachments .
Отправка вложений
Вы можете напрямую отправлять вложения размером менее 3 МБ в событие для пользователя с помощью метода Добавить вложение . Однако для вложения размером более 3 МБ необходимо использовать метод attachment: createUploadSession , чтобы получить URL-адрес отправки, используемый для итеративной отправки вложения.
Работа с календарями, группами календарей и категориями Outlook
С помощью API календаря можно создавать, читать, обновлять и удалять календари, создавать и просматривать события календаря, получать сведения о доступности для пользователей и находить рекомендуемое время собраний.
API календаря предоставляет методы для работы с календарями и группами календарей. В следующей таблице показаны некоторые варианты использования с выбранными URL-адресами.
Примечание. Многие методы, показанные в следующей таблице, имеют другие URL-адреса для связанных вариантов использования. Например, чтобы обновить календарь пользователя в определенной группе календарей, отправьте операцию PATCH с URL-адресом
/users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}.
| Вариант использования | Глагол | Пример URL-адреса |
|---|---|---|
| Вывод списка календарей для пользователя. | GET | /users/{id | userPrincipalName}/calendars |
| Вывод списка календарей пользователя в группе. | GET | /users/{id | userPrincipalName}/calendarGroups/{calendarGroupId}/calendars |
| Создайте календарь. | POST | /users/{id | userPrincipalName}/calendars |
| Получение календаря. | GET | /users/{id | userPrincipalName}/calendars/{id} |
| Обновление календаря. | PATCH | /users/{id | userPrincipalName}/calendars/{id} |
| Удаление календаря. | DELETE | /users/{id | userPrincipalName}/calendars/{id} |
| Создайте группу календаря. | POST | /users/{id | userPrincipalName}/calendarGroups |
| Получение группы календаря. | GET | /users/{id | userPrincipalName}/calendarGroups/{id} |
| Обновление группы календаря. | PATCH | /users/{id | userPrincipalName}/calendarGroups/{id} |
| Удаление группы календаря. | DELETE | /users/{id | userPrincipalName}/calendarGroups/{id} |
Данные о доступности и время собраний
Две основные функции календаря — это поиск сведений о доступности и время собраний для планирования собраний. API календаря предоставляет метод get free/busy schedule , который возвращает коллекцию объектов scheduleInformation за период времени и коллекцию пользователей, ресурсов или списков рассылки. Эти сведения можно представить пользователю, чтобы он вручную выбрал подходящее время для планирования собрания. Используйте метод user: findMeetingTimes , чтобы получить meetingTimeSuggestionResult , содержащий коллекцию объектов meetingTimeSuggestion , которые представляют подробные сведения о предполагаемом времени собрания для участников и ограничениях, которые вы отправили.
Категории Outlook
Категория календаря — это сочетание описания и categoryColor , которые вместе определяют категорию для элемента Outlook и управляют отображением элемента Outlook. Пользователи Outlook могут группировать сообщения и события, например по категориям. Дополнительные сведения см. в разделе outlookCategory.
Разрешения календаря
Когда пользователи совместно используют календари с другими пользователями из клиентов Outlook, они могут управлять элементами календаря, которые получатели могут просматривать или изменять. Связь calendarPermissions содержит разрешения для каждого пользователя, с которым пользователь предоставил общий доступ к календарю. Эта связь позволяет, например, узнать, какие пользователи могут просматривать сведения о доступности владельца, просматривать все сведения о календаре или изменять события в календаре.
Работа с открытыми расширениями и расширенными свойствами
Открытые расширения, ранее известные как Office 365 расширения данных, представляют собой предпочтительный способ хранения пользовательских данных и доступа к ним для ресурсов в почтовом ящике пользователя. Если свойство MAPI Outlook недоступно в метаданных Microsoft API Graph, вы можете вернуться к расширенным свойствам Outlook. Дополнительные сведения см. в статье Обзор расширенных свойств Outlook.
Дальнейшие действия
API календаря в Microsoft Graph позволяет создавать ряд возможностей для работы с данными календаря. Чтобы узнать больше:
- Изучите подробнее методы и свойства ресурсов, наиболее полезных для вашего сценария.
- Опробуйте API в песочнице Graph.