ExportMappingsImportMapRequest Class

 

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

Contains the data that is needed to export a data map as an XML formatted data.

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

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExportMappingsImportMapRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ExportMappingsImportMapRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod ExportMappingsImportMapRequest()

Initializes a new instance of the ExportMappingsImportMapRequest class.

Properties

Name Description
System_CAPS_pubproperty ExportIds

Gets or sets a value that indicates whether to export the entity record IDs contained in the data map. Required.

System_CAPS_pubproperty ExtensionData

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

System_CAPS_pubproperty ImportMapId

Gets or sets the ID of the import map (data map) to export. Required.

System_CAPS_pubproperty Item[String]

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

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

Methods

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

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 of ExportMappingsImportMapResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the ImportMap entity and the access rights on the record specified in the ImportMapId property. For a complete list of required privileges, see ExportMappingsImportMap message privileges.

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.


// Retrieve the value for validation
var exportRequest = new ExportMappingsImportMapRequest
{
    ImportMapId = _newImportMapId.Value,
    ExportIds = true,
};

var exportResponse = (ExportMappingsImportMapResponse)_serviceProxy
    .Execute(exportRequest);

var mappingXml = exportResponse.MappingsXml;

Console.WriteLine(String.Concat("\nValidating mapping xml for : ", 
    _newImportMapId.Value, ",\nMappingsXml:\n", mappingXml));

         ' Retrieve the value for validation
         Dim exportRequest = New ExportMappingsImportMapRequest With
                             {
                                 .ImportMapId = _newImportMapId.Value,
                                 .ExportIds = True
                             }

         Dim exportResponse = CType(_serviceProxy.Execute(exportRequest), 
             ExportMappingsImportMapResponse)

Dim mappingXml = exportResponse.MappingsXml

         Console.WriteLine(String.Concat(vbLf &amp; "Validating mapping xml for : ",
                                         _newImportMapId.Value,
                                         "," &amp; vbLf &amp; "MappingsXml:" &amp; vbLf,
                                         mappingXml))

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

ExportMappingsImportMapResponse
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