importfile EntityType
Description: File name of file used for import.
Entity Set path: [organization URI]/api/data/v8.0/importfiles
Base Type: crmbaseentity EntityType
Display Name: Import Source File
Primary Key: importfileid
Primary Name Attribute: name
Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to importfile
Operations using the importfile entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are not writable.
| Name | Type | Details |
|---|---|---|
_createdby_value |
Edm.Guid |
Description: Shows who created the record. Computed property Read-only property |
_createdonbehalfby_value |
Edm.Guid |
Description: Shows who created the record on behalf of another user. Computed property Read-only property |
_importid_value |
Edm.Guid |
Description: Choose the import job that the file was uploaded for. Computed property Read-only property |
_importmapid_value |
Edm.Guid |
Description: Choose a data map to match the import file and its column headers with the record types and fields in Microsoft Dynamics CRM. If the column headers in the file match the display names of the target fields in Microsoft Dynamics CRM, we import the data automatically. If not, you can manually define matches during import. Computed property Read-only property |
_modifiedby_value |
Edm.Guid |
Description: Shows who last updated the record. Computed property Read-only property |
_modifiedonbehalfby_value |
Edm.Guid |
Description: Shows who created the record on behalf of another user. Computed property Read-only property |
_ownerid_value |
Edm.Guid |
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. |
_owningbusinessunit_value |
Edm.Guid |
Description: Shows the business unit that the record owner belongs to. Computed property Read-only property |
_owningteam_value |
Edm.Guid |
Description: Unique identifier of the team who owns the import file. Computed property Read-only property |
_owninguser_value |
Edm.Guid |
Description: Unique identifier of the user who owns the import file. Computed property Read-only property |
_recordsownerid_value |
Edm.Guid |
Description: Choose the user that the records created during the import job should be assigned to. Computed property Read-only property |
additionalheaderrow |
Edm.String |
Description: 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 property |
completedon |
Edm.DateTimeOffset |
Description: Shows the date and time when the import associated with the import file was completed. Display Name: Completed On Read-only property |
content |
Edm.String |
Description: Stores the content of the import file, stored as comma-separated values. |
createdon |
Edm.DateTimeOffset |
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 CRM options. Display Name: Created On Read-only property |
datadelimitercode |
Edm.Int32 |
Description: Select the single-character data delimiter used in the import file. This is typically a single or double quotation mark. Default Options: 1 : DoubleQuote Display Name: Data Delimiter |
enableduplicatedetection |
Edm.Boolean |
Description: Select whether duplicate-detection rules should be run against the import job. Default Options: 1 : Yes Display Name: Enable Duplicate Detection |
failurecount |
Edm.Int32 |
Description: Shows the number of records in the import file that cannot be imported. Display Name: Errors Read-only property |
fielddelimitercode |
Edm.Int32 |
Description: Select the character that is used to separate each field in the import file. Typically, it is a comma. Default Options: 1 : Colon Display Name: Field Delimiter |
filetypecode |
Edm.Int32 |
Description: Shows the type of source file that is uploaded for import. Default Options: 0 : CSV Display Name: File Type |
headerrow |
Edm.String |
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. Display Name: Header Read-only property |
importfileid |
Edm.Guid |
Description: Unique identifier of the import file. Display Name: Import |
isfirstrowheader |
Edm.Boolean |
Description: Select whether the first row of the import file contains column headings, which are used for data mapping during the import job. Default Options: 1 : Yes Display Name: Is First Row Header |
modifiedon |
Edm.DateTimeOffset |
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 CRM options. Display Name: Modified On Read-only property |
name |
Edm.String |
Description: 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 |
Description: Shows the prefix applied to each column after the import file is parsed. Display Name: Parse Table Column Prefix Read-only property |
parsedtablecolumnsnumber |
Edm.Int32 |
Description: Shows the number of columns included in the parsed import file. Display Name: Parse Table Column Number Read-only property |
parsedtablename |
Edm.String |
Description: Shows the name of the table that contains the parsed data from the import file. Display Name: Parse Table Read-only property |
partialfailurecount |
Edm.Int32 |
Description: Shows the number of records in this file that had failures during the import. Display Name: Partial Failures Read-only property |
processcode |
Edm.Int32 |
Description: Tells whether the import file should be ignored or processed during the import. Default Options: 1 : Process Display Name: Process Code |
processingstatus |
Edm.Int32 |
Description: Shows the import file's processing status code. This indicates whether the data in the import file has been parsed, transformed, or imported. Default Options: 1 : Not Started Display Name: Processing Status Read-only property |
progresscounter |
Edm.Int32 |
Description: 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 property |
relatedentitycolumns |
Edm.String |
Description: 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 |
Description: Shows the size of the import file, in kilobytes. Display Name: Size |
source |
Edm.String |
Description: Shows the name of the data source file uploaded in the import job. Display Name: Source |
sourceentityname |
Edm.String |
Description: Shows the record type (entity) of the source data. Display Name: Source Entity |
statecode |
Edm.Int32 |
Description: Shows the status of the import file record. By default, all records are active and can't be deactivated. Default Options: 0 : Active Display Name: Status |
statuscode |
Edm.Int32 |
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. Default Options: 0 : Submitted Display Name: Status Reason |
successcount |
Edm.Int32 |
Description: Shows the number of records in the import file that are imported successfully. Display Name: Successes Read-only property |
targetentityname |
Edm.String |
Description: Select the target record type (entity) for the records that will be created during the import job. Display Name: Target Entity |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. |
totalcount |
Edm.Int32 |
Description: Shows the total number of records in the import file. Display Name: Total Processed Read-only property |
usesystemmap |
Edm.Boolean |
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 CRM. Default Options: 1 : Yes Display Name: Use System Map |
utcconversiontimezonecode |
Edm.Int32 |
Description: Time zone code that was in use when the record was created. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced.
| Name | Type | Partner |
|---|---|---|
createdby |
lk_importfilebase_createdby |
|
createdonbehalfby |
lk_importfilebase_createdonbehalfby |
|
importid |
Import_ImportFile |
|
importmapid |
ImportMap_ImportFile |
|
modifiedby |
lk_importfilebase_modifiedby |
|
modifiedonbehalfby |
lk_importfilebase_modifiedonbehalfby |
|
ownerid |
owner_importfiles |
|
owningbusinessunit |
BusinessUnit_ImportFiles |
|
owningteam |
team_ImportFiles |
|
owninguser |
SystemUser_ImportFiles |
|
recordsownerid_systemuser |
ImportFile_SystemUser |
|
recordsownerid_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 |
regardingobjectid_importfile |
|
ImportFile_BulkDeleteFailures |
regardingobjectid_importfile |
|
ImportFile_ImportData |
importfileid |
|
ImportLog_ImportFile |
importfileid |
Operations bound to importfile
The following operations are bound to the importfile entity type.
| Name | Bound to |
|---|---|
Entity |
|
Entity |
Operations using the importfile entity type.
The following operations use the importfile entity type in a parameter or return type.
| Name | How used | Description |
|---|---|---|
entity Parameter |
Retrieves distinct values from the parse table for a column in the source file that contains list values. |
|
entity Parameter |
Retrieves the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings. |
Consulte também
Outros recursos
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.