Internet API-Typen und -Vorgänge
Die Artikel in diesem Bereich helfen Ihnen beim Verständnis der Dataverse-Web-API, indem er wichtige Konzepte vorstellt und Ihnen Möglichkeiten aufzeigt, die Informationen zu erhalten, die Sie benötigen, indem Sie die Dienstdokumente verstehen.
Wie die Microsoft Graph-API, Dataverse ist die Web API ein OData-RESTful-Dienst. Im Gegensatz zur Microsoft Graph-API hat jede Umgebung eine andere Organisations-URL und enthält benutzerdefinierte Tabellen und Vorgänge, die für jede Umgebung eindeutig sein können. Jede Umgebung ist aufgrund des einzigartigen Satzes von Anpassungen oder installierten Lösungen anders.
Schnellstart
Als Erstes sollten Sie sich die Servicedokumente für eine Dataverse-Umgebung ansehen, auf die Sie zugreifen können. Dazu müssen Sie die URL für Ihre Umgebung kennen. Anschließend empfehlen wir, dass Sie eine Möglichkeit einrichten, um die Authentifizierung beim Dienst zum Anzeigen von Dienstdokumenten zu verwalten.
Web API-Endpunkt-URL suchen
Verwenden Sie die Anweisungen in Entwicklerressourcen anzeigen, um eine Web-API Endpunkt für eine Umgebung zu identifizieren, auf die Sie zugreifen können. Sie sollte ungefähr so aussehen: https://yourorg.api.crm.dynamics.com/api/data/v9.2.
Authentifizierung beim Dienst
Es gibt mehrere Möglichkeiten zur Authentifizierung, um mit dem Dienst zu interagieren. Insomnia ist eine beliebte und weit verbreitete Wahl. Sie können stattdessen auch PowerShell mit Visual Studio Code verwenden.
Sie können jede der Methoden verwenden, um die Dienstdokumente abrufen und Beispiele sehen, die zeigen, wie die Informationen in den Artikeln in diesem Abschnitt auf Ihre Umgebung zutreffen. Sie können auch andere Vorgänge ausführen, um die Funktionen der Web API auszuprobieren.
Eine Insomnia-Umgebung einrichten
Der Insomnia-API-Client bietet eine großartige Möglichkeit, eine Verbindung zu Ihren Umgebungen herzustellen und die Dataverse-Web-API kennenzulernen. Insomnia kann die Verwaltung des Erhaltens eines Zugriffstokens bei der Verwendung der Dataverse-Web-API erheblich vereinfachen.
Gehen Sie wie in Insomnia mit der Dataverse-Web-API verwenden beschrieben vor
PowerShell mit Visual Studio Code verwenden
Verwenden Sie die Schritte in Schnellstart-Web-API mit PowerShell und Visual Studio Code, um sich beim Dienst zu authentifizieren. PowerShell und Visual Studio Code mit der Dataverse-Web-API verwenden vertieft den Schnellstart und beschreibt fortschrittlichere Möglichkeiten, um mit der Dataverse-Web-API zu interagieren. Der Abschnitt Das CSDL-$metadata-Dokument für die 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, jedoch nicht alle Teile der Spezifikation implementieren.
Weitere Informationen finden Sie in diesen Dokumenten:
- OData Version 4.0. Part 1: Protocol Plus Errata 03
- OData Version 4.0. Part 2: URL Conventions Plus Errata 03
- OData Version 4.0. Part 3: Common Schema Definition Language (CSDL) Plus Errata 03
- OData JSON-Format Version 4.0
Nächste Schritte
Erfahren Sie mehr über die Web API-Dienstdokumente.
Siehe auch
Web API-Servicedokumente
Web API Entitätstypen
Web API-Eigenschaften
Navigationseigenschaften der Web API
Web API-Aktionen
Web API-Funktionen
Komplexe Typen und Enumerationstypen (Web API)
Dataverse-Web API verwenden
Dataverse mit der Web-API authentifizieren
Vorgänge mithilfe der Web-API ausführen
Hinweis
Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)
Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).