getEntityMetadata (Référence API JavaScript) pour l’environnement d’intégration du canal de Dynamics 365 1.0

  • Article

Renvoie les métadonnées pour l’entité spécifiée.

Syntaxe

Microsoft.CIFramework.getEntityMetadata(entityName, attributes).then(successCallback, errorCallback)

Paramètres

Nom  Type Requise Description
entityName String Oui Nom logique de l’entité.
attributs Tableau de chaînes No Attributs pour lesquels obtenir les métadonnées.

Valeur renvoyée

Type : Objet

Description : objet contenant les informations de métadonnées d’entité avec les attributs suivants.

Nom de l’attribut Type Description
ActivityTypeMask Numéro 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 Booléen 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 Booléen Utilisation interne uniquement.
CanTriggerWorkflow Booléen Indique si l’entité peut déclencher un processus de workflow.
Description Chaîne Description de l’entité.
DisplayCollectionName Chaîne Nom complet au pluriel de l’entité.
DisplayName Chaîne Nom complet de l’entité.
EnforceStateTransitions Booléen Indique si l’entité applique les transitions d’état personnalisées.
EntityColor Chaîne Code hexadécimal pour représenter la couleur à utiliser pour cette entité dans l’application.
EntitySetName Chaîne Nom de l’entité d’API Web définie pour cette entité.
HasActivities Booléen Indique si des activités sont associées à cette entité.
IsActivity Booléen Indique si l’entité est une activité.
IsActivityParty Booléen Indique si les messages électroniques peuvent être envoyés à une adresse de messagerie stockée dans un enregistrement de ce type.
IsBusinessProcessEnabled Booléen Indique si l’entité est activée pour les flux des processus d’entreprise.
IsBPFEntity Booléen Indique si l’entité est une entité de flux des processus d’entreprise.
IsChildEntity Booléen Indique si l’entité est une entité enfant.
IsConnectionsEnabled Booléen Indique si les connexions sont activées pour cette entité.
IsCustomEntity Booléen Indique si l’entité est une entité personnalisée.
IsCustomizable Booléen Indique si l’entité est personnalisable.
IsDocumentManagementEnabled Booléen Indique si la gestion des documents est activée.
IsDocumentRecommendationsEnabled Booléen Indique si les recommandations de documents sont activées.
IsDuplicateDetectionEnabled Booléen Indique si la détection des doublons est activée.
IsEnabledForCharts Booléen Indique si les graphiques sont activés.
IsImportable Booléen Indique si l’entité peut être importée à l’aide de l’Assistant Importation.
IsInteractionCentricEnabled Booléen Indique l’entité est activée pour une expérience interactive.
IsKnowledgeManagementEnabled Booléen Indique si la gestion des connaissances est activée pour l’entité.
IsMailMergeEnabled Booléen Indique si la fusion et publipostage est activée pour cette entité.
IsManaged Booléen Indique si l’entité fait partie d’une solution gérée.
IsOneNoteIntegrationEnabled Booléen Indique si l’Intégration OneNote est activée pour l’entité.
IsOptimisticConcurrencyEnabled Booléen Indique si l’accès concurrentiel optimiste est activé pour l’entité.
IsQuickCreateEnabled Booléen Indique si l’entité est activée pour les formulaires de création rapide.
IsStateModelAware Booléen Indique si l’entité prend en charge la configuration des transitions d’état personnalisées.
IsValidForAdvancedFind Booléen Indique si l’entité s’affiche dans la Recherche avancée.
IsVisibleInMobileClient Booléen Indique si les utilisateurs de Microsoft Dynamics 365 pour les tablettes peuvent afficher les données de cette entité.
IsEnabledInUnifiedInterface Booléen Indique si l’entité est activée pour Unified Interface.
LogicalCollectionName Chaîne Nom de la collection logique.
LogicalName Chaîne Nom logique de l’entité.
ObjectTypeCode Numéro Code de type d’entité.
OwnershipType Chaîne Type de propriété pour l’entité : « UserOwned » ou « OrganizationOwned ».
PrimaryIdAttribute String Nom de l’attribut étant l’ID principal de l’entité.
PrimaryImageAttribute Chaîne Nom de l’attribut d’image principal d’une entité.
PrimaryNameAttribute Chaîne Nom de l’attribut principal d’une entité.
Privilèges Tableau d’objets Métadonnées de privilège pour l’entité sur laquelle chaque objet contient les attributs suivants pour définir le privilège de sécurité d’accès à une entité :
  • CanBeBasic : Booléen. Si le privilège peut être de niveau d’accès de base.
  • CanBeDeep : Booléen. Si le privilège peut être de niveau d’accès profond.
  • CanBeEntityReference : Booléen. Si le privilège d’un tiers externe peut être de niveau d’accès de base.
  • CanBeGlobal : Booléen. Si le privilège peut être de niveau d’accès global.
  • CanBeLocal : Booléen. Si le privilège peut être de niveau d’accès local.
  • CanBeParentEntityReference : Booléen. Si le privilège d’un tiers externe peut être de niveau d’accès parent.
  • Nom : Chaîne. Nom du privilège.
  • PrivilegeId : Chaîne. ID du privilège.
  • PrivilegeType : Numéro. 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
Attributs Collection Collection d’objets de métadonnées de l’attribut. L’objet renvoyé dépend du type de métadonnées de l’attribut.

Métadonnées de l’attribut le type de base
Objet retourné avec les propriétés suivantes :

  • AttributeType : Numéro. Type d’un attribut. Pour une liste des valeurs de types d’attribut, voir AttributeTypeCode
  • DisplayName : Chaine. Nom complet de l’attribut.
  • EntityLogicalName : Chaîne. Nom logique de l’entité contenant l’attribut.
  • LogicalName : Chaîne. Nom logique de l’attribut

Métadonnées de l’attribut pour le type booléen
Objet renvoyé avec les propriétés suivantes en plus des propriétés du type de métadonnées d’attribut base :

  • DefaultFormValue : Booléen. Valeur par défaut d’un groupe d’options booléennes.
  • OptionSet : Objet. Options de l’attribut booléen où chaque option est une paires clé-valeur.

Métadonnées de l’attribut le type enum
Objet renvoyé avec les propriétés suivantes en plus des propriétés du type de métadonnées d’attribut base :

  • OptionSet : Objet. Options de l’attribut où chaque option est une paires clé-valeur.

Métadonnées de l’attribut pour le type picklist
Objet renvoyé avec les propriétés suivantes en plus des propriétés du type de métadonnées d’attribut base :

  • DefaultFormValue : Nombre. Valeur de formulaire par défaut de l’attribut.
  • OptionSet : Objet. Options de l’attribut où chaque option est une paires clé-valeur.

Métadonnées de l’attribut le type état
Objet renvoyé avec les propriétés suivantes en plus des propriétés du type de métadonnées d’attribut base :

  • OptionSet : Objet. Options de l’attribut où chaque option est une paires clé-valeur.

L’objet contient également les méthodes suivantes :

  • getDefaultStatus (arg) : Renvoie par le statut par défaut (numéro) selon la valeur d’état d’une entité transmise. Pour les valeurs d’état et de statut par défaut d’une entité, voir les informations des métadonnées de l’entité dans la Référence de l’entité.
  • getStatusValuesForState (arg) : Renvoie les valeurs de statut possibles (tableau de numéros) pour une valeur d’état spécifiée. Pour les valeurs d’état et de statut d’une entité, voir les informations des métadonnées de l’entité dans la Référence de l’entité.

Métadonnées de l’attribut le type statut
Objet renvoyé avec les propriétés suivantes en plus des propriétés du type de métadonnées d’attribut base :

  • OptionSet : Objet. Options de l’attribut où chaque option est une paires clé-valeur.

L’objet contient également la méthode suivante :

  • getState (arg) : Renvoie la valeur d’état (nombre) de la valeur de statut spécifiée (numéro). Pour les valeurs d’état et de statut par défaut d’une entité, voir les informations des métadonnées de l’entité dans la Référence de l’entité.