Type de ressource openTypeExtension (extensions d’ouverture)

  • Article

Espace de noms: microsoft.graph

Représente des extensions ouvertes (également appelées extensions de type ouvert et anciennement Office 365 extensions de données), une option d’extensibilité qui offre un moyen simple d’ajouter directement des propriétés non typées à une ressource dans Microsoft Graph.

Les extensions ouvertes ajoutées à une ressource s’affichent dans la propriété de navigation extensions. Chaque extension a une propriété extensionName qui est la seule propriété prédéfinie et accessible en écriture pour toutes les extensions, ainsi que vos données personnalisées. Pour vérifier que les noms d’extension sont uniques, utilisez un format DNS (Domain Name System) inversé qui dépend de votre propre domaine, par exemple com.contoso.ContactInfo. N’utilisez pas le domaine Microsoft (com.microsoft ou com.onmicrosoft) dans un nom d’extension.

Dérive du type abstrait d’extension.

Les ressources suivantes prennent en charge l’extension open :

Remarque : * En raison d’une limitation de service existante, les délégués ne peuvent pas créer d’événements ouverts ajoutés à une extension dans les calendriers de boîte aux lettres partagés. Les tentatives de le faire entraîneront une réponse ErrorAccessDenied.

Pour plus d’informations sur l’extensibilité Microsoft Graph, notamment les limites pour les extensions ouvertes, consultez Ajouter des propriétés personnalisées aux ressources à l’aide d’extensions et Ajout de données personnalisées à des utilisateurs à l’aide des extensions d’ouverture.

Considérations spécifiques à Outlook

Chaque extension ouverte sur une ressource Outlook (événement, message ou contact personnel) est stockée dans une propriété nommée MAPI. Lorsque vous créez des extensions d’ouverture pour Outlook, vous devez considérer les propriétés nommées MAPI comme des ressources limitées de la boîte aux lettres d’un utilisateur. Lorsque le quota de propriétés nommées d’un utilisateur est épuisé, vous ne pouvez plus créer de propriétés nommées pour cet utilisateur. Cela peut se traduire par un comportement inattendu de la part des clients dont le fonctionnement dépend des propriétés nommées.

Suivez les instructions ci-dessous lorsque vous créez des extensions d’ouverture sur des ressources Outlook :

  • Créez le nombre minimum d’extensions requises. Les applications ne doivent généralement pas nécessiter plus d’une extension. Les extensions n’ont pas de propriétés ou de structure définies, vous pouvez donc stocker plusieurs valeurs dans une seule extension.
  • Évitez de nommer les extensions sous un format variable (par exemple, en fonction des entrées utilisateur, etc.). Chaque fois qu’une extension ouverte est créée avec un nouveau nom qui n’a pas été utilisé dans la boîte aux lettres d’un utilisateur auparavant, une nouvelle propriété nommée MAPI est créée. La suppression de l’extension ne supprime pas la propriété nommée.

Utiliser des extensions d’ouverture (pour les ressources Outlook) ou des propriétés étendues

Les extensions d’ouverture constituent la solution recommandée pour la plupart des scénarios impliquant le stockage et l’accès à des données personnalisées. Toutefois, si vous devez accéder à des données personnalisées pour les propriétés MAPI Outlook qui ne sont pas déjà exposées via les métadonnées microsoft API Graph, vous pouvez utiliser les propriétés étendues et son API REST. Vous pouvez vérifier les propriétés qui figurent dans les métadonnées en accédant à https://graph.microsoft.com/v1.0/$metadata.

Méthodes

Méthode Type renvoyé Description
Créer openTypeExtension(in an existing resource instance) or a new todoTask, todoTaskListcontact, event, message, post, todoTask ou todoTaskList qui contient un objet openTypeExtension. Créez un objet openTypeExtension dans une instance de ressource nouvelle ou existante.
Get openTypeExtension Lisez les propriétés et les relations d’objet openTypeExtension.
Update openTypeExtension Mettez à jour l’objet openTypeExtension.
Delete Aucun Supprimez l’objet openTypeExtension.

Propriétés

Propriété Type Description
extensionName String Identificateur de texte unique pour une extension de données de type ouvert. Optional.
id Chaîne Identificateur complet qui concatène le type d’extension avec extensionName. En lecture seule.

L’ID doit être défini pendant l’opération Create de l’une des manières suivantes :
  • Définissez explicitement la propriété id dans le corps de la demande.
  • Définissez une propriété extensionName dans le corps de la demande, et Microsoft Graph affecte automatiquement la même valeur à la propriété id .
    • Dans les mises à jour suivantes, vous pouvez remplacer la valeur de la propriété extensionName par une valeur différente de la valeur id .
    • Dans les mises à jour suivantes, la spécification uniquement de la propriété id dans le corps de la demande supprime automatiquement la propriété extensionName de l’extension ouverte.

Relations

Aucun

Représentation JSON

La représentation JSON suivante montre le type de ressource.

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

Contenu connexe