getEntityMetadata (Client API)

  • Artikel

Gibt Tabellendefinitionen für die angegebene Tabelle zurück.

Syntax

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

Parameter

Name des Dataflows Type Erforderlich Beschreibung
entityName String Ja Der logische Name der Tabelle.
attributes Array aus Zeichenfolgen Nein Die Spalten, für die Definitionen abgerufen werden sollen.
successCallback function Nein Eine Funktion, die aufgerufen wird, wenn Tabellendefinitionen abgerufen werden.
errorCallback function Nein Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug.

Reklamationen

Typ: Objekt.

Beschreibung: Ein Objekt, das die Tabellendefinitionsinformationen mit den folgenden Werten enthält.

Name des Dataflows Type Beschreibung
ActivityTypeMask Number 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 Boolesch Gibt an, ob Datensätze automatisch in die Standardwarteschlange des Besitzers verschoben werden sollen, wenn ein Datensatz dieses Typs erstellt oder zugewiesen wird.
CanEnableSyncToExternalSearchIndex Boolesch Nur zur internen Verwendung.
CanTriggerWorkflow Boolesch Gibt an, ob die Tabelle einen Workflowprozess auslösen kann.
Description String Beschreibung für die Tabelle.
DisplayCollectionName String Plural-Anzeigename für die Tabelle.
DisplayName String Anzeigename für die Tabelle.
EnforceStateTransitions Boolesch Gibt an, ob die Tabelle benutzerdefinierte Statusübergänge erzwingt.
EntityColor String Der hexadezimale Code zur Darstellung der Farbe, die für diese Tabelle in der Anwendung verwendet werden soll.
EntitySetName String Der Name der Web-API-Tabelle, die für diese Tabelle festgelegt wurde.
HasActivities Boolesch Gibt an, ob dieser Tabelle Aktivitäten zugeordnet sind.
IsActivity Boolesch Gibt an, ob diese Tabelle eine Aktivität ist.
IsActivityParty Boolesch Gibt an, ob die E-Mail-Nachricht an eine E-Mail-Adresse gesendet werden kann, die in einem Datensatz dieses Typs gespeichert ist.
IsBusinessProcessEnabled Boolesch Gibt an, ob die Tabelle für Geschäftsprozessabläufe aktiviert ist.
IsBPFEntity Boolesch Gibt an, ob die Tabelle für einen Geschäftsprozessablauf aktiviert ist.
IsChildEntity Boolesch Gibt an, ob diese Tabelle eine untergeordnete Tabelle ist.
IsConnectionsEnabled Boolesch Gibt an, ob Verbindungen für diese Tabelle aktiviert sind.
IsCustomEntity Boolesch Gibt an, ob diese Tabelle eine benutzerdefinierte Tabelle ist.
IsCustomizable Boolesch Gibt an, ob diese Tabelle angepasst werden kann.
IsDocumentManagementEnabled Boolesch Gibt an, ob die Dokumentverwaltung aktiviert ist.
IsDocumentRecommendationsEnabled Boolesch Gibt an, ob die Dokumentenempfehlung aktiviert ist.
IsDuplicateDetectionEnabled Boolesch Gibt an, ob die Duplikaterkennung aktiviert ist.
IsEnabledForCharts Boolesch Gibt an, ob Diagramme aktiviert sind.
IsImportable Boolesch Gibt an, ob die Tabelle mit dem Importassistenten importiert werden kann.
IsInteractionCentricEnabled Boolesch Gibt an, dass die Tabelle für interaktive Umgebungen aktiviert ist.
IsKnowledgeManagementEnabled Boolesch Gibt an, ob Wissensmanagement für die Tabelle aktiviert ist.
IsMailMergeEnabled Boolesch Gibt an, ob Seriendruck für diese Tabelle aktiviert sind.
IsManaged Boolesch Gibt an, ob die Tabelle Teil einer verwalteten Lösung ist.
IsOneNoteIntegrationEnabled Boolesch Gibt an, ob OneNote Integration für die Tabelle aktiviert ist.
IsOptimisticConcurrencyEnabled Boolesch Gibt an, ob optimistische Parallelität für die Tabelle aktiviert ist.
IsQuickCreateEnabled Boolesch Gibt an, ob die Tabelle für Schnellerstellungsformulare aktiviert ist.
IsStateModelAware Boolesch Gibt an, ob die Tabelle benutzerdefinierte Statusübergänge unterstützt.
IsValidForAdvancedFind Boolesch Gibt an, ob die Tabelle in der erweiterten Suche angezeigt wird.
IsVisibleInMobileClient Boolesch Gibt an, ob Microsoft Dynamics 365 für Tablet-Benutzer Daten für diese Tabelle anzeigen kann.
IsEnabledInUnifiedInterface Boolesch Gibt an, ob die Tabelle für Einheitliche Oberfläche aktiviert ist.
LogicalCollectionName String Der logische Sammlungsname.
LogicalName String Der logische Name für die Tabelle.
ObjectTypeCode Number Der Tabellentypcode.
OwnershipType String Der Besitzertyp für die Tabelle: UserOwned oder OrganizationOwned.
PrimaryIdAttribute String Der Name der Spalte, die die primäre ID für die Tabelle ist.
PrimaryImageAttribute String Der Name der primären Bildspalte für eine Tabelle.
PrimaryNameAttribute String Der Name der primären Spalte für eine Tabelle.
Privileges Array von Objekten Objekte, die die Sicherheitsberechtigung für den Zugriff auf eine Tabelle definieren. Siehe Berechtigungsobjekt
Attributes Sammlung Eine Sammlung von Spaltendefinitionsobjekten. Siehe Attributobjekte

Berechtigungsobjekt

Berechtigungsobjekte verfügen über die folgenden Eigenschaften, um das Sicherheitsprivileg für den Zugriff auf eine Tabelle zu definieren:

Name des Dataflows Type Beschreibung
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 String Der Name des Rechts.
PrivilegeId String Die ID des Rechts.
PrivilegeType Number 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

Attributobjekte

Das zurückgegebene Objekt hängt von der Art der Spaltendefinitionen ab.

Basisspalten (AttributeMetadata)

Alle Spaltendefinitionen haben diese gemeinsamen Eigenschaften:

Name des Dataflows Type Beschreibung
AttributeType Number Typ einer Spalte. Eine Liste der Spaltentypwerte finden Sie unter AttributeTypeCode-Aufzählung
DisplayName String Anzeigename für die Spalte
EntityLogicalName String Logischer Name der Tabelle, die die Spalte enthält.
LogicalName String Logischer Name für die Spalte.

Ja/Nein-Spalten (BooleanAttributeMetadata)

Ja/Nein-Spalten haben diese Eigenschaften:

Name des Dataflows Type Beschreibung
DefaultFormValue Boolesch Standardwert für eine Ja/Nein-Spalte.
OptionSet Object Optionen für die boolesche Spalte, in der jede Option ein Schlüssel-Wert-Paar ist.

Auswahlspalten (PicklistAttributeMetadata)

Auswahlspalten haben diese Eigenschaft:

Name des Dataflows Type Beschreibung
OptionSet Object Optionen für die boolesche Spalte, in der jede Option ein Schlüssel-Wert-Paar ist.

Auswahlspalten (MultiSelectPicklistAttributeMetadata)

Auswahlspalten haben diese Eigenschaften:

Name des Dataflows Type Beschreibung
DefaultFormValue Boolesch Standardwert für die Spalte.
OptionSet Object Optionen für die boolesche Spalte, in der jede Option ein Schlüssel-Wert-Paar ist.

Statusspalten (StateAttributeMetadata)

Statusspalten haben diese Eigenschaft:

Name des Dataflows Type Beschreibung
OptionSet Object Optionen für die boolesche Spalte, in der jede Option ein Schlüssel-Wert-Paar ist.

Statusspalten verfügen auch über diese Methoden, die den Wert einer der folgenden akzeptieren OptionSet-Optionswerte als arg-Parameter.

Name des Dataflows Rückgabetyp Beschreibung
getDefaultStatus(arg) Number Gibt den Standardstatus (Nummer) basierend auf dem übergebenen Statuswert für eine Tabelle zurück. Informationen zu Standardstatus- und Statuswerten für eine Tabelle finden Sie unter Informationen zu Tabellendefinitionen der Dataverse-Tabelle/-Entitätsreferenz.
getStatusValuesForState(arg) Array von Zahlen Gibt mögliche Statuswerte (Array von Zahlen) für einen angegebenen Statuswert zurück. Informationen zu Standardstatus- und Statuswerten für eine Tabelle finden Sie unter Informationen zu Tabellendefinitionen der Dataverse-Tabelle/-Entitätsreferenz.

Statusspalten (StateAttributeMetadata)

Statusspalten haben diese Eigenschaft:

Name des Dataflows Type Beschreibung
OptionSet Object Optionen für die boolesche Spalte, in der jede Option ein Schlüssel-Wert-Paar ist.

Statusspalten verfügen über diese Methode, die den Wert einer der folgenden OptionSet-Optionswerte als arg-Parameter akzeptieren.

Name des Dataflows Rückgabetyp Beschreibung
getState(arg) Number Gibt den Statuswert (Zahl) für den angegebenen Statuswert (Zahl) zurück. Informationen zu Standardstatus- und Statuswerten für eine Tabelle finden Sie unter Informationen zu Tabellendefinitionen der Dataverse-Tabelle/-Entitätsreferenz.

Xrm.Utility

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).