Import (data import) entity messages and methods

 

Applies To: Dynamics CRM 2013

This entity represents the status and ownership for the import job. The schema name for this entity is Import. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

CreateRequest

Creates a data import. You can also call the IOrganizationService.CreateRequest method.

DeleteRequest

Deletes a data import. You can also call the IOrganizationService.Delete method.

GrantAccessRequest

Shares a data import with another security principal (user or team).

ImportRecordsImportRequest

Submits an asynchronous job that uploads transformed data to the target server. The import records job imports all import files associated with the specified import (data import). Pass the ID of the associated import (data import) in the ImportId property of this request. The ID of the asynchronous job that runs in the background and performs uploading of data is returned in the AsyncOperationId property of the message response.

ModifyAccessRequest

Changes the access rights for a data import previously shared with another security principal (user or team).

ParseImportRequest

Submits an asynchronous job that parses all import files associated with the specified import (data import). Pass the ID of the associated import (data import) in the ImportId property of this request. The ID of the asynchronous job runs in the background and performs parsing of data is returned in the AsyncOperationId property of the message response.

RetrieveRequest

Retrieves a data import. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of data imports. You can also call the IOrganizationService.RetrieveMultiplemethod.

RetrievePrincipalAccessRequest

Retrieves the access the specified security principal (user or team) has to a data import.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a data import, and their access rights to the data import.

RevokeAccessRequest

Revokes access rights to the data import for the specified security principal (user or team).

TransformImportRequest

Submits an asynchronous job to transform the parsed data. Pass the ID of the associated import (data import) in the ImportId property of this request. The ID of the asynchronous job runs in the background and performs transformation of data is returned in the AsyncOperationId property of the message response.

UpdateRequest

Updates a data import. You can also call the UpdateRequest method.

Note

The parse table is not accessible after the asynchronous import records job is completed.

Use the following messages in this order:

  • ParseImport to parse data.

  • TransformImport to transform data.

  • ImportRecordsImport to upload data.

Do not submit a request for the next job before the previous job has finished running successfully.

See Also

Data import entities
Import (data import) entity privileges
ImportFile entity messages and methods