Web API テーブル スキーマ操作サンプル (C#)

この .NET 6.0 サンプルでは、Dataverse Web API を使用してテーブル、列、およびリレーションシップの定義を作成および変更する演算を実行する方法について説明します。

このサンプルでは、WebAPIService クラス ライブラリ (C#) の共通ヘルパー コードを使用します。

前提条件

以下は、このサンプルの構築および実行に必要となります :

• Microsoft Visual Studio 2022。
• データ演算を実行する権限を使用して Dataverse にアクセスします。

このサンプルを実行する方法

1. PowerApps-サンプル リポジトリをクローンまたはダウンロードします。

2. /dataverse/webapi/C#-NETx/MetadataOperations/ フォルダーを見つけます。

3. Visual Studio 2022 を使用して MetadataOperations.sln ファイルを開きます

4. appsettings.json ファイルを編集して、以下のプロパティ値を設定します:

   Property	方法
   Url	ご使用の環境の Url。 プレースホルダー https://yourorg.api.crm.dynamics.com の値を環境の値に置き換えます。 詳細については、開発者向けリソースを表示する を参照してください。
   UserPrincipalName	プレースホルダー you@yourorg.onmicrosoft.com の値を環境へのアクセスに使用する UPN の値に置き換えます。
   Password	プレースホルダー yourPassword の値を使用するパスワードに置き換えます。

5. appsettings.json ファイルを保存します

6. F5 を押してサンプルを実行します。

Code

このサンプルのコードは次のとおりです: PowerApps-Samples/dataverse/webapi/C#-NETx/MetadataOperations/Program.cs

実際の動作

このサンプルには 11 つのリージョンがあります:

セクション 0: 発行者とソリューションを作成

操作:ソリューション レコードと関連する発行者レコードを作成します。

セクション 1: テーブルの作成、取得、更新

操作:

1. sample_BankAccount 要求を POST に送信して、新しい /EntityDefinitions ユーザー所有テーブルを作成します。
2. GET 要求を /EntityDefinitions(LogicalName='sample_bankaccount') に送信して、作成されたテーブルを取得します。
3. PUT 要求を /EntityDefinitions(LogicalName='sample_bankaccount') に送信して、テーブルを更新します。

セクション 2: 列の作成、取得、更新

操作:

1. sample_boolean 要求を sample_BankAccount に送信して、POST テーブルに新しい /EntityDefinitions(LogicalName='sample_bankaccount')/Attributes ブール型の列を作成します。
2. sample_boolean 要求を GET に送信して、/EntityDefinitions(LogicalName='sample_bankaccount')/Attributes(LogicalName='sample_boolean') ブール型の列を取得します。
3. sample_boolean 要求を PUT に送信して、/EntityDefinitions(LogicalName='sample_bankaccount')/Attributes(LogicalName='sample_boolean') ブール型の列を更新します。
4. sample_boolean を使用して、 ブール列の値のオプション ラベルを更新します。
5. sample_datetime テーブルの新しい sample_BankAccount datetime 列を作成して取得します。
6. sample_decimal テーブルの新しい sample_BankAccount 小数列を作成して取得します。
7. sample_integer テーブルの新しい sample_BankAccount 整数列を作成して取得します。
8. sample_memo テーブルの新しい sample_BankAccount メモ列を作成して取得します。
9. sample_money テーブルの新しい sample_BankAccount 金額列を作成して取得します。
10. sample_choice テーブルの新しい sample_BankAccount 選択肢列を作成して取得します。
11. sample_choiceを使用して、 列に新しいオプションを追加します。
12. sample_choiceを使用して、 列のオプションの順序を変更します。
13. sample_choiceを使用して、 列のオプションの一つを削除します。
14. sample_multiselectchoicet テーブルの新しい sample_BankAccoun 複数選択の選択肢列を作成して取得します。
15. sample_BankAccountを使用して、 テーブルに新しいステータス オプションを作成します。

セクション 3: グローバル OptionSet の作成および使用

操作:

1. sample_colors 要求を POST に送信して、新しいグローバル選択肢の名前付き /GlobalOptionSetDefinitions を作成します。
2. sample_colors 要求を GET に送信して、/GlobalOptionSetDefinitions(<id value>) グローバル選択肢を取得します。
3. sample_colors 要求を sample_BankAccount に送信し、グローバル選択肢に関連付けることによって、sample_colors グローバル選択肢を使用して POST テーブルの新しい /EntityDefinitions(LogicalName='sample_bankaccount')/Attributes 選択肢列を作成します。

セクション 4: 顧客リレーションシップの作成

操作:

1. sample_customeridを使用して、sample_BankAccount テーブルに新しい 顧客列を作成します。
2. sample_customerid 要求を GET に送信して、/EntityDefinitions(LogicalName='sample_bankaccount')/Attributes(LogicalName='sample_customerid') 顧客列を取得します。
3. GET 要求を /RelationshipDefinitions(<id>)/Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata.` に送信して、顧客列に作成されたリレーションシップを取得します。

セクション 5: 一対多の関連付けの作成と取得

操作:

1. sample_BankAccountを使用して、 テーブルが 1:N の関連付けで参照できるかどうかを確認します。
2. contactを使用して、 テーブルが 1:N の関連付けで他のテーブルを参照できるかどうかを確認します。
3. sample_BankAccountを使用して、他のどのテーブルが、1:N の関連付けで テーブルを参照できるかを確認します。
4. sample_BankAccount 要求を contact に送信して、POST と /RelationshipDefinitions のテーブル間に 1:N の関連付けを作成します。
5. GET 要求を /RelationshipDefinitions(<id>)/Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata に送信して、1:N の関連付けを取得します。

セクション 6: 多対一の関連付けの作成と取得

操作:

1. sample_BankAccount 要求を account に送信して、POST と /RelationshipDefinitions のテーブル間に N:1 の関連付けを作成します。
2. GET 要求を /RelationshipDefinitions(<id>)/Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata に送信して、N:1 の関連付けを取得します。

セクション 7: 多対多の関連付けの作成と取得

操作:

1. sample_BankAccountを使用して、contact テーブルと テーブルが、N:N の関連付けに参加できるかどうかを確認します。
2. sample_BankAccountを使用して、contact テーブルと テーブルが、N:N の関連付けに参加できるかどうかを確認します。
3. sample_BankAccount 要求を contact に送信して、POST と /RelationshipDefinitions のテーブル間に N:N の関連付けを作成します。
4. GET 要求を /RelationshipDefinitions(<id>)/Microsoft.Dynamics.CRM.ManyToManyRelationshipMetadata に送信して、N:N の関連付けを取得します。

セクション 8: 管理ソリューションのエクスポート

操作: セクション0: 発行元とソリューションの作成 で作成したソリューションを、ExportSolutionアクションを使用して、このサンプルで作成した項目を含めてエクスポートします。

セクション 9: サンプル レコードを削除

操作: このサンプルで作成された各レコードへの参照は、作成時にリストに追加されました。 このサンプルでは、レコードが $batch 演算を使用して削除されます。

セクション10: 管理ソリューションのインポートと削除

操作:

1. ImportSolution アクションを使用して、セクション 8 でエクスポートしたソリューションをインポートします。
2. ソリューション テーブルをクエリして、インポートされたソリューションの solutionid を取得します。
3. solutionid を使用して、インポートされたソリューションを削除します。

クリーンアップ

デフォルトでは、このサンプルで作成されたすべてのレコードが削除されます。 サンプルが完了した後に作成されたレコードを表示する場合は、deleteCreatedRecords 変数を false に変更すると、レコードを削除するかどうかを確認するメッセージが表示されます。

参照

Dataverse Web API を使用する
WebAPIService クラス ライブラリ (C#)
テーブル定義による Web API の利用
Web API のサンプル
Web API 基本操作のサンプル (C#)
Web API クエリ データのサンプル (C#)
Web API 条件付き演算サンプル (C#)
Web API 機能およびアクションのサンプル (C#)
Web API WebApiService の並列演算のサンプル (C#)
TPL データフロー コンポーネントを使用した Web API 並列演算のサンプル (C#)