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 ファイルを編集して、以下のプロパティ値を設定します:

   プロパティ	手順
   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 ブール列のオプションラベルを、UpdateOptionValue Action を使用して更新します。
5. sample_BankAccount テーブルに新しい sample_datetime datetime 列を作成し、取得します。
6. sample_decimal テーブルの新しい sample_BankAccount 小数列を作成して取得します。
7. sample_BankAccount テーブルの新しい sample_integer 整数列を作成して取得します。
8. sample_memo テーブルに新しい sample_BankAccount メモ列を作成して取得します。
9. sample_money テーブルの新しい sample_BankAccount 金額列を作成して取得します。
10. sample_choice テーブルの新しい sample_BankAccount 選択肢列を作成して取得します。
11. sample_choice 列に新しいオプションを追加するには、InsertOptionValue Action を使用します。
12. OrderOption Actionを使用して、sample_choiceのオプションの順序を変更します。
13. sample_choice 列の特定のオプションを削除するには、「DeleteOptionValueアクション」を使用してください。
14. sample_multiselectchoicet テーブルの新しい sample_BankAccoun 複数選択の選択肢列を作成して取得します。
15. sample_BankAccountを使用して、 テーブルの新しい Status オプションを作成します。

セクション 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を参照して、CanBeReferenced 関数を使い、テーブルが 1:N の関連付けで参照可能かどうかを確認します。
2. CanBeReferencing Functionを使用して、contactテーブルが 1:N のリレーションシップで他のテーブルを参照可能かどうかを確認します。
3. GetValidReferencingEntities Functionを使用して、どの他のテーブルが1:Nリレーションシップでsample_BankAccountテーブルを参照できるかを特定します。
4. sample_BankAccount要求をcontactに送信して、POST テーブルと/RelationshipDefinitions テーブルの間に 1:N リレーションシップを作成します。
5. GET 要求を /RelationshipDefinitions(<id>)/Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata に送信して、1:N リレーションシップを取得します。

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

操作:

1. sample_BankAccountに要求を送信して、account と POST テーブルの間に N:1 リレーションシップを/RelationshipDefinitionsで作成します。
2. GET 要求を /RelationshipDefinitions(<id>)/Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata に送信して、N:1 リレーションシップを取得します。

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

操作:

1. sample_BankAccount および contact テーブルが N:N 関係に参加できるかどうかを CanManyToMany 関数 で確認します。
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#)