Тип ресурсов openTypeExtension (открытые расширения)

Пространство имен: microsoft.graph

Представляет открытые расширения (также известные как расширения открытого типа и ранее известные как расширения данных Office 365) — параметр расширяемости, который обеспечивает простой способ прямого добавления нетипизированных свойств к ресурсу в Microsoft Graph.

Любое открытое расширение, добавленное к ресурсу, отображается в свойстве навигации расширений. У каждого расширения есть свойство extensionName , которое является единственным предопределенным свойством, доступным для записи для всех расширений, наряду с вашими пользовательскими данными. Чтобы обеспечить уникальность имен расширений, можно использовать формат обратных DNS, который зависит от принадлежащего вам домена, например com.contoso.ContactInfo. Не используйте домен Microsoft (com.microsoftcom.onmicrosoftили ) в имени расширения.

Производный от абстрактного типа расширения.

Следующие ресурсы поддерживают открытое расширение:

Примечание. * Из-за существующего ограничения службы делегаты не могут создавать открытые события с добавлением расширений в календарях общих почтовых ящиков. Попытка сделать это приведет к ответу ErrorAccessDenied.

Дополнительные сведения о расширяемости Microsoft Graph, включая ограничения для открытых расширений, см. в разделе Добавление настраиваемых свойств к ресурсам с помощью расширений и Добавление настраиваемых данных для пользователей с помощью открытых расширений.

Специальные рекомендации для Outlook

Каждое открытое расширение ресурса Outlook (событие, сообщение или личный контакт) хранится в именованном свойстве MAPI. Создавая открытые расширения для Outlook, учитывайте, что именованные свойства MAPI в почтовом ящике пользователя — это ограниченный ресурс. Если квота именованных свойств пользователя исчерпана, вы больше не сможете создавать именованные свойства для этого пользователя. Это может привести к неожиданным действиям пользователей, для работы которых необходимы именованные свойства.

Руководствуйтесь приведенными ниже рекомендациями при создании открытых расширений в ресурсах Outlook.

  • Создайте минимум необходимых расширений. Большинству приложений должно потребоваться не более одного расширения. Расширения не имеют определенных свойств или структуры, поэтому вы можете хранить несколько значений в одном расширении.
  • Избегайте несогласованного именования расширений (например, на основании вводимых пользователями данных и т. д.). При каждом создании открытого расширения с новым именем, которое ранее не использовалось в почтовом ящике пользователя, создается новое именованное свойство MAPI. Удаление расширения не приводит к удалению именованного свойства.

Использование открытых расширений (для ресурсов Outlook) или расширенных свойств

Открытые расширения — рекомендуемое решение для большинства сценариев, предполагающих хранение пользовательских данных и доступ к ним. Однако если вам требуется доступ к пользовательским данным для свойств MAPI Outlook, которые еще не предоставляются через метаданные Microsoft API Graph, вы можете использовать расширенные свойства и его REST API. Вы можете проверить, какие свойства предоставляют метаданные в https://graph.microsoft.com/v1.0/$metadata.

Методы

Метод Возвращаемый тип Описание
Создание openTypeExtension (в существующем экземпляре ресурса) или новый todoTask, todoTaskList, контакт, событие, сообщение, заметка или публикация , содержащие объект openTypeExtension. Создание объекта openTypeExtension в существующем или новом экземпляре ресурса.
Get openTypeExtension Чтение свойств и связей объекта openTypeExtension.
Update openTypeExtension Обновление объекта openTypeExtension.
Delete Нет Удаление объекта openTypeExtension.

Свойства

Свойство Тип Описание
extensionName String Уникальный текстовый идентификатор для модуля обработки данных открытого типа. Необязательный параметр.
id String Полный идентификатор, в котором сцеплены тип расширения и свойство extensionName. Только для чтения.

Идентификатор должен быть определен в ходе операции Create одним из следующих способов:
  • Явное определение свойства id в тексте запроса.
  • Определите свойство extensionName в тексте запроса, и Microsoft Graph автоматически присвоит такое же значение свойству id .
    • В последующих обновлениях вы можете изменить значение свойства extensionName на значение, отличное от значения id .
    • В последующих обновлениях указание только свойства id в тексте запроса автоматически удаляет свойство extensionName из открытого расширения.

Связи

Нет

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "extensionName": "string",
  "id": "String (identifier)"
}

Связанные материалы

  • Last updated on