ImportMappingsImportMapRequest ImportMappingsImportMapRequest ImportMappingsImportMapRequest ImportMappingsImportMapRequest Class

Definition

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.

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

Examples

// 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)svc.Execute(request);
_newImportMapId = response.ImportMapId;
Console.WriteLine(String.Concat("\nNew import mapping created: ",_newImportMapId.Value));

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.

DataImport#ImportMappingsImportMap DataImportVB#ImportMappingsImportMap

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(OrganizationRequest) 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.

Constructors

ImportMappingsImportMapRequest() ImportMappingsImportMapRequest() ImportMappingsImportMapRequest() ImportMappingsImportMapRequest()

Initializes a new instance of the ImportMappingsImportMapRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
MappingsXml MappingsXml MappingsXml MappingsXml

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

Parameters Parameters Parameters Parameters

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

(Inherited from OrganizationRequest)
ReplaceIds ReplaceIds ReplaceIds 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 RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

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

(Inherited from OrganizationRequest)

Applies to

See also