Freigeben über

Verwenden der Microsoft Dataverse-Web-API

Zum Arbeiten mit Daten sowie Tabellen- und Spaltendefinitionen in Dataverse können Sie die Web-API oder das SDK für .NET verwenden.

Die Dataverse-Web-API bietet eine Entwicklungsumgebung, die Sie in einer Vielzahl von Programmiersprachen, Plattformen und Geräten verwenden können. 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 basiert, außer dem Python SDK, stellt Microsoft keine Assemblys oder Bibliotheken für eine bestimmte Entwicklerumgebung bereit. 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/.

Modellgesteuerte Anwendungen und Power Pages bieten Objekten Methoden zum Ausführen von Datenvorgängen mithilfe der Web-API. Siehe:

Web-API und Organisationsservice

Es ist wichtig zu erkennen, dass der Organisationsdienst 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 finden Sie unter Event Framework.

Mit der Web-API können Sie dieselben Vorgänge wie das SDK für .NET ausführen, diese jedoch im RESTful-Stil präsentieren. 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. Nachrichten, die CRUD-Vorgängen entsprechen, sind in der Web-API nicht verfügbar. Als RESTful-Dienst verfügen diese Operationen über Implementierungen, die die HTTP-Methoden GET, POST, PATCH und DELETE verwenden. Innerhalb der Plattform werden jedoch die Meldungen abrufen, erstellen, aktualisieren und löschen auf die gleiche Weise aufgerufen, wie die entsprechenden Vorgänge mithilfe des SDK für .NET-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, die Sie zum Verfassen und Senden authentifizierter HTTP-Anforderungen verwenden können, ist ein wesentliches Tool. Viele Optionen sind verfügbar, z. B. Postman, Bruno oder Curl. Wählen Sie das gewünschte Tool aus, und verwenden Sie es. In den folgenden Schritten wird beschrieben, wie Schlaflosigkeit verwendet wird, da es über eine grafische Benutzeroberfläche, eine relativ einfache Installation verfügt und eine Option zum Deaktivieren des Erstellens eines Kontos bietet. Erfahren Sie, wie Sie Schlaflosigkeit mit dataverse Web-API verwenden.

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 Cmdlet Invoke-RestMethod verwenden, um Anforderungen zu senden und die Antworten mithilfe des Cmdlet ConvertTo-Json 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. Möglicherweise möchten Sie die Web-API verwenden, wenn Sie keine Abhängigkeit von einem bestimmten NuGet-Paket eingehen möchten oder wenn die Anforderungen Ihres Projekts die von dem SDK für .NET bereitgestellten stark typisierten Klassen nicht erfordern.

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

Weitere C#-Web-API-Beispiele finden Sie unter Web-API-Datenoperationen (C#).For more C# Web API samples, see Web API Data Operations Samples (C#).

Verwenden von Daten mit Code
OData – die beste Methode für REST
OData Version 4.0 Teil 1: Protocol Plus Errata 02
OData Version 4.0 Teil 2: URL-Konventionen plus Errata 02
OData Version 4.0 Teil 3: Common Schema Definition Language (CSDL) Plus Errata 02

  • Last updated on