Export (0) Print
Expand All

RetrieveParsedDataImportFileRequest Class

Applies To: CRM 2015 on-prem, CRM Online

[This topic is pre-release documentation and is subject to change in future releases.]

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

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

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.


// 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.
RetrieveParsedDataImportFileRequest 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"
    }
};

RetrieveParsedDataImportFileResponse parsedDataResponse =
    (RetrieveParsedDataImportFileResponse)_serviceProxy.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++;
}

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

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


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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Target Platforms

Windows Server 2008,Windows Server 2012,Windows 7

Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.

Community Additions

ADD
Show:
© 2015 Microsoft