Web API の種類および操作

[アーティクル]
05/09/2024

この分野の記事では、重要な概念を紹介し、サービスドキュメントを理解することで必要な情報を入手できる方法を説明しているため、Dataverse Web API をよく把握することができます。

Microsoft Graph API のように、Dataverse Web API は OData RESTful サービスです。 Microsoft Graph API とは異なり、各環境には異なる組織 URL があり、各環境に固有のユーザー設定の表と操作が含まれています。インストールされているカスタマイズまたはソリューションの独自のセットにより、各環境は異なります。

最初の手順

最初にすべきことは、アクセスできる Dataverse 環境のサービスドキュメントを確認することです。このためには、ご使用の環境の URL を把握している必要があります。次に、いくつかの方法を設定して、サービスドキュメントを表示するサービスへの認証を管理することをお勧めします。

Web API エンドポイント URL を検索する

開発者リソースを表示するにある手順を使用して、アクセスできる環境の Web API エンドポイントを識別します。 https://yourorg.api.crm.dynamics.com/api/data/v9.2 のように表示されます。

サービスへの認証

サービスと対話するために認証を行う方法はいくつかあります。 Insomnia は広く採用されている人気のある選択肢です。代わりに、PowerShell を Visual Studio Code と使用することもできます。

いずれかの方法を使用して、サービスドキュメントを簡単に取得し、この記事のトピック情報を環境に適用している例を確認できます。また、Web API の機能を試して他の種類の操作を実行するのも簡単になります。

Insomnia 環境を設定する

API クライアントは、環境に接続して Web API Dataverse を探索するための優れた方法を提供します。を使用すると、Dataverse Web API を使用するときに、アクセストークンの取得管理を大幅に簡素化できます。

Dataverse Web API で Insomnia を使用するの手順を使用してください

Visual Studio Code と PowerShell を使用する

PowerShell を使用したクイックスタート Web API と Visual Studio Code の手順を使用して、サービスに対して認証します。 PowerShell と Dataverse Web API を持つ Visual Studio Code のクイックスタートを拡張して、 Dataverse Web API と対話するためのより高度な方法を説明します。 Dataverse Web API CSDL $metadata ドキュメントのダウンロードセクションには、CSDL $metadata ドキュメントをダウンロードするスクリプトが含まれています。

OData v4.0 標準

このセクションの記事は、OData v4.0 標準の Dataverse Web API 実装に関連する情報の概要です。 OData を実装するサービスは、仕様で設定された標準に従う必要がありますが、仕様のすべての部分を実装する必要はありません。

詳細については、このドキュメントを参照してください。

次の手順

Web API サービスドキュメントについて説明します。

サービスドキュメント

参照

Web API サービスドキュメント
 Web API EntityTypes
Web API プロパティ
 Web API ナビゲーションプロパティ
 Web API アクション
 Web API 関数
 Web API の複合型および列挙の種類
 Dataverse Web API を使用する
 Web API を使用した Dataverse への認証
 Web API を使用して演算を実行する

注意

ドキュメントの言語設定についてお聞かせください。簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。個人データは収集されません (プライバシーステートメント)。

次の方法で共有