ExportMappingsImportMapRequest 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 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 = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExportMappingsImportMapRequest : OrganizationRequest

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

Constructors

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

Properties

	Name	Description
	ExportIds	Gets or sets a value that indicates whether to export the entity record IDs contained in the data map. Required.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	ImportMapId	Gets or sets the ID of the import map (data map) to export. Required.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	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 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.