ImportMappingsImportMapRequest Class

Article
11/28/2016

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

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.ImportMappingsImportMapRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ImportMappingsImportMapRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ImportMappingsImportMapRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	ImportMappingsImportMapRequest()	Initializes a new instance of the ImportMappingsImportMapRequest class.

Properties

	Name	Description
	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.)
	MappingsXml	Gets or sets an XML representation of the data map. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	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.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

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

Usage

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.

Examples

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", 
    _mappingXml));

var response = (ImportMappingsImportMapResponse)
    _serviceProxy.Execute(request);

_newImportMapId = response.ImportMapId;

Console.WriteLine(String.Concat("\nNew import mapping created: ", 
    _newImportMapId.Value));


         ' 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,
                                         _mappingXml))

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

_newImportMapId = response.ImportMapId

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

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.