TransformImportRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the data that is needed to submit an asynchronous job that transforms the parsed data.

public ref class TransformImportRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class TransformImportRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type TransformImportRequest = class
    inherit OrganizationRequest

Public NotInheritable Class TransformImportRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
TransformImportRequest

Attributes: DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must have an authenticated connection to the server with a client that implements the IOrganizationService interface instance.

/// <summary>
/// Performs the TransformImport Operation
/// </summary>
/// <param name="service">Authenticated client implementing the IOrganizationService interface</param>
/// <param name="importId">The import job id</param>
/// <returns>The ID of the asyncoperation job</returns>
static Guid TranformImportExample(IOrganizationService service, Guid importId) {

    // Transform the import
    var request = new TransformImportRequest()
    {
        ImportId = importId
    };
    var response =
        (TransformImportResponse)service.Execute(request);

    // Returns the ID of the asyncoperation job
    return response.AsyncOperationId;
}

Remarks

For the Web API use the TransformImport action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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.

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.

Constructors

TransformImportRequest()

Initializes a new instance of the TransformImportRequest class.

Properties

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 the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)

Applies to

Partager via