import EntityType

Status and ownership information for an import job.

Entity Set Path
[organization URI]/api/data/v9.0/imports
Base Type
crmbaseentity
Display Name
Data Import
Primary Key
importid
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
createdon Edm.DateTimeOffset

Shows the date and time when the import was initiated.

Display Name: Created On

Read Only
emailaddress Edm.String

Type the email address that the import completion notification must be sent to.

Display Name: Email

importid Edm.Guid

Unique identifier of the import job.

Display Name: Import

modecode Edm.Int32

Select whether to create or update records in Microsoft Dynamics 365 during the import job.

Display Name: Mode

Default Options
Value Label
0 Create
1 Update
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 job, based on the import file and the entity being imported.

Display Name: Import Name

sendnotification Edm.Boolean

Select whether to send a notification email message to a selected user after the import is completed.

Display Name: Send Notification

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

Order in which the import was created.

Display Name: Sequence

Read Only
statecode Edm.Int32

Shows the status of the import job. By default, import jobs are active and can't be deactivated.

Display Name: Status

Read Only
Default Options
Value Label
0 Active
statuscode Edm.Int32

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.

Display Name: Status Reason

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

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.

_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 or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value owningbusinessunit

Business unit that owns the import job.

_owningteam_value owningteam

Unique identifier of the team who owns the import.

_owninguser_value owninguser

Unique identifier of the user who owns the import.

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_importbase_createdby
createdonbehalfby systemuser lk_import_createdonbehalfby
modifiedby systemuser lk_importbase_modifiedby
modifiedonbehalfby systemuser lk_import_modifiedonbehalfby
ownerid principal owner_imports
owningbusinessunit businessunit BusinessUnit_Imports
owningteam team team_Imports
owninguser systemuser SystemUser_Imports

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
Import_AsyncOperations asyncoperation regardingobjectid_import
Import_BulkDeleteFailures bulkdeletefailure regardingobjectid_import
Import_ImportFile importfile importid

Operations

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

Name Binding
GrantAccess Not Bound
ImportRecordsImport Entity
ModifyAccess Not Bound
ParseImport Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
TransformImport Not Bound

Solutions

The following solutions include the import entity type.

Name Description
System Solution Internal CRM System Solution

See also