ImportMappingsImportMapRequest Class


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

Contains the data that is needed to import the XML representation of a data map and create an import map (data map) based on this data.

For the Web API use the ImportMappingsImportMap Action.

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

Inheritance Hierarchy



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


Name Description
System_CAPS_pubmethod ImportMappingsImportMapRequest()

Initializes a new instance of the ImportMappingsImportMapRequest class.


Name Description
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 MappingsXml

Gets or sets an XML representation of the data map. Required.

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 ReplaceIds

Gets or sets a value that indicates whether to import the entity record IDs contained in the XML representation of the data map. Required.

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 ofImportMappingsImportMapResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the ImportMap entity. For a complete list of required privileges, see ImportMappingsImportMap message privileges.

Notes for Callers

The XML data describing the data map must be well-formed and valid.


The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

// Create the import mapping from the XML
var request = new ImportMappingsImportMapRequest
    MappingsXml = _mappingXml,

    ReplaceIds = true,

Console.WriteLine(String.Concat("\nCreating mapping based on XML:\n", 

var response = (ImportMappingsImportMapResponse)

_newImportMapId = response.ImportMapId;

Console.WriteLine(String.Concat("\nNew import mapping created: ", 

         ' Create the import mapping from the XML
         Dim request = New ImportMappingsImportMapRequest With
                           .MappingsXml = _mappingXml,
                           .ReplaceIds = True

         Console.WriteLine(String.Concat(vbLf &amp; "Creating mapping based on XML:" &amp; vbLf,

         Dim response = CType(_serviceProxy.Execute(request), 

_newImportMapId = response.ImportMapId

         Console.WriteLine(String.Concat(vbLf &amp; "New import mapping created: ",

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
Import data
Create data maps for import
Add transformation mappings for import
Sample: Export and import a data map
The security model of Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright