Share via


import EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Status and ownership information for an import job.

Entity Set path:[organization URI]/api/data/v8.2/imports

Base Type: crmbaseentity EntityType

Display Name: Data Import

Primary Key: importid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to import

Operations using the import entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the import was initiated.

Display Name: Created On

Read-only property

emailaddress

Edm.String

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

Display Name: Email

importid

Edm.Guid

Description: Unique identifier of the import job.

Display Name: Import

modecode

Edm.Int32

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

Default Options:

0 : Create
1 : Update

Display Name: Mode

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 365 options.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Shows the name of the import job, based on the import file and the entity being imported.

Display Name: Import Name

sendnotification

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Send Notification

sequence

Edm.Int32

Description: Order in which the import was created.

Display Name: Sequence

Read-only property

statecode

Edm.Int32

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

Default Options:

0 : Active

Display Name: Status

Read-only property

statuscode

Edm.Int32

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.

Default Options:

0 : Submitted
1 : Parsing
2 : Transforming
3 : Importing
4 : Completed
5 : Failed

Display Name: Status Reason

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 EntityType

lk_importbase_createdby

createdonbehalfby

systemuser EntityType

lk_import_createdonbehalfby

modifiedby

systemuser EntityType

lk_importbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_import_modifiedonbehalfby

ownerid

principal EntityType

owner_imports

owningbusinessunit

businessunit EntityType

BusinessUnit_Imports

owningteam

team EntityType

team_Imports

owninguser

systemuser EntityType

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 EntityType

regardingobjectid_import

Import_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_import

Import_ImportFile

importfile EntityType

importid

Operations bound to import

The following operations are bound to the import entity type.

Name

Bound to

ImportRecordsImport Action

Entity

ParseImport Action

Entity

Operations using the import entity type.

The following operations use the import entity type in a parameter or return type.

Name

How used

Description

ImportRecordsImport Action

entity Parameter

Submits an asynchronous job that uploads the transformed data into Microsoft Dynamics 365.

ParseImport Action

entity Parameter

Submits an asynchronous job that parses all import files that are associated with the specified import (data import).

See Also

Use the Microsoft Dynamics 365 Web API
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 365

© 2016 Microsoft. All rights reserved. Copyright