エンティティの参照について

  • [アーティクル]

このリファレンスを使用して、特定のエンティティに対して実行可能な操作、各エンティティのデフォルトの属性、エンティティ間の関連付けについて説明します。

Note

この参照は、Dynamics 365 の複数のソリューションがインストールされているが、カスタマイズされていないテナントから生成されます。 これには、これらのソリューションがインストールされていないため、環境内に存在しないエンティティが含まれます。 ユーザー定義エンティティ、属性、およびリレーションシップをここに含めることはできません。

この参照には以下の場合のエンティティのみが含まれています:

  • IsPrivate が false と等しい
    • 外部のユースケースが存在しないエンティティは除外されます。
  • IsIntersect が false と等しい
    • これは、多対多の関連付けを定義するために使用されるエンティティを除外します。
  • エンティティは特定の種類の操作をサポートします。
    • これは使用できないエンティティを除外します。

ご使用の環境のすべてのエンティティ メタデータ情報については、「組織のメタデータの参照」を参照してください。

メッセージ

このリストのメッセージはエンティティに適用されます。 たとえば、ユーザー所有のエンティティは、組織所有のエンティティがサポートしていないときに、Assign、GrantAccess、ModifyAccess、および RevokeAccess をサポートします。 他のエンティティには、監査エンティティ にのみ適用されるDeleteAuditData などの特別なメッセージがあります。

組織のサービス

組織サービスを使用する場合、通常、Microsoft.Crm.Sdk.Messages および Microsoft.Xrm.Sdk.Messages の名前空間に属する対応する要求クラスを呼び出すことができます。 これらのクラスは、メッセージ名に追加された Request プレフィックスを含む名前を持っています。

一部のメッセージは、サポートするソリューションのカスタム アクションとして追加されます。 これらのメッセージは SDK アセンブリ内では定義されていませんが、.NET開発者はコード生成ツール (CrmSvcUtil.exe) を使用するか、OrganizationRequest クラスを使用して厳密に型指定されたクラスを生成できます。 詳細については、アクションの事前バインド型を生成するを参照してください。

Web API

Web API を使用するときは、通常、メッセージと同じ名前の対応する関数またはアクションを呼び出すことができます。 SDK アセンブリを使用して呼び出すことができるすべてのメッセージに、対応する Web API 関数またはアクションがあるわけではありません。 たとえば、SetState メッセージは廃止され、Web API に実装されませんでした。

エンティティ プロパティ

このセクションには、すべてではなく選択されたエンティティ プロパティが含まれています。 開発者にとって最も役に立つと予想されるプロパティのみが含まれます。 一部のエンティティ プロパティの場合、これを変更できます。 ここに記載されていないプロパティを検索する必要がある場合、または環境内の現在のプロパティ値を表示する必要がある場合は、「組織のメタデータの参照」を参照してください。

属性

属性は次の 2 つのセクションに分かれています: 書き込み可能な属性および読み取り専用属性。 この分離の目的は、エンティティ インスタンスを作成または更新するときに開発者が設定できる属性に重点を置くことです。 これらの属性を理解することは、単に値を取得するだけでなく、エンティティでできることを理解するのに役立ちます。

書き込み可能な属性セクションの属性は、IsValidForCreate または IsValidForUpdate プロパティの いずれか に対して true を返します (通常は両方)。 これらのプロパティのいずれかが false を返す場合、これが示されます。

読み取り専用属性は、IsValidForCreate および IsValidForUpdate プロパティに常に false を返します。

リレーションシップ

EntityMetadata クラスには、関連付けを表す 3 つのプロパティが含まれます。

プロパティ 種類​​ 内容
OneToManyRelationships OneToManyRelationshipMetadata[] エンティティの 1 対多リレーションシップの配列を取得します。
ManyToOneRelationships OneToManyRelationshipMetadata[] エンティティの多対 1 リレーションシップの配列を取得します。
ManyToManyRelationships ManyToManyRelationshipMetadata[] エンティティの多対多リレーションシップの配列を取得します。

Note

各エンティティがそれに適用されるそれらの関連付けをリストする一方、各関連付けは両方の関連するエンティティによって共有されることに留意することが重要です。 この関連付けはエンティティ間に存在します。 1 対多の関連付けが存在する一方で、多対 1 関連付けは、単に参照元エンティティからの 1 対多の関連付けのビューです。

一対多関連付け

混乱を最小限に抑えて実際の 多対 1 関連付けが存在しないことを表すために、各関連付けの詳細は一度しか記録されません。 各 1 対多の関連付けは、参照されたエンティティとともにリストされ、選択された関連付けの詳細と、対応する [多対 1] の関連付けへのリンクを含みます。 リストされた [多対 1] の関連付けには、対応する 1 対多の関連付けへのリンクのみが含まれます。

多対多関連付け

各多対多関連付けには、Entity1LogicalName および Entity2LogicalName が含まれます。 このドキュメントでは、関連付けの詳細は、[エンティティ 1] のトピックにのみ含まれています。 エンティティが エンティティ 2 のそれぞれの多対多の関連付けには、エンティティ 2 のトピックの詳細へのリンクのみが含まれています。

注意

Dynamics 365 Customer Engagement (on-premises) での販売に関連する開発者の概念と操作は、Dynamics 365 Sales に似ています。 販売関連エンティティの拡張性については、Dynamics 365 Sales の開発者ガイドを参照してください。