Data Import (Import) entity reference

Status and ownership information for an import job.

Messages

Message	SDK class or method
Create	CreateRequest or Create
Delete	DeleteRequest or Delete
GrantAccess	GrantAccessRequest
ImportRecordsImport	ImportRecordsImportRequest
ModifyAccess	ModifyAccessRequest
ParseImport	ParseImportRequest
Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccessRequest
TransformImport	TransformImportRequest
Update	UpdateRequest or Update

Properties

Property	Value
CollectionSchemaName	Imports
DisplayCollectionName	Data Imports
DisplayName	Data Import
EntitySetName	imports
IsBPFEntity	False
LogicalCollectionName	imports
LogicalName	import
OwnershipType	UserOwned
PrimaryIdAttribute	importid
PrimaryNameAttribute	name
SchemaName	Import

Writable attributes

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

• EMailAddress
• ImportId
• IsImport
• ModeCode
• Name
• OwnerId
• OwnerIdType
• SendNotification
• StatusCode

EMailAddress

Property	Value
Description	Type the email address that the import completion notification must be sent to.
DisplayName	Email
FormatName	Email
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	emailaddress
MaxLength	100
RequiredLevel	None
Type	String

ImportId

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

IsImport

Property	Value
Description	Information about whether the source of this import job is data import or data migration.
DisplayName	Is Import
IsValidForForm	False
IsValidForRead	True
LogicalName	isimport
RequiredLevel	SystemRequired
Type	Boolean

IsImport Choices/Options

Value	Label	Description
1	Is Import
0	Is Migration

DefaultValue: 0

ModeCode

Property	Value
Description	Select whether to create or update records in Microsoft Dynamics 365 during the import job.
DisplayName	Mode
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	modecode
RequiredLevel	SystemRequired
Type	Picklist

ModeCode Choices/Options

Value	Label	Description
0	Create
1	Update

Name

Property	Value
Description	Shows the name of the import job, based on the import file and the entity being imported.
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 or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

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

SendNotification

Property	Value
Description	Select whether to send a notification email message to a selected user after the import is completed.
DisplayName	Send Notification
IsValidForForm	True
IsValidForRead	True
LogicalName	sendnotification
RequiredLevel	SystemRequired
Type	Boolean

SendNotification Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

StatusCode

Property	Value
Description	Shows the reason code that explains the import job's status to identify the job's stage of the import processes, from transforming the data to completed.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	SystemRequired
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

Read-only attributes

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

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• Sequence
• StateCode

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 import was initiated.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	createdon
RequiredLevel	SystemRequired
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

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	Business unit that owns the import job.
DisplayName	Owning Business Unit
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.
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.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

Sequence

Property	Value
Description	Order in which the import was created.
DisplayName	Sequence
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	sequence
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	SystemRequired
Type	Integer

StateCode

Property	Value
Description	Shows the status of the import job. By default, import jobs are active and can't be deactivated.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

StateCode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Active	0	Active

One-To-Many Relationships

Listed by SchemaName.

• Import_ImportFile
• Import_BulkDeleteFailures
• Import_AsyncOperations

Import_ImportFile

Same as the Import_ImportFile many-to-one relationship for the importfile entity.

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

Import_BulkDeleteFailures

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

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

Import_AsyncOperations

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

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	Import_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_import_modifiedonbehalfby
• team_Imports
• lk_importbase_modifiedby
• BusinessUnit_Imports
• SystemUser_Imports
• lk_import_createdonbehalfby
• lk_importbase_createdby

lk_import_modifiedonbehalfby

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

team_Imports

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

lk_importbase_modifiedby

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

BusinessUnit_Imports

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

SystemUser_Imports

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

lk_import_createdonbehalfby

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

lk_importbase_createdby

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

See also

About the Entity Reference
Web API EntityType Reference