RetrieveParsedDataImportFileRequest Class

Article
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 retrieve the data from the parse table.

For the Web API use the RetrieveParsedDataImportFile Function.

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

Syntax

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

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

Constructors

	Name	Description
	RetrieveParsedDataImportFileRequest()	Initializes a new instance of the RetrieveParsedDataImportFileRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	ImportFileId	Gets or sets the ID of the import file that is associated with the parse table. Required.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	PagingInfo	Gets or sets the paging information for the retrieved data. Required.
	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 theExecute 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.

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.


// 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++;
}


' 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.
Dim parsedDataRequest As New RetrieveParsedDataImportFileRequest() With
    {
        .ImportFileId = importFileId,
        .PagingInfo = New PagingInfo() With
                      {
                          .Count = 2,
                          .PageNumber = 1,
                          .PagingCookie = "1"
                      }
    }
' Specify the number of entity instances returned per page.
' Specify the number of pages returned from the query.
' Specify a total number of entity instances returned.

Dim parsedDataResponse As RetrieveParsedDataImportFileResponse =
    CType(_serviceProxy.Execute(parsedDataRequest), 
        RetrieveParsedDataImportFileResponse)

' Output the first two rows retrieved.
Dim rowCount As Integer = 1
For Each rows As String() In parsedDataResponse.Values
    Dim colCount As Integer = 1
    For Each column As String In rows
        Console.WriteLine("(" &amp; rowCount.ToString() &amp; "," _
                          &amp; colCount.ToString() &amp; ") = " &amp; column)
        colCount += 1
    Next column
    rowCount += 1
Next rows

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.

Share via