À propos de la référence d'entité

Cette référence permet de connaître les opérations disponibles qui peuvent être effectuées pour des entités spécifiques, les attributs par défaut de chaque entité ainsi que les relations entre les entités.

Note

Cette référence est générée à partir d’un client avec plusieurs solutions de Dynamics 365 installées, mais n’est pas personnalisée. Cela inclut les entités qui n’existent peut-être pas dans votre environnement, car ces solutions ne sont pas installées. Les entités, attributs et relations personnalisés ne peuvent pas être inclus ici.

Cette référence inclut uniquement les entités où :

  • IsPrivate a la valeur false
    • Cela exclut les entités où aucun cas d’utilisation externe n’existe.
  • IsIntersect a la valeur false
    • Cela exclut les entités utilisées pour définir les relations plusieurs-à-plusieurs.
  • L’entité prend en charge un certain type d’opération.
    • Cela exclut les entités que vous ne pouvez pas utiliser.

Pour afficher toutes les informations sur les métadonnées d’entité pour votre environnement, voir Parcourir les métadonnées pour votre organisation.

Messages

Les messages de cette liste s’appliquent à l’entité. Par exemple, les entités appartenant à l’utilisateur prennent en charge les messages Assign, GrantAccess, ModifyAccess et RevokeAccess, contrairement aux entités appartenant à l’organisation. D’autres entités ont des messages spécialisés, comme DeleteAuditData, qui ne s’applique qu’à l’Entité Audit.

Service d’organisation

Lorsque vous utilisez le service d’organisation, vous pouvez généralement appeler la classe de demande correspondante qui appartient aux espaces de noms Microsoft.Crm.Sdk.Messages ou Microsoft.Xrm.Sdk.Messages. Ces classes ont des noms avec le préfixe Request ajouté au nom du message.

Certains messages sont ajoutés comme actions personnalisées pour les solutions qu’ils prennent en charge. Ces messages ne sont pas définis dans les assemblys du SDK, mais les développeurs .NET peuvent générer des classes fortement typées pour les actions à l’aide de l’outil de génération de code (CrmSvcUtil.exe) ou de la classe OrganizationRequest. Pour plus d’informations : Générer des types à liaison anticipée pour une action.

API Web

Lorsque vous utilisez l’API web, vous pouvez généralement appeler la fonction ou l’action correspondante portant le même nom que le message. Tous les messages pouvant être appelés à l’aide des assemblys du SDK ont une fonction ou action correspondante de l’API web. Par exemple, le message SetState est déconseillé et n’a pas été implémenté dans l’API web.

Propriétés de l’entité

Cette section contient certaines propriétés d’entité, mais pas toutes. Seules les propriétés censées être les plus utiles pour les développeurs sont incluses. Certaines propriétés d’entité peuvent être modifiées. Si vous devez rechercher des propriétés non répertoriées ici, ou pour afficher les valeurs de propriété actuelles dans votre environnement, voir Parcourir les métadonnées pour votre organisation.

Attributs

Les attributs sont répertoriés dans deux sections distinctes : Attributs accessibles en écriture et Attributs en lecture seule. L’objectif de cette séparation est de vous concentrer sur les attributs qu’un développeur peut définir lorsqu’il crée ou met à jour une instance d’entité. Connaître ces attributs permet à un développeur de savoir ce qu’il peut faire avec l’entité au-delà de la simple récupération des valeurs.

Les attributs de la section Attributs accessibles en écriture renvoient la valeur true pour soit les propriétés IsValidForCreate ou IsValidForUpdate, (généralement les deux). Si l’une de ces propriétés renvoient la valeur false, cela est indiqué.

Les Attributs en lecture seule renvoient toujours la valeur false pour les propriétés IsValidForCreate et IsValidForUpdate.

Relations

La classe EntityMetadata comporte trois propriétés pour représenter les relations :

Propriété Type Description
OneToManyRelationships OneToManyRelationshipMetadata[] Obtient le tableau des relations un-à-plusieurs pour l’entité.
ManyToOneRelationships OneToManyRelationshipMetadata[] Obtient le tableau des relations plusieurs-à-un pour l’entité.
ManyToManyRelationships ManyToManyRelationshipMetadata[] Obtient le tableau des relations plusieurs-à-plusieurs pour l’entité.

Note

Il est important de garder à l’esprit que chaque entité répertorie les relations qui lui sont appliquées, mais chaque relation est partagée par les deux entités associées. Les relations existent entre les entités. Les relations un-à-plusieurs existent, mais les relations plusieurs-à-un sont une simple vue des relations un-à-plusieurs à partir de l’entité de référencement.

Relations un-à-plusieurs

Afin de montrer qu’il n’existe pas de relation plusieurs-à-un réelle avec un minimum de confusion, les détails de chaque relation ne sont documentés qu’une seule fois. Chaque relation un-à-plusieurs est répertoriée avec l’entité référencée et comprend certains détails de la relation et un lien vers la relation plusieurs-à-un correspondante. Chaque relation plusieurs-à-un répertoriée inclut uniquement un lien vers la relation un-à-plusieurs correspondante.

Relations plusieurs-à-plusieurs

Chaque relation plusieurs-à-plusieurs inclut Entity1LogicalName et Entity2LogicalName. Pour cette documentation, les détails de la relation sont inclus dans la rubrique uniquement pour Entity1. Chaque relation plusieurs-à-plusieurs où l’entité est Entity2 contient uniquement un lien vers les détails disponibles dans la rubrique pour Entity1.

Note

Les concepts et opérations du développeur liés à la vente dans Dynamics 365 Customer Engagement (on-premises) sont similaires à Dynamics 365 Sales. Pour obtenir des informations sur l’extensibilité des entités liés à la vente, voir Guide du développeur pour Dynamics 365 Sales.