AutoMapEntityRequest Class


Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to generate a new set of attribute mappings based on the metadata.

For the Web API use the AutoMapEntity Action.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class AutoMapEntityRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class AutoMapEntityRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod AutoMapEntityRequest()

Initializes a new instance of the AutoMapEntityRequest class.


Name Description
System_CAPS_pubproperty EntityMapId

Gets or sets the ID of the entity map to overwrite when the automated mapping is performed. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute method, which returns an instance of the AutoMapEntityResponse class.

Privileges and Access Rights

To perform this action, the caller must have the privileges that are listed in AutoMapEntity message privileges.

Notes for Callers

Use this helper function after you create a new relationship. This message is provided as a productivity enhancement so that you don’t have to manually add all attribute mappings. Instead, you can generate a set of likely mappings and minimize the amount of manual work to add or remove individual mappings to meet your requirements. This message will map all the attributes between the two related entities where the attribute names are identical and the types are identical. The mapping may result in some mappings that you don’t want; therefore, you should always check the resulting mapping before you publish the customization.


If you use this function where entity mappings already exist, the existing mappings are removed.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Customize entity and attribute mappings
AutoMapEntity message privileges

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright