GetHeaderColumnsImportFileRequest GetHeaderColumnsImportFileRequest GetHeaderColumnsImportFileRequest GetHeaderColumnsImportFileRequest Class

Definition

Contains the data that is needed to retrieve the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings.

For the Web API use GetHeaderColumnsImportFile Function.

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

Examples


// Retrieve the header columns used in the import file.
      
      var headerColumnsRequest = new GetHeaderColumnsImportFileRequest()
      {
          ImportFileId = importFileId
      };
      var headerColumnsResponse = (GetHeaderColumnsImportFileResponse)svc.Execute(headerColumnsRequest);

// Output the header columns.
      int columnNum = 1;
      foreach (string headerName in headerColumnsResponse.Columns)
      {
          Console.WriteLine("Column[" + columnNum.ToString() + "] = " + headerName);
          columnNum++;
      }

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

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(OrganizationRequest) method, which returns an instance of the GetHeaderColumnsImportFileResponse class.

Privileges and Access Rights

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

Constructors

GetHeaderColumnsImportFileRequest() GetHeaderColumnsImportFileRequest() GetHeaderColumnsImportFileRequest() GetHeaderColumnsImportFileRequest()

Initializes a new instance of the GetHeaderColumnsImportFileRequest 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)
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