Microsoft Dataverse Web API の使用

2025-06-10

WebAPI や SDK for .NET を使用してデータを操作したり、Dataverse　でテーブルや列の定義を行うことができます。

Dataverse は、各種のプログラミング言語、プラットフォーム、およびデバイスで使用できる開発作業を提供します。 Web API は、多様なデータソースに対して RESTful API を構築して使用するための OASIS 標準規格 OData (オープンデータプロトコル)、バージョン 4.0 を実装します。このプロトコルの詳細については、https://www.odata.org/ を参照してください。この OASIS 規格の詳細については https://www.oasis-open.org/standards#odatav4.0 をご参照ください。

Web API はオープンスタンダードに基づいて構築されるので、特定の開発者環境用のアセンブリは提供しません。特定の操作に対する HTTP 要求を作成でき、サードパーティのライブラリを使用して必要な任意の言語またはプラットフォームに対応するクラスを生成することができます。 OData バージョン 4.0 をサポートするライブラリ一覧については、https://www.odata.org/libraries/ を参照してください。

Web API および組織サービス

組織サービスがプラットフォームを定義するものであると認識することは有益です。 Web API は RESTful プログラミングエクスペリエンスを提供しますが、最終的にはすべてのデータ操作は、基盤となる組織サービスを実行します。組織サービスのサポートされる操作はメッセージとして定義されます。各メッセージには名前があります。これらの名前は、どの登録された拡張を開始するかを評価するため、イベントフレームワークで使用されるイベントに結び付けられています。詳細: イベントフレームワーク

Web API では、SDK for .NET と同じ操作を行うことができますが、RESTful な形式で表示されます。 OData v4 は関数またはアクションにより、名前付き操作を提供します。組織サービスで使用可能なメッセージの多くは、対応する名前付き関数またはアクションとして公開されています。 CRUD 操作に対応するこれらのメッセージは、RESTful サービスとして GET、POST、PATCH、DELETE メソッドと HTTP メソッドを使用した実装があるため、Web API では利用できませんが、プラットフォーム内では、retrieve、create、update、delete メッセージは、対応する操作が SDK for .NET アセンブリを使用して実行されるのと同じ方法で呼び出されます。

開始する

Web API は、認証された HTTP 要求を送信できる任意の言語で使用できます。 4 つの一般的なシナリオに対して、いくつかの使用開始エクスペリエンスを用意しました。

HTTP 要求ツール

認証された HTTP リクエストを作成して送信できるアプリケーションは、重要な最初の手順です。 Postman、Bruno、curlなど、多くの選択肢があります。お好きな方を選んでお使いください。 Insomnia はグラフィックユーザーインターフェイス、比較的簡単なインストール、アカウントの作成を選択を解除するオプションを備えているため、使用するためのいくつかの手順を提供します。 Dataverse Web API を使用した Insomnia の使用方法

チップ

既にお気に入りの HTTP リクエストツールがない限り、PowerShell を Visual Studio Codeで使用する方法が、簡単に始められ、強力なスクリプト機能も使えることが分かるかもしれません。

PowerShell開発者

PowerShell で Web API を使用することは、開始する最も簡単な方法の 1 つです。 Invoke-RestMethod コマンドレットを使用すると、 ConvertTo-Json コマンドレットを使用して要求を送信し、応答を処理できます。

Web API での PowerShell の使用については、次のコンテンツを参照してください。

JavaScript開発者

JavaScript 開発者は、モデル駆動型アプリで Dataverse Web API を頻繁に使用します。モデル駆動型アプリは、Web API と対話するためのメソッドを公開する Xrm.WebApi オブジェクトを提供します。モデル駆動型アプリで Web API を使用するクライアントサイドの JavaScript について解説します。

シングルページアプリケーション (SPA) も JavaScript を使用し、Dataverse Web API に接続することができます。 Quickstart: クライアント側の JavaScript と Visual Studio Code を使用した Web API では、SPA パターンを使用して Web API に接続する方法について説明します。その他のサンプルについては、Web API データ操作のサンプル (クライアント側 JavaScript)を参照してください。

Power Apps Component Framework (PCF) コンポーネント内では、JavaScript 開発者は WebAPI オブジェクトの一部であるメソッドを使用して、PCF コンポーネント内の Dataverse データを操作します。

最後に、Power Pages は Portals Web API を公開し、Web API を使用して利用可能な Dataverse の操作のサブセットを提供します。

.NET 開発者

.NET 開発者は、Dataverse SDK for .NET または Web API を使用できます。特定の NuGet パッケージへに依存したくない場合や、プロジェクトの要件が SDK for .NET が提供する厳密に型指定されたクラスを必要としない場合、Web APIを使用する場合があります。

C# で Web API を使用するには、次のクイックスタート記事を参照してください。

Web API データ操作のサンプル (C#) には、他にも多くの C# Web API サンプルがあります

コードを使用したデータに関する作業
 OData - REST への最善の方法
 OData バージョン 4.0 パート 1: Protocol Plus Errata 02
OData バージョン 4.0 パート 2: URL Conventions Plus Errata 02
OData バージョン 4.0 パート 3: Common Schema Definition Language (CSDL) Plus Errata 02

次の方法で共有