Freigeben über


Web-API-Typen und -Vorgänge

Die Artikel in diesem Bereich helfen Ihnen, die Dataverse-Web-API zu verstehen, indem Sie wichtige Konzepte einführen und Möglichkeiten zum Abrufen der benötigten Informationen anzeigen, indem Sie die Dienstdokumente verstehen.

Wie die Microsoft Graph-API ist die Dataverse-Web-API ein OData-RESTful-Dienst. Im Gegensatz zur Microsoft Graph-API verfügt jede Umgebung über eine andere Organisations-URL und enthält benutzerdefinierte Tabellen und Vorgänge, die für jede Umgebung eindeutig sein können. Jede Umgebung unterscheidet sich aufgrund der eindeutigen Anpassungen oder installierten Lösungen.

Schnellstart

Als Erstes sollten Sie sich die Dienstdokumente für eine Dataverse-Umgebung ansehen, auf die Sie zugreifen können. Hierfür müssen Sie die URL für Ihre Umgebung kennen. Anschließend wird empfohlen, einige Möglichkeiten zum Verwalten der Authentifizierung für den Dienst zum Anzeigen von Dienstdokumenten einzurichten.

Suchen der Web-API-Endpunkt-URL

Verwenden Sie die Anweisungen in "Entwicklerressourcen anzeigen ", um einen Web-API-Endpunkt für eine Umgebung zu identifizieren, auf die Sie zugreifen können. Es sollte etwa wie folgt aussehen: https://yourorg.api.crm.dynamics.com/api/data/v9.2.

Authentifizieren beim Dienst

Es gibt mehrere Möglichkeiten, wie Sie sich für die Interaktion mit dem Dienst authentifizieren können. Schlaflosigkeit ist eine beliebte Wahl mit breiter Akzeptanz. Sie können PowerShell auch mit Visual Studio Code verwenden.

Sie können eine der beiden Methoden verwenden, um die Dienstdokumente abzurufen und Beispiele anzuzeigen, die zeigen, wie die Informationen in den Artikeln in diesem Abschnitt für Ihre Umgebung gelten. Sie können auch alle anderen Vorgänge ausführen, um die Funktionen der Web-API auszuprobieren.

Einrichten einer Insomnia-Umgebung

Der Schlaflosigkeits-API-Client bietet eine hervorragende Möglichkeit, eine Verbindung mit Ihren Umgebungen herzustellen und die Dataverse Web-API zu erkunden. Schlaflosigkeit kann die Verwaltung des Zugriffstokens bei Verwendung der Dataverse-Web-API erheblich vereinfachen.

Verwenden Sie die Schritte in Use Insomnia mit der Dataverse-Web-API

Verwenden von PowerShell mit Visual Studio Code

Führen Sie die Schritte in der Schnellstartweb-API mit PowerShell und Visual Studio Code aus, um sich beim Dienst zu authentifizieren. Die Verwendung von PowerShell und Visual Studio Code mit der Dataverse-Web-API wird im Schnellstart erweitert, um erweiterte Möglichkeiten für die Interaktion mit der Dataverse Web-API zu beschreiben. Der Abschnitt " CsDL- $metadata-Dokument der Dataverse-Web-API herunterladen " enthält ein Skript zum Herunterladen des CSDL-$metadata Dokuments.

OData v4.0-Standard

Die Artikel in diesem Abschnitt fassen Informationen zusammen, die für die Dataverse Web-API-Implementierung des OData v4.0-Standards relevant sind. Ein Dienst, der OData implementiert, muss den in der Spezifikation festgelegten Standards entsprechen, ist jedoch nicht erforderlich, um alle Teile der Spezifikation zu implementieren.

Weitere Informationen finden Sie in den folgenden Dokumenten:

Nächste Schritte

Erfahren Sie mehr über die Web-API-Dienstdokumente.

Siehe auch

Web-API-Dienstdokumente
Web-API EntityTypes
Web-API-Eigenschaften
Web-API-Navigationseigenschaften
Web-API-Aktionen
Web-API-Funktionen
Komplexe Web-API- und Enumerationstypen
Verwenden der Dataverse-Web-API
Authentifizieren bei Dataverse mit der Web-API
Ausführen von Vorgängen mithilfe der Web-API