TransformImportRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to submit an asynchronous job that transforms the parsed 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.TransformImportRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class TransformImportRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class TransformImportRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type TransformImportRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class TransformImportRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod TransformImportRequest()

Initializes a new instance of the TransformImportRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty ImportId

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

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

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

See Also

ImportRecordsImportResponse
Microsoft.Crm.Sdk.Messages Namespace
Import data
Import (data import) entity messages and methods
Run data import
Sample: Import data using complex data map
TransformImport message privileges
How role-based security can be used to control access to entities in Microsoft Dynamics CRM
How record-based security can be used to control access to records in Microsoft Dynamics CRM

Return to top

© 2016 Microsoft. All rights reserved. Copyright