Freigeben über

Verwenden der Microsoft Dataverse-Web-API

Sie können die Web-API oder SDK für .NET verwenden, um mit DAten und Tabellen und Spaltendefinitionen in Dataverse zu arbeiten.

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 OASIS-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 SDK für .NET 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, aber 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

Sie können die Web-API mit jeder Sprache verwenden, mit der Sie authentifizierte HTTP-Anforderungen senden können. Wir haben einige erste Schritte für vier gängige Szenarien vorbereitet:

Tools für HTTP-Anforderungen

Eine Anwendung, mit der Sie authentifizierte HTTP-Anforderungen erstellen und senden können, ist ein wichtiger erster Schritt. Es gibt viele, wie z.B., Postman, Bruno oder curl. Wählen und verwenden Sie, was Ihnen am besten gefällt. Wir stellen einige Schritte zur Verwendung von Insomnia bereit, da es eine grafische Benutzeroberfläche hat, eine relativ einfache Installation und die Möglichkeit bietet, die Erstellung eines Kontos abzulehnen. Erfahren Sie, wie Sie mit Postman mit der Dataverse Web API arbeiten können

Trinkgeld

Wenn Sie nicht bereits über ein bevorzugtes HTTP-Anforderungstool verfügen, ist die Verwendung von PowerShell mit Visual Studio Code möglicherweise ebenso einfach zu starten und ermöglicht auch leistungsstarke Skriptfunktionen.

PowerShell-Entwickler

Die Verwendung der Web-API mit PowerShell ist eine der einfachsten Möglichkeiten, um loszulegen. Sie können das CmdletInvoke-RestMethod verwenden, um Anforderungen zu senden und die Antworten mit dem ConvertTo-Json Cmdlet zu verarbeiten.

Sie finden die folgenden Inhalte zur Verwendung von PowerShell mit der Web-API:

JavaScript-Entwickler

JavaScript-Entwickler verwenden die Dataverse Web-API häufig mit modellgesteuerten App. Modellgesteuerte Apps stellen das Xrm.WebApi-Objekt bereit, das Methoden zur Interaktion mit der Web-API verfügbar macht. Mehr über clientseitiges JavaScript mit Web-API in modellgesteuerten Apps erfahren.

Single-Page-Anwendung (SPAs) verwenden ebenfalls JavaScript und können eine Verbindung mit der Dataverse Web-API herstellen. Schnellstart: Web-API mit clientseitigem JavaScript und Visual Studio Code beschreibt, wie Sie mithilfe eines SPA-Anwendungsmusters eine Verbindung mit der Web-API herstellen. Weitere Beispiele finden Sie in Web-API-Datenvorgänge-Beispiele (clientseitigem JavaScript).

Innerhalb von Power Apps Component Framework (PCF)-Komponenten verwenden JavaScript-Entwickler Methoden, die Teil des WebAPI-Objekts sind, um mit Dataverse Daten in PCF-Komponenten zu arbeiten.

Power Pages wird ein Web-API für Portale verfügbar machen, die eine Teilmenge der Dataverse Vorgänge bietet, die über die Web-API verfügbar sind.

.NET-Entwickler

.NET-Entwickler können entweder das Dataverse SDK für .NET oder die Web-API verwenden. Sie können die Web-API verwenden, wenn Sie keine Abhängigkeit von einem bestimmten NuGet Paket eingehen möchten oder die Anforderungen Ihres Projekts die stark typisierten Klassen, die vom SDK für .NET bereitgestellt werden, nicht erfordern.

Informationen zur Verwendung der Web-API mit C# finden Sie in den folgenden Schnellstartartikeln:

Es gibt viele weitere C#-Web-API-Beispiele unter Web-API-Datenvorgänge Beispiele (C#)

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