Edit

Share via

Import Source File (ImportFile) entity reference

  • Article

File name of file used for import.

Messages

Message SDK class or method
Assign AssignRequest
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
GetDistinctValuesImportFile GetDistinctValuesImportFileRequest
GetHeaderColumnsImportFile GetHeaderColumnsImportFileRequest
GrantAccess GrantAccessRequest
ModifyAccess ModifyAccessRequest
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
RetrieveParsedDataImportFile RetrieveParsedDataImportFileRequest
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccessRequest
Update UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName ImportFiles
DisplayCollectionName Imports
DisplayName Import Source File
EntitySetName importfiles
IsBPFEntity False
LogicalCollectionName importfiles
LogicalName importfile
OwnershipType UserOwned
PrimaryIdAttribute importfileid
PrimaryNameAttribute name
SchemaName ImportFile

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Content

Property Value
Description Stores the content of the import file, stored as comma-separated values.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName content
MaxLength 1073741823
RequiredLevel SystemRequired
Type String

DataDelimiterCode

Property Value
Description Select the single-character data delimiter used in the import file. This is typically a single or double quotation mark.
DisplayName Data Delimiter
IsValidForForm True
IsValidForRead True
LogicalName datadelimitercode
RequiredLevel SystemRequired
Type Picklist

DataDelimiterCode Choices/Options

Value Label Description
1 DoubleQuote
2 None
3 SingleQuote

EnableDuplicateDetection

Property Value
Description Select whether duplicate-detection rules should be run against the import job.
DisplayName Enable Duplicate Detection
IsValidForForm True
IsValidForRead True
LogicalName enableduplicatedetection
RequiredLevel None
Type Boolean

EnableDuplicateDetection Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

EntityKeyId

Property Value
Description Unique identifier of the Alternate key Id
DisplayName Entity Key ID
IsValidForForm False
IsValidForRead True
LogicalName entitykeyid
RequiredLevel None
Type Uniqueidentifier

FieldDelimiterCode

Property Value
Description Select the character that is used to separate each field in the import file. Typically, it is a comma.
DisplayName Field Delimiter
IsValidForForm True
IsValidForRead True
LogicalName fielddelimitercode
RequiredLevel SystemRequired
Type Picklist

FieldDelimiterCode Choices/Options

Value Label Description
1 Colon
2 Comma
3 Tab
4 Semicolon

FileTypeCode

Property Value
Description Shows the type of source file that is uploaded for import.
DisplayName File Type
IsValidForForm True
IsValidForRead True
LogicalName filetypecode
RequiredLevel SystemRequired
Type Picklist

FileTypeCode Choices/Options

Value Label Description
0 CSV
1 XML Spreadsheet 2003
2 Attachment
3 XLSX

ImportFileId

Property Value
Description Unique identifier of the import file.
DisplayName Import
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importfileid
RequiredLevel SystemRequired
Type Uniqueidentifier

ImportId

Property Value
Description Choose the import job that the file was uploaded for.
DisplayName Import Job ID
IsValidForForm True
IsValidForRead True
LogicalName importid
RequiredLevel SystemRequired
Targets import
Type Lookup

ImportMapId

Property Value
Description 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.
DisplayName Data Map
IsValidForForm True
IsValidForRead True
LogicalName importmapid
RequiredLevel None
Targets importmap
Type Lookup

IsFirstRowHeader

Property Value
Description Select whether the first row of the import file contains column headings, which are used for data mapping during the import job.
DisplayName Is First Row Header
IsValidForForm True
IsValidForRead True
LogicalName isfirstrowheader
RequiredLevel SystemRequired
Type Boolean

IsFirstRowHeader Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

Name

Property Value
Description Shows the name of the import file. This name is based on the name of the uploaded file.
DisplayName Import Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 256
RequiredLevel None
Type String

OwnerId

Property Value
Description 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.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ProcessCode

Property Value
Description Tells whether the import file should be ignored or processed during the import.
DisplayName Process Code
IsValidForForm True
IsValidForRead True
LogicalName processcode
RequiredLevel SystemRequired
Type Picklist

ProcessCode Choices/Options

Value Label Description
1 Process
2 Ignore
3 Internal

RecordsOwnerId

Property Value
Description Choose the user that the records created during the import job should be assigned to.
DisplayName Records Owner
IsValidForForm True
IsValidForRead True
LogicalName recordsownerid
RequiredLevel None
Targets systemuser,team
Type Lookup

RecordsOwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName recordsowneridtype
RequiredLevel SystemRequired
Type EntityName

RelatedEntityColumns

Property Value
Description Shows the columns that are mapped to a related record type (entity) of the primary record type (entity) included in the import file.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName relatedentitycolumns
MaxLength 1073741823
RequiredLevel None
Type String

Size

Property Value
Description Shows the size of the import file, in kilobytes.
DisplayName Size
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName size
MaxLength 160
RequiredLevel None
Type String

Source

Property Value
Description Shows the name of the data source file uploaded in the import job.
DisplayName Source
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName source
MaxLength 256
RequiredLevel None
Type String

SourceEntityName

Property Value
Description Shows the record type (entity) of the source data.
DisplayName Source Entity
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName sourceentityname
MaxLength 160
RequiredLevel None
Type String

StateCode

Property Value
Description Shows the status of the import file record. By default, all records are active and can't be deactivated.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 0 Active

StatusCode

Property Value
Description 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.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Choices/Options

Value Label State
0 Submitted 0
1 Parsing 0
2 Transforming 0
3 Importing 0
4 Completed 0
5 Failed 0

TargetEntityName

Property Value
Description Select the target record type (entity) for the records that will be created during the import job.
DisplayName Target Entity
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName targetentityname
MaxLength 160
RequiredLevel None
Type String

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UpsertModeCode

Property Value
Description Select the value which is used for identify the upsert mode. By Default, it is a Create.
DisplayName Upsert Mode
IsValidForForm True
IsValidForRead True
LogicalName upsertmodecode
RequiredLevel None
Type Picklist

UpsertModeCode Choices/Options

Value Label Description
0 Create
1 Update
2 Ignore

UseSystemMap

Property Value
Description 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.
DisplayName Use System Map
IsValidForForm True
IsValidForRead True
LogicalName usesystemmap
RequiredLevel SystemRequired
Type Boolean

UseSystemMap Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

AdditionalHeaderRow

Property Value
Description Shows the secondary column headers. The additional headers are used during the process of transforming the import file into import data records.
DisplayName Additional Header
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName additionalheaderrow
MaxLength 100000
RequiredLevel None
Type String

CompletedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the import associated with the import file was completed.
DisplayName Completed On
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName completedon
RequiredLevel None
Type DateTime

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description 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.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

FailureCount

Property Value
Description Shows the number of records in the import file that cannot be imported.
DisplayName Errors
Format None
IsValidForForm True
IsValidForRead True
LogicalName failurecount
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

HeaderRow

Property Value
Description 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.
DisplayName Header
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName headerrow
MaxLength 1073741823
RequiredLevel None
Type String

ImportIdName

Property Value
Description Name of the import.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName importidname
MaxLength 100
RequiredLevel SystemRequired
Type String

ImportMapIdName

Property Value
Description Name of the import map.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName importmapidname
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description 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.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel SystemRequired
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OwnerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Shows the business unit that the record owner belongs to.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier of the team who owns the import file.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the import file.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ParsedTableColumnPrefix

Property Value
Description Shows the prefix applied to each column after the import file is parsed.
DisplayName Parse Table Column Prefix
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parsedtablecolumnprefix
MaxLength 160
RequiredLevel None
Type String

ParsedTableColumnsNumber

Property Value
Description Shows the number of columns included in the parsed import file.
DisplayName Parse Table Column Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName parsedtablecolumnsnumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

ParsedTableName

Property Value
Description Shows the name of the table that contains the parsed data from the import file.
DisplayName Parse Table
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parsedtablename
MaxLength 160
RequiredLevel None
Type String

PartialFailureCount

Property Value
Description Shows the number of records in this file that had failures during the import.
DisplayName Partial Failures
Format None
IsValidForForm True
IsValidForRead True
LogicalName partialfailurecount
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

ProcessingStatus

Property Value
Description Shows the import file's processing status code. This indicates whether the data in the import file has been parsed, transformed, or imported.
DisplayName Processing Status
IsValidForForm False
IsValidForRead True
LogicalName processingstatus
RequiredLevel SystemRequired
Type Picklist

ProcessingStatus Choices/Options

Value Label Description
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

Property Value
Description Shows the progress code for the processing of the import file. This field is used when a paused import job is resumed.
DisplayName Progress Counter
Format None
IsValidForForm False
IsValidForRead True
LogicalName progresscounter
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

RecordsOwnerIdName

Property Value
Description Name of the record owner.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName recordsowneridname
MaxLength 160
RequiredLevel None
Type String

SuccessCount

Property Value
Description Shows the number of records in the import file that are imported successfully.
DisplayName Successes
Format None
IsValidForForm True
IsValidForRead True
LogicalName successcount
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

TotalCount

Property Value
Description Shows the total number of records in the import file.
DisplayName Total Processed
Format None
IsValidForForm True
IsValidForRead True
LogicalName totalcount
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

One-To-Many Relationships

Listed by SchemaName.

ImportFile_BulkDeleteFailures

Same as the ImportFile_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ImportFile_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ImportLog_ImportFile

Same as the ImportLog_ImportFile many-to-one relationship for the importlog entity.

Property Value
ReferencingEntity importlog
ReferencingAttribute importfileid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ImportLog_ImportFile
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ImportFile_AsyncOperations

Same as the ImportFile_AsyncOperations many-to-one relationship for the asyncoperation entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ImportFile_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_importfilebase_createdby

See the lk_importfilebase_createdby one-to-many relationship for the systemuser entity.

lk_importfilebase_createdonbehalfby

See the lk_importfilebase_createdonbehalfby one-to-many relationship for the systemuser entity.

team_ImportFiles

See the team_ImportFiles one-to-many relationship for the team entity.

ImportFile_Team

See the ImportFile_Team one-to-many relationship for the team entity.

ImportFile_SystemUser

See the ImportFile_SystemUser one-to-many relationship for the systemuser entity.

SystemUser_ImportFiles

See the SystemUser_ImportFiles one-to-many relationship for the systemuser entity.

lk_importfilebase_modifiedonbehalfby

See the lk_importfilebase_modifiedonbehalfby one-to-many relationship for the systemuser entity.

Import_ImportFile

See the Import_ImportFile one-to-many relationship for the import entity.

ImportMap_ImportFile

See the ImportMap_ImportFile one-to-many relationship for the importmap entity.

lk_importfilebase_modifiedby

See the lk_importfilebase_modifiedby one-to-many relationship for the systemuser entity.

BusinessUnit_ImportFiles

See the BusinessUnit_ImportFiles one-to-many relationship for the businessunit entity.

See also

About the Entity Reference
Web API EntityType Reference