TransformImportRequest Class

Artículo
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 submit an asynchronous job that transforms the parsed data.

For the Web API use the TransformImport Action.

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

Syntax

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

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

Constructors

	Name	Description
	TransformImportRequest()	Initializes a new instance of the TransformImportRequest 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 import (data import) that is associated with the asynchronous job that transforms the imported data. 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 the TransformImportResponse class.

Privileges and Access Rights

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

Notes for Callers

Pass the ID of the associated import (data import) in the ImportId property. The ID of the asynchronous job that runs in the background and performs the transformation is returned in the AsyncOperationId property of the message response.

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.


// Transform the import
TransformImportRequest transformImportRequest = new TransformImportRequest()
{
    ImportId = importId
};
TransformImportResponse transformImportResponse =
    (TransformImportResponse)_serviceProxy.Execute(transformImportRequest);
Console.WriteLine("Waiting for Transform async job to complete");


' Transform the import.
Dim transformImportRequest As New TransformImportRequest() With
    {.ImportId = importId}
Dim transformImportResponse As TransformImportResponse =
    CType(_serviceProxy.Execute(transformImportRequest), TransformImportResponse)
Console.WriteLine("Waiting for Transform 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.

Compartir a través de