About the Entity Reference
Applies to Dynamics 365 for Customer Engagement apps version 9.x
Use this reference to understand the available operations that can be performed for specific entities, the default attributes of each entity and the relationships between entities.
This reference is generated from a tenant with multiple solutions from Dynamics 365 installed but is not customized. This includes entities that may not exist in your environment because these solutions are not installed. Custom entities, attributes, and relationships cannot be included here.
This reference includes only entities where:
- IsPrivate equals
- This excludes entities where no external use cases exist.
- IsIntersect equals
- This excludes entities used to define Many-to-many relationships.
- The entity supports some kind of operation.
- This excludes entities which you can't use.
To see all entity metadata information for your environment, see Browse the metadata for your organization.
The messages in this list are applicable for the entity. For example, user-owned entities support the
RevokeAccess messages while organization-owned entities do not. Other entities will have specialized messages, such as
DeleteAuditData which applies only to the Audit Entity.
When using the Organization service, you can usually invoke the corresponding request class which will belong to either the Microsoft.Crm.Sdk.Messages or Microsoft.Xrm.Sdk.Messages namespaces. These classes have names that include the
Request prefix added to the message name.
Some messages are added as custom actions for the solutions they support. These messages are not defined within the SDK assemblies but .NET developers can generate strongly typed classes for actions by using the code generation tool (CrmSvcUtil.exe) or by using the OrganizationRequest class. More information: Generate early-bound types for an action and .
When using the Web API, you can usually invoke the corresponding Function or Action with the same name as the message. Not every message that can be invoked using the SDK assemblies have a corresponding Web API function or action. For example, the
SetState message is deprecated and was not implemented for the Web API.
This section includes selected entity properties rather than all of them. Only those properties expected to be most useful for developers are included. Some entity properties can be changed. If you need to find properties not listed here, or to see the current property values in your environment, see Browse the metadata for your organization.
Attributes are listed in two separate sections: Writable attributes and Read-only attributes. The purpose of this separation is to focus on the attributes a developer can set when creating or updating an entity instance. Understanding these attributes helps a developer understand what they can do with the entity beyond simply retrieving the values.
The attributes in the Writable attributes section return true for either the IsValidForCreate or IsValidForUpdate properties, (usually both). If either of these properties return false, this is indicated.
Read-only attributes are always return false for the IsValidForCreate and IsValidForUpdate properties.
The EntityMetadata class includes three properties to represent relationships:
|OneToManyRelationships||OneToManyRelationshipMetadata||Gets the array of one-to-many relationships for the entity.|
|ManyToOneRelationships||OneToManyRelationshipMetadata||Gets the array of many-to-one relationships for the entity.|
|ManyToManyRelationships||ManyToManyRelationshipMetadata||Gets the array of many-to-many relationships for the entity.|
It is important to keep in mind that while each entity lists those relationships which apply to it, each relationship is shared by both related entities. The relationships exist between entities. While One-To-Many relationships exist, Many-to-One relationships are simply a view of a One-To-Many relationship from the referencing entity.
In order to represent that there are no actual Many-to-One relationships with a minimum of confusion, the details of each relationship are only documented once. Each One-to-Many relationship is listed with the referenced entity and includes selected relationship details and a link to the corresponding Many-to-One relationship. Each Many-to-One relationship listed includes only a link to the corresponding One-to-Many relationship.
Each Many-to-Many relationship includes Entity1LogicalName and Entity2LogicalName. For this documentation relationship details are only included in the topic for Entity1. Each Many-to-Many relationship where the entity is Entity2 includes only a link to the details found in the topic for Entity1.
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.