AutoMapEntityRequest Class

Definition

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

public ref class AutoMapEntityRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AutoMapEntityRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type AutoMapEntityRequest = class
    inherit OrganizationRequest
Public NotInheritable Class AutoMapEntityRequest
Inherits OrganizationRequest
Inheritance
AutoMapEntityRequest
Attributes

Remarks

For the Web API use the AutoMapEntity action.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have following privileges: prvReadEntityMap, prvReadAttributeMap, and prvWriteRelationship

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.

Constructors

AutoMapEntityRequest()

Initializes a new instance of the AutoMapEntityRequest class.

Properties

EntityMapId

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

ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId

Gets or sets the ID of the request. Optional.

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to