RetrieveParsedDataImportFileRequest RetrieveParsedDataImportFileRequest RetrieveParsedDataImportFileRequest RetrieveParsedDataImportFileRequest Class

Definition

Contains the data that is needed to retrieve the data from the parse table.

For the Web API use the RetrieveParsedDataImportFile Function.

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

Examples


// Retrieve data from the parse table.
// NOTE: You must create the parse table first using the ParseImport message.
// The parse table is not accessible after ImportRecordsImportResponse is called.

var parsedDataRequest = new RetrieveParsedDataImportFileRequest()
{
    ImportFileId = importFileId,
    PagingInfo = new PagingInfo()
    {
        // Specify the number of entity instances returned per page.
        Count = 2,
        // Specify the number of pages returned from the query.
        PageNumber = 1,
        // Specify a total number of entity instances returned.
        PagingCookie = "1"
    }
};

var parsedDataResponse =(RetrieveParsedDataImportFileResponse)svc.Execute(parsedDataRequest);

// Output the first two rows retrieved.
int rowCount = 1;
foreach (string[] rows in parsedDataResponse.Values)
{
    int colCount = 1;
    foreach (string column in rows)
    {
        Console.WriteLine("(" + rowCount.ToString() + "," + colCount.ToString() + ") = " + column);
        colCount++;
    }
    rowCount++;
}

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

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

Privileges and Access Rights

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

Notes for Callers

The parsed data is returned in a two-dimensional array of strings in the Values property of the message response. The data is returned with the same column order as the column order in the source file.

Use this message only after you have created a parse table by using the ParseImportRequest message.

Do not use this message after you use the ImportRecordsImportRequest message. You cannot access the parse table after the import job submitted by the ImportRecordsMessage message has finished running.

Constructors

RetrieveParsedDataImportFileRequest() RetrieveParsedDataImportFileRequest() RetrieveParsedDataImportFileRequest() RetrieveParsedDataImportFileRequest()

Initializes a new instance of the RetrieveParsedDataImportFileRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
ImportFileId ImportFileId ImportFileId ImportFileId

Gets or sets the ID of the import file that is associated with the parse table. Required.

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

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
PagingInfo PagingInfo PagingInfo PagingInfo

Gets or sets the paging information for the retrieved data. Required.

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