Web-API-Eigenschaften
Im CSDL $metadata Dokument hat jeder Typ von Entität, der nicht abstrakt ist, Property
Elemente. Jedes Property
-Element enthält die folgenden Attribute:
Attribute | Beschreibung |
---|---|
Name |
Der Name der Eigenschaft; normalerweise die LogicalName der Spalte und immer in Kleinbuchstaben. Eine Ausnahme von dieser Regel ist Suchfeld Eigenschaften. |
Type |
Der primitive Typ der Eigenschaft. Sehen Primitive Typen mit Dataverse |
Wenn Sie das $metadata-Dokument mit Metadaten-Anmerkungen abrufen, können Sie einige Annotation
-Elemente sehen, die nützlich sein können. Zum Beispiel die folgenden name
- und openrevenue
-Eigenschaften:
<Property Name="name" Type="Edm.String" Unicode="false">
<Annotation Term="Org.OData.Core.V1.Description" String="Type the company or business name." />
</Property>
<Property Name="openrevenue" Type="Edm.Decimal" Scale="Variable">
<Annotation Term="Org.OData.Core.V1.Description" String="Sum of open revenue against an account and its child accounts." />
<Annotation Term="Org.OData.Core.V1.Computed" Bool="true" />
<Annotation Term="Org.OData.Core.V1.Permissions">
<EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember>
</Annotation>
</Property>
Anhand der Anmerkungen in diesem Beispiel können Sie erkennen, dass das Feld openrevenue
schreibgeschützt ist.
Die folgende Tabelle beschreibt die Anmerkungen, die bei Anwendung von Metadaten-Anmerkungen zurückgegeben werden.
Anmerkung Begriff | Beschreibung |
---|---|
Org.OData.Core.V1.Description |
Eine Beschreibung der Eigenschaft |
Org.OData.Core.V1.Computed |
Ob die Eigenschaft berechnet wird; nur schreibgeschützt, da sie von Dataverse berechnet wird. |
Org.OData.Core.V1.Permissions |
Enthält die Arten von Berechtigungen, die für die Eigenschaft verfügbar sind. Nur enthalten, wenn die Berechtigungen eingeschränkt sind, und es enthält immer den Wert <EnumMember>Org.OData.Core.V1.PermissionType/Read</EnumMember> , was bedeutet, dass es schreibgeschützt ist. |
Hinweis
Org.OData.Core.V1.Computed
- und Org.OData.Core.V1.Permissions
-Anmerkungen sind oft zusammen vorhanden, aber nicht immer. Beides bedeutet, dass die Eigenschaft schreibgeschützt ist.
Von Dataverse verwendete primitive Typen
Eigenschaften für Entitätstypen, die für Business-Daten verwendet werden, umfassen nur primitive Typen. Die folgende Tabelle beschreibt die primitiven Typen, die Dataverse verwendet.
Type | Beschreibung |
---|---|
Edm.Binary |
Binäre Daten. Wird für Datei- und Bilddaten verwendet. |
Edm.Boolean |
Binärdbewertete Logik. |
Edm.Date |
Datum ohne Zeitzonenversatz. |
Edm.DateTimeOffset |
Datum und Uhrzeit mit einem Zeitzonen-Offset, keine Schaltsekunden |
Edm.Decimal |
Numerische Werte mit fester Genauigkeit und Skala |
Edm.Double |
IEEE 754 binary64 Gleitkommazahl (15-17 Dezimalstellen) |
Edm.Guid |
eindeutiger Bezeichner des 16-Bytes (128-Bit) |
Edm.Int16 |
16-Bit-Ganzzahl. Wird nur für bestimmte Schema-EntityType-Eigenschaften verwendet |
Edm.Int32 |
32-Bit-Ganzzahl |
Edm.Int64 |
64-Bit-Ganzzahl |
Edm.String |
Reihenfolge von UTF-8-Zeichen Dieser Typ kann die Facette Unicode="false" enthalten.Wenn diese Facette vorhanden ist, enthält und akzeptiert die Zeichenfolge-Eigenschaft nur Zeichenfolgen mit Zeichen, die auf den ASCII-Zeichensatz beschränkt sind. Wenn kein Wert angegeben ist, ist die Unicode-Facette standardmäßig auf „true“ gesetzt. |
Sucheigenschaften
Einige Eigenschaften verwenden die folgende Benennungskonvention: _<name>_value
. Diese Eigenschaften werden Suchfeld-Eigenschaften genannt. Sucheigenschaften sind berechnete, schreibgeschützte Eigenschaften mit einem Edm.Guid
-Wert. Sie können diese Sucheigenschaften in einem Abfragefilter verwenden, um alle Datensätze abzugleichen, die dem einzelnen Datensatz in der N:1-Beziehung zugeordnet sind.
OData stellt Suchspalten als Einwertige Navigationseigenschaften und nicht als Eigenschaften dar. Dataverse stellt Sucheigenschaften bereit, um Szenarios zum Abrufen von Daten mithilfe des Primärschlüssels eines zugehörigen Datensatzes zu vereinfachen. Um den Wert einer Sucheigenschaft zu ändern, müssen Sie die einwertige Navigationseigenschaft ändern, die sie darstellt. Weitere Informationen: Sucheigenschaften
Wenn Sie Suchfelder in eine Abfrage einbeziehen, können Sie Anmerkungen anfordern, die zusätzliche Informationen über die Daten liefern, die für die zugrunde liegenden Attribute eingestellt sind, die nicht durch eine Navigationseigenschaft mit einem Wert dargestellt werden. Weitere Informationen: Eigenschaftsdaten nachschlagen
Nächste Schritte,
Lernen Sie die Navigationseigenschaften kennen.
Siehe auch
Verwenden Sie die Web-API Dataverse
Internet API-Typen und -Vorgänge
Web API-Servicedokumente
Web API Entitätstypen
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).