ImportMappingsImportMapRequest Class

 

Updated: November 29, 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)

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

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

NameDescription
System_CAPS_pubmethodImportMappingsImportMapRequest()

Initializes a new instance of the ImportMappingsImportMapRequest class.

NameDescription
System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyMappingsXml

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

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyReplaceIds

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_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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));

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: