Verwenden der Microsoft Dataverse-Web-API

Hinweis

Gültig ab November 2020:

  • Common Data Service wurde in Microsoft Dataverse umbenannt. Weitere Informationen
  • Einige Begriffe in Microsoft Dataverse wurden aktualisiert. Zum Beispiel ist Entität jetzt Tabelle und Feld ist jetzt Spalte. Weitere Informationen

Dieser Artikel wird in Kürze aktualisiert, um die neueste Terminologie widerzuspiegeln.

Die Web-API ist eine der beiden Webdienste, die Sie verwenden können, um mit Daten und Metadaten in Dataverse arbeiten zu können. Der andere ist der Organisationsservice.

Die Dataverse-Web-API bietet eine Entwicklungserfahrung, die für eine Vielzahl von Programmiersprachen, Plattformen und Geräten verwendet werden kann. Die Web-API implementiert OData (Open Data Protocol), Version 4.0, ein OASIS-Standard zum Erstellen und Nutzen von RESTful APIs über umfassende Datenquellen. Weitere Informationen zu diesem Protokoll finden Sie unter https://www.odata.org/. Details zu diesem Standard finden Sie unter https://www.oasis-open.org/standards#odatav4.0.

Da die Web-API auf offenen Standards aufbaut, stellen wir keine Assemblies für eine bestimmte Entwicklererfahrung zur Verfügung. Sie können HTTP-Anforderungen für bestimmte Vorgänge erstellen oder Bibliotheken von Drittanbietern verwenden, um Klassen für beliebige Sprachen oder Plattformen zu erstellen. Eine Liste der Bibliotheken, die OData-Version 4.0 unterstützen, finden Sie unter https://www.odata.org/libraries/.

Web-API und Organisationsservice

Es ist wichtig zu wissen, dass der Organisationsservice die Plattform definiert. Die Web-API stellt eine RESTful-Programmierungserfahrung bereit. Letztendlich durchlaufen aber alle Datenoperationen den zugrunde liegenden Organisationsservice. Der Organisationsservice definiert die unterstützten Vorgänge als Nachrichten. Jede Nachricht hat einen Namen. Die Namen sind an die Ereignisse gebunden, die im Ereignisframework verwendet werden, um zu bestimmen, welche registrierten Erweiterungen initiiert werden sollten. Weitere Informationen: Ereignisframework

Mit der Web API können Sie die gleichen Operationen wie mit dem Organisationsservice auszuführen, haben aber eine Umgebung im RESTful-Stil. OData v4 stellt benannte Operationen über Funktionen oder Aktionen bereit. Die meisten im Organisationsservice verfügbaren Nachrichten werden als entsprechende benannte Funktion oder Aktion verfügbar gemacht. Diese Nachrichten, die CRUD-Vorgängen entsprechen, sind nicht in der Web-API verfügbar, da sie als RESTful-Service Implementierungen mit GET, POST, PATCH und DELETE HTTP-Methoden haben. Innerhalb der Plattform werden die Nachrichten Abrufen, Erstellen, Aktualisieren und Löschen aber so wie sie sind aufgerufen, wenn die entsprechenden Vorgänge mit den .NET Framework-Assemblys ausgeführt werden.

Erste Schritte

Nachdem Sie eine Übersicht über die Web-API gelesen haben, fahren Sie mit dem Thema Erste Schritte mit der Dataverse-Web-API fort, um zu lernen, wie Sie Ihr erstes C #-Programm in Visual Studio schreiben, das die Web-API verwendet.

Wenn Sie ein JavaScript-Entwickler sind und die Web-API in modellbasierten Apps verwenden möchten, navigieren Sie zu Clientseitiges JavaScript unter Verwendung der Web-API in modellbasierten Apps.

Verwenden von Daten mit Code
OData - the best way to REST
OData Version 4.0 Part 1: Protocol Plus Errata 02
OData Version 4.0 Part 2: URL Conventions Plus Errata 02
OData Version 4.0 Part 3: Common Schema Definition Language (CSDL) Plus Errata 02