Freigeben über


getEntityMetadata (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 1.0

Gibt die Entitätsmetadaten für die angegebene Entität zurück.

Syntax

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

Parameter

Name des Dataflows Typ Erforderlich Beschreibung
entityName Zeichenfolge Ja Der logische Name der Entität.
attributes Array aus Zeichenfolgen Nr. Die Attribute, für die Metadaten abgerufen werden.

Reklamationen

Typ: Objekt

Beschreibung: Ein Objekt, das die Entitätsmetadateninformationen mit folgenden Attributen enthält.

Attributname Typ Beschreibung
ActivityTypeMask Zahl Ob eine benutzerdefinierte Aktivität in den Aktivitätsmenüs in der Webanwendung angezeigt werden soll. 0 gibt an, dass die benutzerdefinierte Aktivität nicht angezeigt wird; 1 gibt an, dass sie angezeigt wird.
AutoRouteToOwnerQueue Boolean Gibt an, ob Datensätze automatisch in die Standardwarteschlange des Besitzers verschoben werden sollen, wenn ein Datensatz dieses Typs erstellt oder zugewiesen wird.
CanEnableSyncToExternalSearchIndex Boolean Nur zur internen Verwendung
CanTriggerWorkflow Boolean Gibt an, ob die Entität einen Workflowprozess auslösen kann.
Beschreibung Zeichenfolge Beschreibung für die Entität.
DisplayCollectionName Zeichenfolge Pluralanzeigename für die Entität.
DisplayName Zeichenfolge Anzeigename für die Entität.
EnforceStateTransitions Boolean Gibt an, ob die Entität benutzerdefinierte Statusübergänge erzwingt.
EntityColor Zeichenfolge Der Hexadezimalcode, der die für diese Entität in der Anwendung zu verwendende Farbe darstellt.
EntitySetName Zeichenfolge Der Name der Web-API-Entität, die für diese Entität festgelegt ist.
HasActivities Boolean Gibt an, ob Aktivitäten dieser Entität zugeordnet sind.
IsActivity Boolean Gibt an, ob die Entität eine Aktivität ist.
IsActivityParty Boolean Gibt an, ob die E-Mail-Nachricht an eine E-Mail-Adresse gesendet werden kann, die in einem Datensatz dieses Typs gespeichert ist.
IsBusinessProcessEnabled Boolean Gibt an, ob die Entität für Geschäftsprozessflüsse aktiviert ist.
IsBPFEntity Boolean Gibt an, ob die Entität eine Geschäftsprozessfluss-Entität ist.
IsChildEntity Boolean Gibt an, ob die Entität eine untergeordnete Entität ist.
IsConnectionsEnabled Boolean Gibt an, ob Verbindungen für diese Entität aktiviert sind.
IsCustomEntity Boolean Gibt an, ob die Entität eine benutzerdefinierte Entität ist.
IsCustomizable Boolean Gibt an, ob die Entität angepasst werden kann.
IsDocumentManagementEnabled Boolean Gibt an, ob die Dokumentverwaltung aktiviert ist.
IsDocumentRecommendationsEnabled Boolean Zeigt an, ob die Dokumentenempfehlungen aktiviert sind.
IsDuplicateDetectionEnabled Boolean Gibt an, ob die Duplikaterkennung aktiviert ist.
IsEnabledForCharts Boolean Gibt an, ob Diagramme aktiviert sind.
IsImportable Boolean Gibt an, ob die Entität mithilfe des Import-Assistenten importiert werden kann.
IsInteractionCentricEnabled Boolean Gibt an, dass die Entität für interaktive Funktionen aktiviert ist.
IsKnowledgeManagementEnabled Boolean Gibt an, ob das Wissensmanagement für die Entität aktiviert ist.
IsMailMergeEnabled Boolean Gibt an, ob Seriendruck für diese Entität aktiviert ist.
IsManaged Boolean Gibt an, ob die Entität Teil einer verwalteten Lösung ist.
IsOneNoteIntegrationEnabled Boolean Zeigt an, ob die OneNote-Integration für die Entität aktiviert ist.
IsOptimisticConcurrencyEnabled Boolean Gibt an, ob optimistische Parallelität für die Entität aktiviert ist.
IsQuickCreateEnabled Boolean Gibt an, ob die Entität für Schnellerfassungsformulare aktiviert ist.
IsStateModelAware Boolean Gibt an, ob die Entität die Festlegung von benutzerdefinierten Statusübergängen unterstützt.
IsValidForAdvancedFind Boolean Zeigt an, ob die Entität in der erweiterten Suche angezeigt wird.
IsVisibleInMobileClient Boolean Zeigt an, ob Microsoft Dynamics 365 für Tablets Benutzer Daten für diese Entität sehen können.
IsEnabledInUnifiedInterface Boolean Gibt an, ob die Entität für „Einheitliche Oberfläche” aktiviert ist.
LogicalCollectionName Zeichenfolge Der logische Sammlungsname.
LogicalName Zeichenfolge Der logische Name für die Entität.
ObjectTypeCode Zahl Der Entitätstypcode.
OwnershipType Zeichenfolge Der Besitztyp für die Entität: „UserOwned” oder „OrganizationOwned”.
PrimaryIdAttribute Zeichenfolge Der Name des Attributs, das die primäre ID für die Entität ist.
PrimaryImageAttribute Zeichenfolge Der Name des primären Bildattributs für eine Entität.
PrimaryNameAttribute Zeichenfolge Der Name des primären Attributs für eine Entität.
Rechte Array von Objekten Die Rechtsmetadaten für die Entität, bei der jedes Objekt die folgenden Attribute enthält, um das Sicherheitsrecht für den Zugriff auf eine Entität zu definieren:
  • CanBeBasic: Boolesch. Ob das Recht eine Basiszugriffsebene sein kann.
  • CanBeDeep: Boolesch- Ob das Recht tiefe Zugriffsebene sein kann.
  • CanBeEntityReference: Boolesch. Ob das Recht für eine externe Partei die Basiszugriffsebene sein kann.
  • CanBeGlobal: Boolesch. Ob das Recht die globale Zugriffsebene sein kann.
  • CanBeLocal: Boolesch. Ob das Recht die lokale Zugriffsebene sein kann.
  • CanBeParentEntityReference: Boolesch. Ob das Recht für eine externe Partei die übergeordnete Zugriffsebene sein kann.
  • Name: Zeichenfolge. Der Name des Rechts.
  • PrivilegeId: Zeichenfolge. Die ID des Rechts.
  • PrivilegeType: Zahl. Der Typ des Rechts, das eines der Folgenden ist:
    • 0: Keine
    • 1: Erstellen
    • 2: Lesen
    • 3: Schreiben
    • 4: Löschen
    • 5: Zuweisen
    • 6: Freigeben
    • 7: Anfügen
    • 8: AppendTo
Attribute Abholung Eine Sammlung von Attributmetadatenobjekten. Das zurückgegebene Objekt hängt vom Typ der Attributmetadaten ab.

Attributmetadaten für den Basis-Typ
Ein mit den folgenden Eigenschaften zurückgegebenes Objekt:

  • AttributeType: Zahl. Typ eines Attributs. Eine Liste mit Attributtypwerten finden Sie unter AttributeTypeCode
  • DisplayName: Zeichenfolge. Anzeigename für das Attribut.
  • EntityLogicalName: Zeichenfolge Logischer Name der Entität, die das Attribut enthält.
  • LogicalName: Zeichenfolge. Logischer Name für das Attribut.

Attributmetadaten für den Booleschen Typ
Ein Objekt, das mit den folgenden Eigenschaften zusätzlich zu den Attributmetadatentypeigenschaften Basis zurückgegeben wird:

  • DefaultFormValue: Boolesche. Standardwert für einen Booleschen Optionssatz.
  • OptionSet: Objekt. Optionen für das boolesche Attribut, bei denen jede Option ein key:value-Paar ist.

Attributmetadaten für den Enum-Typ
Ein Objekt, das mit den folgenden Eigenschaften zusätzlich zu den Attributmetadatentypeigenschaften Basis zurückgegeben wird:

  • OptionSet: Objekt. Optionen für das Attribut, bei denen jede Option ein key:value-Paar ist.

Attributmetadaten für den Auswahlliste-Typ
Ein Objekt, das mit den folgenden Eigenschaften zusätzlich zu den Attributmetadatentypeigenschaften Basis zurückgegeben wird:

  • DefaultFormValue: Zahl. Standardformularwert für das Attribut.
  • OptionSet: Objekt. Optionen für das Attribut, bei denen jede Option ein key:value-Paar ist.

Attributmetadaten für den Status-Typ
Ein Objekt, das mit den folgenden Eigenschaften zusätzlich zu den Attributmetadatentypeigenschaften Basis zurückgegeben wird:

  • OptionSet: Objekt. Optionen für das Attribut, bei denen jede Option ein key:value-Paar ist.

Das Objekt enthält auch die folgenden Methoden:

  • getDefaultStatus(arg): Gibt den standardmäßigen Status (Zahl) basierend auf dem übergebenen Statuswert für eine Entität zurück. Informationen zu Standardstatus und Statuswerten für eine Entität finden Sie unter den Entitätsmetadateninformationen der Entität in Entitätsreferenz.
  • getStatusValuesForState(arg): Gibt mögliche Statuswerte (Array von Zahlen) für einen angegebenen Statuswert zurück. Informationen zu Status und Statuswerten für eine Entität finden Sie unter Entitätsmetadateninformationen der Entität in Entitätsreferenz.

Attributmetadaten für den Status-Typ
Ein Objekt, das mit den folgenden Eigenschaften zusätzlich zu den Attributmetadatentypeigenschaften Basis zurückgegeben wird:

  • OptionSet: Objekt. Optionen für das Attribut, bei denen jede Option ein key:value-Paar ist.

Das Objekt enthält auch die folgende Methode:

  • getState(arg): Gibt den Statuswert (Zahl) für den angegebenen Statuswert (Zahl) zurück. Informationen zu Standardstatus und Statuswerten für eine Entität finden Sie unter den Entitätsmetadateninformationen der Entität in Entitätsreferenz.