Поделиться через

Использование API Microsoft Graph для работы с Viva Engage

  • Статья

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

API Microsoft Graph позволяет приложениям управлять сообществами в Viva Engage. Viva Engage — это социальная структура для набора приложений Microsoft Viva, которая объединяет людей в организации, чтобы они делиться и учиться. Это место, где сотрудники могут общаться с лидерами, коллегами и сообществами, делиться своими знаниями и идеями, а также находить принадлежность на работе.

Важно!

API Viva Engage в Microsoft Graph поддерживается только для сетей Viva Engage в собственном режиме. Этот API нельзя использовать для управления устаревшими или внешними сетями Viva Engage.

Авторизация

Чтобы вызвать API Viva Engage в Microsoft Graph, приложению необходимо получить маркер доступа. Подробные сведения о маркерах доступа см. в статье Получение маркеров доступа для вызова Microsoft Graph. Приложению также требуются соответствующие разрешения. Дополнительные сведения см. в статье Справочник по разрешениям Microsoft Graph.

Основные варианты использования

В следующей таблице перечислены распространенные варианты использования API Viva Engage.

Вариант использования API Примечания
Создание сообщества POST /employeeExperience/communities В случае успешного 202 Accepted выполнения этот метод возвращает код ответа, содержащий ссылку на объект engagementAsyncOperation .
Опрос состояния создания сообщества GET /employeeExperience/engagementAsyncOperations/{engagementAsyncOperationId} В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект engagementAsyncOperation в теле отклика. Периодически проверяйте состояние операции, выполняя запрос GET к этому расположению; подождите >30 секунд между проверками. После успешного завершения запроса состояние указывает succeeded , а resourceLocation указывает на созданный или измененный ресурс.
Получение сообщества после создания GET /employeeExperience/community/{communityId} В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект community в тексте ответа. Объект community ссылается на связанный идентификатор группы Microsoft 365 , который можно использовать для управления членством в сообществе и владением.
Получение списка сообществ GET /employeeExperience/communities В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов сообщества Viva Engage в тексте ответа.
Обновление сообщества PATCH /employeeExperience/community/{communityId} В случае успешного выполнения этот метод обновляет существующее сообщество Viva Engage и возвращает 204 No Content код ответа.
Удаление сообщества DELETE /employeeExperience/community/{communityId} В случае успеха этот метод удаляет сообщество Viva Engage вместе со всем связанным с ним содержимым Microsoft 365, включая подключенную группу Microsoft 365, записную книжку OneNote и планы Планировщика. Дополнительные сведения см. в статье Что произойдет при удалении сообщества Viva Engage, подключенного к группам Microsoft 365.
Добавление участников в сообщество POST /groups/{groupId}/members/$ref При добавлении новых участников в группу связанное членство в сообществе автоматически обновляется.
Удаление участника из сообщества DELETE /groups/{groupId}/members/{userId}/$ref При удалении участника из группы связанное членство в сообществе автоматически обновляется.
Добавление администратора сообщества POST /groups/{groupId}/owners/$ref Когда пользователь добавляется в качестве владельца группы, он автоматически становится администратором связанного сообщества.
Удаление администратора сообщества DELETE /groups/{groupId}/owners/{userId}/$ref При удалении владельца группы он перестает быть администратором связанного сообщества. Нельзя удалить последнего владельца (объекта пользователя ) группы.

Сообщества и группы

Для сетей Viva Engage в собственном режиме создание нового сообщества Viva Engage также приводит к созданию подключенной группы Microsoft 365, а также нового сайта SharePoint, записной книжки OneNote и плана Планировщика. Используйте связанную группу для управления операциями в сообществе, например:

  • Добавление и удаление участников группы
  • Управление владением группой
  • Удаление группы
  • Переименование группы
  • Обновление описания группы

Дополнительные сведения о связях между сообществами Viva Engage и группами Microsoft 365 см. в разделе Viva Engage и группы Microsoft 365.

Заметка: Вы не можете использовать API создания группы для подготовки сообщества Viva Engage.

Ограничения API

Вызовы API Viva Engage могут быть ограничены по скорости, что позволяет 10 запросов на пользователя на приложение в течение 30-секундного периода времени. При превышении предельной скорости все последующие запросы возвращают 429 Too Many Requests код ответа.

Инструкции по регулированию в Microsoft Graph см. в статье Руководство по регулированию Microsoft Graph.

Дальнейшие действия

  • Используйте API Microsoft Graph для управления сообществами в Viva Engage.
  • Попробуйте API Viva Engage в обозревателе Graph.