importfile EntityType

File name of file used for import.

Entity Set Path
[organization URI]/api/data/v9.0/importfiles
Base Type
crmbaseentity
Display Name
Import Source File
Primary Key
importfileid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
additionalheaderrow Edm.String

Shows the secondary column headers. The additional headers are used during the process of transforming the import file into import data records.

Display Name: Additional Header

Read Only
completedon Edm.DateTimeOffset

Shows the date and time when the import associated with the import file was completed.

Display Name: Completed On

Read Only
content Edm.String

Stores the content of the import file, stored as comma-separated values.

createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read Only
datadelimitercode Edm.Int32

Select the single-character data delimiter used in the import file. This is typically a single or double quotation mark.

Display Name: Data Delimiter

Default Options
Value Label
1 DoubleQuote
2 None
3 SingleQuote
enableduplicatedetection Edm.Boolean

Select whether duplicate-detection rules should be run against the import job.

Display Name: Enable Duplicate Detection

Default Options
Value Label
1 Yes
0 No
entitykeyid Edm.Guid

Unique identifier of the Alternate key Id

Display Name: Entity Key ID

failurecount Edm.Int32

Shows the number of records in the import file that cannot be imported.

Display Name: Errors

Read Only
fielddelimitercode Edm.Int32

Select the character that is used to separate each field in the import file. Typically, it is a comma.

Display Name: Field Delimiter

Default Options
Value Label
1 Colon
2 Comma
3 Tab
4 Semicolon
filetypecode Edm.Int32

Shows the type of source file that is uploaded for import.

Display Name: File Type

Default Options
Value Label
0 CSV
1 XML Spreadsheet 2003
2 Attachment
3 XLSX
headerrow Edm.String

Shows a list of each column header in the import file separated by a comma. The header is used for parsing the file during the import job.

Display Name: Header

Read Only
importfileid Edm.Guid

Unique identifier of the import file.

Display Name: Import

isfirstrowheader Edm.Boolean

Select whether the first row of the import file contains column headings, which are used for data mapping during the import job.

Display Name: Is First Row Header

Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read Only
name Edm.String

Shows the name of the import file. This name is based on the name of the uploaded file.

Display Name: Import Name

parsedtablecolumnprefix Edm.String

Shows the prefix applied to each column after the import file is parsed.

Display Name: Parse Table Column Prefix

Read Only
parsedtablecolumnsnumber Edm.Int32

Shows the number of columns included in the parsed import file.

Display Name: Parse Table Column Number

Read Only
parsedtablename Edm.String

Shows the name of the table that contains the parsed data from the import file.

Display Name: Parse Table

Read Only
partialfailurecount Edm.Int32

Shows the number of records in this file that had failures during the import.

Display Name: Partial Failures

Read Only
processcode Edm.Int32

Tells whether the import file should be ignored or processed during the import.

Display Name: Process Code

Default Options
Value Label
1 Process
2 Ignore
3 Internal
processingstatus Edm.Int32

Shows the import file's processing status code. This indicates whether the data in the import file has been parsed, transformed, or imported.

Display Name: Processing Status

Read Only
Default Options
Value Label
1 Not Started
2 Parsing
3 Parsing Complete
4 Complex Transformation
5 Lookup Transformation
6 Picklist Transformation
7 Owner Transformation
8 Transformation Complete
9 Import Pass 1
10 Import Pass 2
11 Import Complete
12 Primary Key Transformation
progresscounter Edm.Int32

Shows the progress code for the processing of the import file. This field is used when a paused import job is resumed.

Display Name: Progress Counter

Read Only
relatedentitycolumns Edm.String

Shows the columns that are mapped to a related record type (entity) of the primary record type (entity) included in the import file.

size Edm.String

Shows the size of the import file, in kilobytes.

Display Name: Size

source Edm.String

Shows the name of the data source file uploaded in the import job.

Display Name: Source

sourceentityname Edm.String

Shows the record type (entity) of the source data.

Display Name: Source Entity

statecode Edm.Int32

Shows the status of the import file record. By default, all records are active and can't be deactivated.

Display Name: Status

Default Options
Value Label
0 Active
statuscode Edm.Int32

Shows the reason code that explains the import file's status to identify the stage of the import process, from parsing the data to completed.

Display Name: Status Reason

Default Options
Value Label
0 Submitted
1 Parsing
2 Transforming
3 Importing
4 Completed
5 Failed
successcount Edm.Int32

Shows the number of records in the import file that are imported successfully.

Display Name: Successes

Read Only
targetentityname Edm.String

Select the target record type (entity) for the records that will be created during the import job.

Display Name: Target Entity

timezoneruleversionnumber Edm.Int32

For internal use only.

totalcount Edm.Int32

Shows the total number of records in the import file.

Display Name: Total Processed

Read Only
upsertmodecode Edm.Int32

Select the value which is used for identify the upsert mode. By Default, it is a Create.

Display Name: Upsert Mode

Default Options
Value Label
0 Create
1 Update
2 Ignore
usesystemmap Edm.Boolean

Tells whether an automatic system map was applied to the import file, which automatically maps the import data to the target entity in Microsoft Dynamics 365.

Display Name: Use System Map

Default Options
Value Label
1 Yes
0 No
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_importid_value importid

Choose the import job that the file was uploaded for.

_importmapid_value importmapid

Choose a data map to match the import file and its column headers with the record types and fields in Microsoft Dynamics 365. If the column headers in the file match the display names of the target fields in Microsoft Dynamics 365, we import the data automatically. If not, you can manually define matches during import.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who created the record on behalf of another user.

_ownerid_value ownerid

Enter the user who is assigned to follow up with or manage the import file. This field is updated every time the import file is assigned to a different user.

_owningbusinessunit_value owningbusinessunit

Shows the business unit that the record owner belongs to.

_owningteam_value owningteam

Unique identifier of the team who owns the import file.

_owninguser_value owninguser

Unique identifier of the user who owns the import file.

_recordsownerid_value recordsownerid_teamrecordsownerid_systemuser

Choose the user that the records created during the import job should be assigned to.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_importfilebase_createdby
createdonbehalfby systemuser lk_importfilebase_createdonbehalfby
importid import Import_ImportFile
importmapid importmap ImportMap_ImportFile
modifiedby systemuser lk_importfilebase_modifiedby
modifiedonbehalfby systemuser lk_importfilebase_modifiedonbehalfby
ownerid principal owner_importfiles
owningbusinessunit businessunit BusinessUnit_ImportFiles
owningteam team team_ImportFiles
owninguser systemuser SystemUser_ImportFiles
recordsownerid_systemuser systemuser ImportFile_SystemUser
recordsownerid_team team ImportFile_Team

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
ImportFile_AsyncOperations asyncoperation regardingobjectid_importfile
ImportFile_BulkDeleteFailures bulkdeletefailure regardingobjectid_importfile
ImportFile_ImportData importdata importfileid
ImportLog_ImportFile importlog importfileid

Operations

The following operations can be used with the importfile entity type.

Name Binding
GetDistinctValuesImportFile Entity
GetHeaderColumnsImportFile Entity
GrantAccess Not Bound
ModifyAccess Not Bound
RetrieveParsedDataImportFile Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the importfile entity type.

Name Description
Application Common For internal use only.
System Solution Internal CRM System Solution

See also