次の方法で共有

Microsoft Dataverse Web API を使用する

Dataverse でデータとテーブルと列の定義を操作するには、Web API または SDK for .NET を使用できます。

Dataverse Web API は、さまざまなプログラミング言語、プラットフォーム、デバイスで使用できる開発エクスペリエンスを提供します。 Web API は、多様なデータ ソースに対して RESTful API を構築して使用するための OASIS 標準規格 OData (オープン データ プロトコル)、バージョン 4.0 を実装します。 このプロトコルの詳細については、 を参照してください。 この OASIS 規格の詳細については をご参照ください。

Web API は、Python SDK 以外のオープン標準に基づいて構築されているため、Microsoft は特定の開発者エクスペリエンス用のアセンブリやライブラリを提供していません。 特定の操作に対する HTTP 要求を作成でき、サードパーティのライブラリを使用して必要な任意の言語またはプラットフォームに対応するクラスを生成することができます。 OData バージョン 4.0 をサポートするライブラリ一覧については、 を参照してください。

モデル駆動型アプリケーションとPower Pagesは、Web API を使用してデータ操作を実行するメソッドをオブジェクトに提供します。 参照:

  • Xrm.WebApi (クライアント API リファレンス)
  • ポータル Web API の概要

Web API および組織サービス

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

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

開始する

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

HTTP リクエストツール

認証された HTTP 要求の作成と送信に使用できるアプリケーションは、不可欠なツールです。 Postman、Bruno、curl など、多くのオプションを使用できます。 最適なツールを選択して使用します。 次の手順では、グラフィカル ユーザー インターフェイス、比較的簡単なインストール、およびアカウントの作成をオプトアウトするオプションを提供するため、 不眠症 の使用方法について説明します。 Dataverse Web API で不眠症を使用する方法について説明します。

チップ

既にお気に入りの HTTP 要求ツールがない限り、Visual Studio Codeで PowerShell を使用するのは簡単で、強力なスクリプト機能も利用できます。

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

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

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

.NET開発者

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

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

  • クイック スタート: Web API のサンプル (C#)
  • クイック スタート: Blazor Server Web API サンプル (C#)

その他の C# Web API サンプルについては、 Web API データ操作のサンプル (C#) を参照してください。

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

  • Last updated on