RetrieveParsedDataImportFileRequest Class
Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online
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)
Syntax
'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveParsedDataImportFileRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveParsedDataImportFileRequest : OrganizationRequest
Example
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("(" & rowCount.ToString() & "," _
& colCount.ToString() & ") = " & column)
colCount += 1
Next column
rowCount += 1
Next rows
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 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.
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveParsedDataImportFileRequest
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.
Platforms
Development Platforms
Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)
Target Platforms
Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),
Change History
See Also
Reference
RetrieveParsedDataImportFileRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveParsedDataImportFileResponse
Other Resources
Import Data in Microsoft Dynamics CRM
ImportFile Entity Messages and Methods
Sample: Import Data Using Complex Data Map
RetrieveParsedDataImportFile Privileges
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.