getEntityMetadata (API client)

  • Article

Renvoie les définitions de table pour la table spécifiée.

Syntaxe

Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)

Paramètres

Nom Type Requise Description
entityName String Oui Nom logique de la table.
attributes Tableau de chaînes Non Colonnes pour lesquelles obtenir les définitions.
successCallback function Non Fonction à appeler lorsque les définitions de table sont récupérées.
errorCallback function Non Fonction à appeler lorsque l’opération échoue.

Valeur renvoyée

Type : Objet

Description : un objet contenant les informations de définition de table avec les valeurs suivantes.

Nom Type Description
ActivityTypeMask Chiffre Si une activité personnalisée doit figurer dans les menus d’activité dans l’application Web. 0 indique que l’activité personnalisée n’apparaît pas ; 1 indique qu’elle s’affiche.
AutoRouteToOwnerQueue Valeur booléenne Indique si les enregistrements sur la file d’attente par défaut du propriétaire doivent être déplacés automatiquement quand un enregistrement de ce type est créé ou attribué.
CanEnableSyncToExternalSearchIndex Valeur booléenne Réservé exclusivement à un usage interne.
CanTriggerWorkflow Valeur booléenne Indique si la table peut déclencher un processus de workflow.
Description String Description de la table.
DisplayCollectionName String Nom complet pluriel de la table.
DisplayName String Nom d’affichage de la table.
EnforceStateTransitions Valeur booléenne Indique si la table appliquera des transitions d’état personnalisées.
EntityColor String Code hexadécimal représentant la couleur à utiliser pour cette table dans l’application.
EntitySetName String Nom de la table API Web définie pour cette table.
HasActivities Valeur booléenne Indique si les activités sont associées à cette table.
IsActivity Valeur booléenne Indique si la table est activée.
IsActivityParty Valeur booléenne Indique si les messages électroniques peuvent être envoyés à une adresse de messagerie stockée dans un enregistrement de ce type.
IsBusinessProcessEnabled Valeur booléenne Indique si la table est activée pour les flux des processus d’entreprise.
IsBPFEntity Valeur booléenne Indique si la table est une table de flux des processus d’entreprise.
IsChildEntity Valeur booléenne Indique si la table est une table enfant.
IsConnectionsEnabled Valeur booléenne Indique si les connexions sont activées pour cette table.
IsCustomEntity Valeur booléenne Indique si la table est une table personnalisée.
IsCustomizable Valeur booléenne Indique si la table peut être personnalisée.
IsDocumentManagementEnabled Valeur booléenne Indique si la gestion des documents est activée.
IsDocumentRecommendationsEnabled Valeur booléenne Indique si les recommandations pour le document sont activées.
IsDuplicateDetectionEnabled Valeur booléenne Indique si la détection des doublons est activée.
IsEnabledForCharts Valeur booléenne Indique si les graphiques sont activés.
IsImportable Valeur booléenne Indique si la table peut être importée à l’aide de l’assistant d’importation.
IsInteractionCentricEnabled Valeur booléenne Indique si la table est activée pour une expérience interactive.
IsKnowledgeManagementEnabled Valeur booléenne Indique si la gestion des connaissances est activée pour la table.
IsMailMergeEnabled Valeur booléenne Indique si la fusion et publipostage sont activés pour cette table.
IsManaged Valeur booléenne Indique si la table fait partie d’une solution gérée.
IsOneNoteIntegrationEnabled Valeur booléenne Indique si l’intégration OneNote est activée pour la table.
IsOptimisticConcurrencyEnabled Valeur booléenne Indique si l’accès concurrentiel optimiste est activé pour la table.
IsQuickCreateEnabled Valeur booléenne Indique si la table est activée pour les formulaires de création rapide.
IsStateModelAware Valeur booléenne Indique si la table prend en charge les transitions d’état personnalisées.
IsValidForAdvancedFind Valeur booléenne Indique si la table sera affichée dans la recherche avancée.
IsVisibleInMobileClient Valeur booléenne Indique si les utilisateurs de Microsoft Dynamics 365 pour les tablettes peuvent voir les données de ce tableau.
IsEnabledInUnifiedInterface Valeur booléenne Indique si la table est activée pour Unified Interface.
LogicalCollectionName String Nom de la collection logique.
LogicalName String Nom logique de la table.
ObjectTypeCode Chiffre Code de type de table.
OwnershipType String Le type de propriété de la table : UserOwned ou OrganizationOwned.
PrimaryIdAttribute String Le nom de la colonne qui est l’ID principal de la table.
PrimaryImageAttribute String Le nom de la colonne de l’image principale d’une table.
PrimaryNameAttribute String Le nom de la colonne principale d’une table.
Privileges Tableau d’objets Objets qui définissent le privilège de sécurité pour l’accès à une table. Voir Objet privilège
Attributes Collection Une collection d’objets de définitions de colonne. Voir Objets d’attribut

Objet privilège

Les objets Privilège ont les propriétés suivantes pour définir le privilège de sécurité pour l’accès à une table :

Nom Type Description
CanBeBasic Valeur booléenne Si le privilège peut être de niveau d’accès de base.
CanBeDeep Valeur booléenne Si le privilège peut être de niveau d’accès profond.
CanBeEntityReference Valeur booléenne Si le privilège d’un tiers externe peut être de niveau d’accès de base.
CanBeGlobal Valeur booléenne Si le privilège peut être de niveau d’accès global.
CanBeLocal Valeur booléenne Si le privilège peut être de niveau d’accès local.
CanBeParentEntityReference Valeur booléenne Si le privilège d’un tiers externe peut être de niveau d’accès parent.
Name String Nom du privilège.
PrivilegeId String ID du privilège.
PrivilegeType Chiffre Type du privilège, qui est l’un des suivants :
0 : Aucune
1 : Création
2 : Lecture
3 : Écriture
4 : Suppression
5 : Attribution
6 : Partage
7 : Ajout
8 : AppendTo

Objets d’attribut

L’objet renvoyé dépend du type de définitions de colonne.

Colonnes de base (AttributeMetadata)

Toutes les définitions de colonnes ont ces propriétés partagées :

Nom Type Description
AttributeType Chiffre Type de colonne. Pour obtenir la liste des valeurs de type de colonne, voir Enum AttributeTypeCode
DisplayName String Nom d’affichage de la colonne
EntityLogicalName String Nom logique de la table contenant la colonne.
LogicalName String Nom logique pour la colonne.

Colonnes Oui/Non (BooleanAttributeMetadata)

Les colonnes Oui/Non ont ces propriétés :

Nom Type Description
DefaultFormValue Valeur booléenne Valeur par défaut pour une colonne Oui / Non.
OptionSet Object Options pour la colonne booléenne où chaque option est une paire clé : valeur.

Colonnes de choix (PicklistAttributeMetadata)

Les colonnes de choix ont cette propriété :

Nom Type Description
OptionSet Object Options pour la colonne où chaque option est une paire clé : valeur.

Colonnes de choix (MultiSelectPicklistAttributeMetadata)

Les colonnes de choix ont ces propriétés :

Nom Type Description
DefaultFormValue Valeur booléenne Valeur par défaut pour la colonne.
OptionSet Object Options pour la colonne booléenne où chaque option est une paire clé : valeur.

Colonnes d’état (StateAttributeMetadata)

Les colonnes d’état ont cette propriété :

Nom Type Description
OptionSet Object Options pour la colonne où chaque option est une paire clé : valeur.

Les colonnes d’état ont également ces méthodes qui acceptent la valeur de l’un des OptionSet valeurs d’option comme arg paramètre.

Nom Type renvoyé Description
getDefaultStatus(arg) Chiffre Renvoie l’état par défaut (nombre) en fonction de la valeur d’état transmise pour une table. Pour connaître l’état par défaut et les valeurs d’état d’une table, consultez les informations sur les définitions de table de la table dans Dataverse la référence de table / entité.
getStatusValuesForState(arg) Tableau de nombres Renvoie les valeurs d’état possibles (tableau de nombres) pour une valeur d’état spécifiée. Pour connaître l’état par défaut et les valeurs d’état d’une table, consultez les informations sur les définitions de la table dans Dataverse la référence de table / entité.

Colonnes de Statut (StateAttributeMetadata)

Les colonnes de Statut ont cette propriété :

Nom Type Description
OptionSet Object Options pour la colonne où chaque option est une paire clé : valeur.

Les colonnes de Statut ont également cette méthode qui accepte la valeur de l’un des OptionSet valeurs d’option comme arg paramètre.

Nom Type renvoyé Description
getState(arg) Chiffre Renvoie la valeur d’état (nombre) de la valeur de statut spécifiée (numéro). Pour connaître l’état par défaut et les valeurs d’état d’une table, consultez les informations sur les définitions de table de la table dans Dataverse la référence de table / entité.

Xrm.Utility

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).