Partager via


Utiliser l’API web avec les définitions de table

Vous pouvez effectuer l’une des opérations de définition de table et de colonne (métadonnées) avec l’API web que vous pouvez effectuer à l’aide du Kit de développement logiciel (SDK) pour .NET. Cette section fournit des instructions sur l’utilisation de l’API web avec les types d’entités inclus dans la Web API Metadata Entity Type Reference.

Quatre chemins d'accès aux ensembles d'entités sont exposés pour réaliser des opérations avec des entités de définition, comme décrit dans le tableau suivant.

Chemin de l’ensemble d’entités Descriptif
[URI de l’organisation]/api/data/v9.2/EntityDefinitions Contient une collection d'entités de type EntityMetadata EntityType.
[URI de l’organisation]/api/data/v9.2/RelationshipDefinitions Contient ManyToManyRelationshipMetadata EntityType et OneToManyRelationshipMetadata EntityType car ils héritent de RelationshipMetadataBase EntityType.
[URI de l’organisation]/api/data/v9.2/GlobalOptionSetDefinitions Contient une collection d’EntityType BooleanOptionSetMetadata et d’EntityType OptionSetMetadata définis globalement, comme tous deux héritentd’EntityType OptionSetMetadata.
[URI de l’organisation]/api/data/v9.2/ManagedPropertyDefinitions Utilisation interne uniquement

Chaque type d’entité de définition utilise MetadataId comme propriété d’identificateur unique, qu’il hérite de MetadataBase EntityType. Bien que toutes les entités de définition aient un MetadataId, vous ne pouvez pas les interroger directement. Par exemple, vous pouvez interroger et effectuer des opérations sur des attributs (colonnes de table) uniquement dans le contexte de l’entité EntityMetadata qui les contient.

Ces entités de définition présentent des différences substantielles entre les tables qui stockent les données métier et d’application, par exemple :

  • Les propriétés des entités de définition utilisent la plupart des types complexes et enum définis dans Web API Complex Type Reference et Web API Enum Type Reference plutôt que les types de données primitifs utilisés pour les propriétés dans les entités qui héritent d’EntityType crmbaseentity.

  • Les entités de définition suivent une convention d’affectation de noms différente et conservent le style d’affectation de noms Pascal Case utilisé dans les assemblys du Kit de développement logiciel (SDK) pour .NET.

  • Les entités de définition utilisent plus largement l’héritage, par conséquent vous devrez peut-être effectuer des transtypages pour récupérer les données souhaitées.

Contenu de la section

Requête des définitions de table à l’aide de l’API web
Vous pouvez utiliser l’API web pour interroger des définitions de table ou de colonne à l’aide d’un style de requête RESTful.

Récupérer les définitions de table par nom ou MetadataId
Vos applications peuvent s’adapter aux modifications de configuration en interrogeant les définitions de table et de colonne. Lorsque vous connaissez l’une des propriétés clés d’un élément de définition, vous pouvez récupérer des définitions à l’aide de l’API Web.

Créer et mettre à jour les définitions de table à l’aide de l’API Web
Vous pouvez créer et mettre à jour des tables à l’aide de l’API web pour obtenir les mêmes résultats que ceux obtenus avec le Kit de développement logiciel (SDK) pour .NET CreateEntityRequest et UpdateEntityRequest.

Créer et mettre à jour des définitions de colonnes à l’aide de l’API web
Vous pouvez créer et mettre à jour des colonnes à l’aide de l’API web pour obtenir les mêmes résultats que ceux que vous obtenez avec le Kit de développement logiciel (SDK) pour .NET CreateAttributeRequestet UpdateAttributeRequest.

Créer et mettre à jour des relations de table à l’aide de l’API web
Vous pouvez vérifier si les tables sont éligibles pour participer à une relation avec d’autres tables, puis créer ou mettre à jour ces relations à l’aide de l’API web.

Recherches dans plusieurs tables
Les colonnes de type de recherche multi-tables permettent d’utiliser une table spécifique qui a plusieurs relations un-à-plusieurs (1:N) avec d’autres tables de l’environnement. Une colonne de type de recherche unique peut faire référence à plusieurs autres tables. Une valeur de recherche envoyée à la colonne de type multi-table est associée à un enregistrement dans l’une des tables associées. Des recherches dans plusieurs tables peuvent être créées à la fois avec des tables locales et des tables virtuelles comme tables référencées.

Créer et mettre à jour des choix (ensembles d’options) à l’aide de l’API web
Explique comment utiliser des colonnes de choix globaux et locaux. Comment récupérer des valeurs d’option, ajouter, mettre à jour, supprimer et réorganiser les options.

Voir aussi

Parcourir les définitions de table de votre environnement
Utiliser l'API Web Microsoft Dataverseexemple d'opérations de schéma de table
Exemple d’opérations de schéma de table de l’API Web (C#)