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

[アーティクル]
04/22/2022

注意

エンティティとテーブルの違いがわかりませんか？ Microsoft Dataverse で「開発者: 用語を理解する」を参照してください。

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

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

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

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

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

定義エンティティのプロパティは、crmbaseentity EntityType/ から継承するエンティティのプロパティに使用されるプリミティブデータ型ではなく、Web API ComplexType Reference と Web API EnumType Reference で定義されている多くの複合型と列挙型を使用します。
定義エンティティは異なる命名規則に従い、組織サービスのアセンブリで使用される Pascal 形式の命名スタイルを維持します。
定義エンティティは、継承をより広範囲に使用するため、必要なデータを取得するためにキャストを実行する必要がある場合があります。

このセクションの内容

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

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

Web API を使用したテーブル定義の作成および更新
Web API を使用してテーブルと列を作成および更新し、組織サービス CreateEntityRequest、UpdateEntityRequest、CreateAttributeRequest、UpdateAttributeRequest と同じ結果を得ることができます。

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

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

このセクションの内容

関連項目

フィードバック