テーブル定義による Web API の利用

  • [アーティクル]

Web APIで、.NET 用 SDK を使用して実行できるテーブルと列の定義 (メタデータ) の操作を実行できます。 このセクションでは、Web API を Web API Metadata Entity Type Reference に含まれているエンティティの種類と一緒に使用する方法に関するガイダンスを提供しています。

次の表で説明するように、定義エンティティで操作を実行するために公開される 4 つのエンティティ セット パスがあります。

エンティティ セット パス Description
[組織 URI]/api/data/v9.2/EntityDefinitions EntityMetadata EntityType のコレクションが含まれています。
[組織 URI]/api/data/v9.2/RelationshipDefinitions ManyToManyRelationshipMetadata EntityType および OneToManyRelationshipMetadata EntityType は、両方とも RelationshipMetadataBase EntityType から継承されているため、含まれる。
[組織 URI]/api/data/v9.2/GlobalOptionSetDefinitions グローバルに定義された BooleanOptionSetMetadata EntityType と OptionSetMetadata EntityType のコレクションを含み、両方とも OptionSetMetadata EntityType から継承しています。
[組織 URI]/api/data/v9.2/ManagedPropertyDefinitions 内部のみで使用

各定義エンティティの種類は、MetadataBase EntityType から継承する一意識別子プロパティとして MetadataId を使用します。 すべての定義エンティティには MetadataId がありますが、それらすべてを直接クエリすることはできません。 たとえば、属性 (テーブル列) を含む EntityMetadata エンティティのコンテキストでのみ、属性に対するクエリと操作を実行できます。

これらの定義エンティティには、ビジネス データとアプリケーション データを格納するテーブルとは大きく異なります、たとえば、次のとおりです:

  • 定義エンティティのプロパティは、crmbaseentity EntityType から継承するエンティティのプロパティに使用されるプリミティブ データ型ではなく、Web API Complex Type Reference と Web API Enum Type Reference で定義されている多くの複合型と列挙型を使用します。

  • 定義エンティティは異なる命名規則に従い、.NET 用 SDK のアセンブリで使用される Pascal 形式の命名スタイルを維持します。

  • 定義エンティティは、継承をより広範囲に使用するため、必要なデータを取得するためにキャストを実行する必要がある場合があります。

このセクションの内容

Web API を使用したテーブル定義のクエリ
Web API を使用し、RESTful クエリ スタイルを使用してテーブルまたは列の定義をクエリできます。

名前または MetadataId によるテーブル定義を取得する
アプリケーションは、テーブルと列の定義をクエリすることにより、構成の変更に適応できます。 定義アイテムの重要なプロパティの 1 つがわかっている場合は、Web API を使用して定義を取得できます。

Web API を使用したテーブル定義の作成および更新
Web API を使用してテーブルを作成および更新し、.NET 用 SDK CreateEntityRequest および UpdateEntityRequest で得た同じ結果を果たせます。

Web API を使用して列定義を作成および更新
Web API を使用して列を作成および更新し、.NET 用 SDK CreateAttributeRequest および UpdateAttributeRequest で得た同じ結果を果たせます。

Web API を使用したテーブルの関連付けの作成および更新
テーブルが他のテーブルとの関連付けにおいて参加できるかどうかを確認してから、Web API を使用してそれらの関連付けを作成または更新できます。

マルチテーブル検索
マルチテーブル検索タイプの列を使用すると、ユーザーは、環境内の他のテーブルに対して複数の一対多 (1:N) の関連付けを持つ特定のテーブルを使用できます。 単一の検索タイプの列は、他の複数のテーブルを参照できます。 マルチテーブル タイプの列に送信された検索値は、関連するテーブルのいずれかのレコードと一致します。 マルチテーブル検索は、ローカル テーブルと仮想テーブルの両方を参照テーブルとして作成できます。

Web API による選択肢 (オプション セット) の作成と更新
グローバル選択列とローカル選択列の操作方法について説明します。 オプション値を取得、追加、更新、削除、およびオプションを並べ替える方法。

参照

ご使用の環境でテーブル定義を参照する
Microsoft Dataverse Web API を使用する Web API テーブル スキーマ操作サンプル
Web API テーブル スキーマ操作サンプル (C#)

注意

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

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