ImportRecordsImportRequest ImportRecordsImportRequest ImportRecordsImportRequest ImportRecordsImportRequest Class

Definition

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

For the Web API use the ImportRecordsImport Action.

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

Examples


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

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#ImportWithCreate6 DataImportVB#ImportWithCreate6

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 theExecute(OrganizationRequest) method, which returns an instance ofImportRecordsImportResponse.

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 message 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 365 is returned in the AsyncOperationId property of the message response. All import files that are associated with the specified data import (import) are imported.

Constructors

ImportRecordsImportRequest() ImportRecordsImportRequest() ImportRecordsImportRequest() ImportRecordsImportRequest()

Initializes a new instance of the ImportRecordsImportRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
ImportId ImportId ImportId ImportId

Gets or sets the ID of the data import (import) that is associated with the asynchronous import records job. Required.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

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

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