importfile EntityType
File name of file used for import.
- Entity set path:
- [organization URI]/api/data/v9.2/importfiles
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Import Source File
- Primary key:
- importfileid
- Primary name column:
- 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
|
||||||||||||||||||||||||||
| enableduplicatedetection | Edm.Boolean |
Select whether duplicate-detection rules should be run against the import job. Display name: Enable Duplicate Detection
Default options
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| filetypecode | Edm.Int32 |
Shows the type of source file that is uploaded for import. Display name: File Type
Default options
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||
| 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 Lookup property data.
| 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_systemuser recordsownerid_team |
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 | Bound to Entity |
| GetHeaderColumnsImportFile | Bound to Entity |
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrieveParsedDataImportFile | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |