ImportRecordsImportRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to submit an asynchronous job that uploads the transformed data into Microsoft Dynamics CRM.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

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

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

Example

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.

// Upload the records.
ImportRecordsImportRequest importRequest = new ImportRecordsImportRequest()
{
    ImportId = importId
};
ImportRecordsImportResponse importResponse =
    (ImportRecordsImportResponse)_serviceProxy.Execute(importRequest);
Console.WriteLine("Waiting for ImportRecords async job to complete");

' Upload the records.
Dim importRequest As New ImportRecordsImportRequest() With {.ImportId = importId}
Dim importResponse As ImportRecordsImportResponse =
    CType(_serviceProxy.Execute(importRequest), ImportRecordsImportResponse)
Console.WriteLine("Waiting for ImportRecords async job to complete")

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of ImportRecordsImportResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Import entity and access rights on the record specified in the ImportId property. For a complete list of the required privileges, see ImportRecordsImport Privileges.

Notes for Callers

Pass the ID of the associated data import (import) in the ImportId property. The ID of the asynchronous job that runs in the background and uploads the data into Microsoft Dynamics CRM is returned in the AsyncOperationId property of the message response. All import files that are associated with the specified data import (import) are imported.

Inheritance Hierarchy

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

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

ImportRecordsImportRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources