Einführung in die Microsoft Dataverse-Web-API
Web-API versus Organisationsdienst
Die zwei Hauptmethoden für die Interaktion mit Daten und Metadaten in Microsoft Dataverse sind die Web-API und der Organisationsdienst. Sie können den Organisationsdienst zum Schreiben von Plug-Ins oder Workflowerweiterungen mithilfe der von Microsoft bereitgestellten SDK für .NET verwenden.
Unabhängig von Ihrem Ansatz durchlaufen alle Datenoperationen den zugrunde liegenden Organisationsdienst. Daher ermöglicht Ihnen die Web-API, dieselben Vorgänge wie der Organisationsdienst auszuführen, jedoch in einem RESTful-Stil.
Die folgende Grafik stellt eine Entscheidungsstruktur dar, durch die Sie ermitteln können, wann die Web-API im Vergleich zum Organisationsdienst (über SDK-Assemblys, verfügbar in Microsoft.CrmSdk.CoreAssemblies NuGet-Paket). Außerdem wird angezeigt, wann die Dataverse ServiceClient Assemblies (verfügbar im Microsoft.PowerPlatform.Dataverse.Client NuGet-Paket) für Windows-Anwendungen verwendet werden sollten.
In diesem Modus liegt der Fokus auf der Web-API. Weitere Informationen zum Organisationsdienst finden Sie unter Den Dataverse Organization-Service verwenden im Dataverse-Entwicklerhandbuch.
OData (Open Data Protocol) 4.0
Die Dataverse-Web-API ist als OData-Dienst (OASIS Open Data Protocol) implementiert. Durch die Verwendung eines solchen Industriestandards erhalten Sie alle Vorteile der Entwicklung offener Standards, wie beispielsweise plattformübergreifende Kompatibilität und einfache Implementierung auf Basis eines gemeinsamen vordefinierten Protokolls.
Dataverse stellt keine spezifischen .NET-Tools für die Web-API bereit. Stattdessen empfehlen wir die Verwendung von Community-Bibliotheken, die dem OData-Protokoll entsprechen. Weitere Informationen zu den vorhandenen Bibliotheken erhalten Sie unter https://www.odata.org/libraries/.
Mit OData können Sie mit Dataverse-Daten mit CRUD (Create, Read, Update, Delete)-Vorgängen interagieren, die über die standardmäßigen GET-, POST-, PATCH- und DELETE-HTTP-Methoden verfügbar sind. (Weitere Informationen zu diesen Methoden erhalten Sie später in diesem Modul). Sie können auch fast jede andere Operation ausführen, die über das Dataverse Ereignisframework durch Aufrufen einer OData-Funktion oder Aktion, die denselben Namen wie die entsprechende Nachricht des Organisationsdiensts hat, zur Verfügung gestellt wird. CRUD-bezogene Nachrichten sind als einzige nicht verfügbar, da diese Nachrichten mithilfe der zuvor beschriebenen Standard-HTTP-Methoden erstellt werden.
REST
Grundsätzlich ist das OData-Protokoll eine Reihe von RESTful-APIs (REpresentational State Transfer), ein Industriestandard für die Interoperabilität zwischen Systemen. REST besteht aus sechs Leitprinzipien, die einschränken, wie ein Dienst Anforderungen verarbeiten und auf sie reagieren kann, damit nichtfunktionale Eigenschaften dieses Dienstes erfüllt werden (z. B. Leistung, Skalierbarkeit, Einfachheit, Zuverlässigkeit usw.).
In dieser Lektion sollten Sie berücksichtigen, dass OData diesen Einschränkungen entspricht ebenso wie wiederum die Dataverse-Web-API, die das OData-Protokoll implementiert.
FetchXML
FetchXML ist eine robuste Abfragesprache, die komplexe Abfragen von Dataverse-Daten ermöglicht. Verwenden Sie FetchXML beim Ausführen von Abfragen mit der Dataverse-Web-API zum Zusammenstellen von Abfragekriterien. Dies kann hilfreich sein, wenn Sie auf ein Szenario stoßen, in dem FetchXML für Ihre spezielle Abfrage besser geeignet ist als die Verwendung der OData-Abfragesyntax. Weitere Informationen zu FetchXML finden Sie in einer späteren Lerneinheit dieses Moduls.