ImportRecordsImportRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type ImportRecordsImportRequest = 
    class
        inherit OrganizationRequest
    end

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

Constructors

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

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	ImportId	Gets or sets the ID of the data import (import) that is associated with the asynchronous import records job. 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

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

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.


// 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")

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.

Share via