importmap EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

Data map used in import.

Entity Set Path
[organization URI]/api/data/v9.0/importmaps
Base Type
crmbaseentity
Display Name
Data Map
Primary Key
importmapid
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
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
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
description Edm.String

Type additional information to describe the data map, such as the intended use or data source.

Display Name: Description
entitiesperfile Edm.Int32

Choose whether a data file can contain data for one or more record types.

Display Name: Entities Per File

Default Options
Value Label
1 Single Entity Per File
2 Multiple Entities Per File
importmapid Edm.Guid

Unique identifier of the data map.

Display Name: Data Map
importmapidunique Edm.Guid

Unique identifier of the ImortMap.

Read Only
importmaptype Edm.Int32

Select the type of data map to distinguish out-of-the-box data maps from custom maps.

Display Name: Map Type

Default Options
Value Label
1 Standard
2 Out of Box
3 In Process
introducedversion Edm.String

Version in which the component is introduced.

Display Name: Introduced Version
ismanaged Edm.Boolean

Information that specifies whether this component is managed.

Display Name: State

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
isvalidforimport Edm.Boolean

Information about whether the data map is valid for use with data import.

Display Name: Is Valid For Import

Read Only
Default Options
Value Label
1 Yes
0 No
iswizardcreated Edm.Boolean

Information about whether this data map was created by the Data Migration Manager.

Display Name: Is Wizard-Created

Default Options
Value Label
1 True
0 False
mapcustomizations Edm.String

Customizations XML

Display Name: Map Customizations
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

Type a descriptive name for the data map.

Display Name: Map Name
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
source Edm.String

Type the name of the migration source that this data map is used for.

Display Name: Source
sourcetype Edm.Int32

Select the migration source type that this data map is used for.

Display Name: Source System Type

Default Options
Value Label
1 Map For SalesForce.com Full Data Export
2 Map For SalesForce.com Report Export
3 Map For SalesForce.com Contact and Account Report Export
4 Microsoft Office Outlook 2010 with Business Contact Manager
5 Generic Map for Contact and Account
sourceuseridentifierforsourcecrmuserlink Edm.String

Source user value for source Microsoft Dynamics 365 user link.

Display Name: Source User Value
sourceuseridentifierforsourcedatasourceuserlink Edm.String

Column in the source file that uniquely identifies a user.

Display Name: Source User Identifier
statecode Edm.Int32

Shows whether the data map is active or inactive. Inactive data maps are read-only and can't be edited.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the data map's status.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
targetentity Edm.Int32

Select the name of the Microsoft Dynamics 365 record type that this data map is defined for.

Display Name: Record Type

Read Only
Default Options
Value Label
2002 Quarterly Fiscal Calendar
2020 Queue
2029 Queue Item
7102 Publisher Address
4712 Process Trigger
10024 ProvisionLanguageForUser
7101 Publisher
4251 Recurring Appointment
9813 Relationship Entity
9814 Relationship Attribute
4250 Recurrence Rule
2023 QueueItemCount
2024 QueueMemberCount
1189 Document Suggestions
8001 Post Role
61 PrincipalEntityBusinessUnitMap
44 Field Sharing
8002 Post Regarding
8005 Comment
8003 Follow
8006 Like
4710 Process Session
4724 Process Stage
10060 ProcessStageParameter
103 Privileges Removal Setting
1404 Principal Sync Attribute Map
1023 Privilege
31 Privilege Object Type Code
1037 Role Template
9604 Rollup Field
9511 Rollup Job
1036 Security Role
9880 Ribbon Metadata To Process
1117 Ribbon Rule
1113 Ribbon Tab To Command Mapping
1309 Saved Organization Insights Configuration
1039 View
1111 System Chart
7200 RuntimeDependency
9510 Rollup Properties
8181 Routing Rule Set
8199 Rule Item
9102 Report Related Category
9101 Report Related Entity
9104 Report Link
9100 Report
4500 Relationship Role
4501 Relationship Role Map
1140 Replication Backlog
1115 Ribbon Context Group
1120 Application Ribbons
1130 Ribbon Difference
1116 Ribbon Command
9103 Report Visibility
10043 RevokeInheritedAccessRecordsTracker
4579 Ribbon Client Metadata.
8000 Post
10137 Solution Health Rule Argument
10138 Solution Health Rule Set
10004 Solution History
10136 Solution Health Rule
10014 Solution Component Count Summary
10015 Solution Component Data Source
10013 Solution Component Summary
9912 Multi Select Option Value
9900 Navigation Setting
950 New Process
9910 MultiEntitySearch
10005 Solution History Data Source
10077 Tour
10078 BotContent
10117 NonRelational Data Source
10057 OData v4 Data Source
10128 PM Analysis History
10099 Knowledge Search Insight
10093 Knowledge Management Setting
10104 Knowledge search personal filter config
10105 Knowledge search filter
10091 Service Configuration
10092 SLA KPI
10016 Solution Component Count Data Source
10126 Rich Text Attachment
10129 PM Inferred Task
10130 PM Recording
10131 PM Template
10088 PDF Setting
9941 Personal Document Template
4210 Phone Call
1095 Partner Application
7 Owner
4420 Owner Mapping
10008 Package
4602 Plug-in Type
4603 Plug-in Type Statistic
50 Position
4619 Plug-in Trace Log
4418 List Value Mapping
4605 Plug-in Assembly
10107 Plugin Package
9809 OptionSet
1019 Organization
10116 OrganizationDataSyncState
9870 Offline Command Definition
4110 Notification
4490 Office Document
9950 Office Graph Document
1021 Organization UI
9699 Organization Insights Metric
9690 Organization Insights Notification
4708 Organization Statistic
10114 OrganizationDataSyncSubscription
10115 OrganizationDataSyncSubscriptionEntity
10049 Organization Setting
4606 Sdk Message
2013 Territory
9945 Text Analytics Entity Mapping
2015 Theme
2010 Email Template
1203 Team Profiles
1403 Team Sync-Attribute Mapping Profiles
92 Team template
8051 Trace Association
8050 Trace
8052 Trace Regarding
4811 Time Zone Rule
9932 Time Stamp Date Mapping
4810 Time Zone Definition
4812 Time Zone Localized Name
7000 System Application Metadata
1030 System Form
8 User
9869 Sync Error
10037 Synapse Link Schedule
1401 Sync Attribute Mapping
1400 Sync Attribute Mapping Profile
4212 Task
9 Team
10112 TeamMobileOfflineProfileMembership
14 System User Principal
60 SystemUserAuthorizationChangeTracker
42 SystemUser BusinessUnit Entity Map
51 System User Manager Map
9333 Web Resource
4800 Web Wizard
4803 Web Wizard Access Privilege
10110 Virtual Entity Metadata
1112 User Chart
52 User Search Facet
150 User Settings
4706 Process Log
4702 Workflow Wait Subscription
10272 User Rating
4704 Process Dependency
4802 Wizard Page
4703 Process
10061 Workflow Binary
2012 Unresolved Address
4220 UntrackedEmail
7001 User Application Metadata
951 Translation Process
9105 Currency
4426 Transformation Mapping
4427 Transformation Parameter Mapping
2016 User Mapping
10113 UserMobileOfflineProfileMembership
4230 Saved View
1031 User Dashboard
2501 User Entity Instance Data
2500 User Entity UI Settings
1086 User Fiscal Calendar
10036 Synapse Link Profile Entity State
9509 SharePoint Data
9507 Sharepoint Document
9508 Document Location
10026 Shared Workspace
10050 Setting Definition
10040 Shared Link Setting
10025 Shared Object
9751 SLA Item
9752 SLA KPI Instance
4216 Social Activity
9750 SLA
9502 SharePoint Site
9951 Similarity Rule
4709 Site Map
4616 Sdk Message Processing Step Secure Configuration
4609 Sdk Message Request
4614 Sdk Message Request Field
4615 Sdk Message Processing Step Image
4607 Sdk Message Filter
4613 Sdk Message Pair
4608 Sdk Message Processing Step
4618 Service Endpoint
101 Service Plan
10052 Service Plan Mapping
2001 Semiannual Fiscal Calendar
4610 Sdk Message Response
4611 Sdk Message Response Field
10127 Search Telemetry
46 Subscription Statistic Outlook
47 Subscription Sync Entry Offline
48 Subscription Sync Entry Outlook
45 Subscription Statistic Offline
29 Subscription
1072 Subscription Clients
37 Subscription Manually Tracked Object
10033 Synapse Link External Table State
10034 Synapse Link Profile
10035 Synapse Link Profile Entity
10032 Synapse Database
33 Subscription Synchronization Information
35 Tracking information for deleted entities
1190 SuggestionCardTemplate
10000 Solution Component Attribute Configuration
10001 Solution Component Batch Configuration
10002 Solution Component Configuration
7103 Solution Component
1300 SocialInsightsConfiguration
99 Social Profile
7100 Solution
1075 Status Map
1043 String Map
129 Subject
10010 StageSolutionUpload
7104 Solution Component Definition
10003 Solution Component Relationship Configuration
9890 SolutionHistoryData
10098 Knowledge Interaction Insight
3233 Connection Role Object Type Code
372 Connector
2 Contact
3231 Connection Role
9650 Process Configuration
3234 Connection
10062 Connection Reference
10022 Custom API Request Parameter
10023 Custom API Response Property
9753 Custom Control
10021 Custom API
10079 ConversationTranscript
9300 Record Creation and Update Rule
9301 Record Creation and Update Rule Item
9959 Category
3005 Channel Access Profile
9400 Channel Access Profile Rule
10019 Catalog Assignment
10041 CascadeGrantRevokeAccessRecordsTracker
10042 CascadeGrantRevokeAccessVersionTracker
10018 Catalog
36 Client update
4417 Column Mapping
10087 Comment
10090 Teams chat
9401 Channel Access Profile Rule Item
1236 Channel Property
1234 Channel Property Group
4415 Duplicate Record
4414 Duplicate Detection Rule
4416 Duplicate Rule Condition
9940 Document Template
4102 Display String
4101 Display String Map
126 Indexed Article
9997 Email Signature
9800 Entity
430 Entity Analytics Config
9605 Email Server Profile
4202 Email
4023 Email Hash
4299 Email Search
10027 Data Lake Folder
10028 Data Lake Folder Permission
10029 Data Lake Workspace
4502 Customer Relationship
9755 Custom Control Default Config
9754 Custom Control Resource
1071 Address
7105 Dependency
7108 Dependency Feature
7106 Dependency Node
9961 DelveActionHub
10030 Data Lake Workspace Permission
4450 Data Performance Dashboard
10031 Data Processing configuration
9983 Action Card Type
9011 App Config Master
10044 Model-Driven App Element
4707 Application File
9013 App Configuration Instance
10122 App Action Migration
10123 App Action Rule
9012 App Configuration
10046 Model-Driven App Component Node
8700 AppModule Metadata
8701 AppModule Metadata Dependency
10045 Model-Driven App Component Node's Edge
10054 ApplicationUser
9006 Model-driven App
9007 App Module Component
9973 Action Card User Settings
9968 ActionCardUserState
10089 Activity File Attachment
9962 Action Card
10017 AAD User
1 Account
8040 ACIViewMapper
5 Note
2000 Annual Fiscal Calendar
10121 App Action
9949 Advanced Similarity Rule
1001 Attachment
135 Activity Party
4200 Activity
4232 Business Data Localized Label
4725 Business Process Flow Instance
10 Business Unit
4424 Bulk Delete Operation
10080 Chatbot
10081 Chatbot subcomponent
4425 Bulk Delete Failure
301 Callback Registration
300 Canvas App
10051 CanvasApp Extended Metadata
4004 Calendar Rule
6 Business Unit Map
132 Announcement
4003 Calendar
10047 Model-Driven App Setting
10048 Model-Driven App User Setting
4700 System Job
4201 Appointment
8702 AppModule Metadata Async Operation
9009 App Module Roles
10118 Notification
4567 Auditing
1094 Authorization Server
9936 Azure Service Connection
4601 Attribute Map
1002 Attachment
9808 Attribute
431 Image Attribute Configuration
78 Virtual Entity Data Provider
9868 Mobile Offline Profile Item Association
10111 MobileOfflineProfileItemFilter
2003 Monthly Fiscal Calendar
9867 Mobile Offline Profile Item
4231 Metadata Difference
9603 Goal Metric
9866 Mobile Offline Profile
10063 AI Builder Feedback Loop
10074 AI Builder File
10075 AI Builder File Attached Data
10073 AI Builder Datasets Container
10070 AI Builder Dataset
10071 AI Builder Dataset File
10072 AI Builder Dataset Record
2027 License
9201 LocalConfigStore
4419 Lookup Mapping
4207 Letter
9947 Knowledge Search Model
9957 Language
9875 Language Provisioning State
9106 Mail Merge Template
10109 Managed Identity
9812 Managed Property
9608 Mailbox Auto Tracking Folder
9606 Mailbox
9607 Mailbox Statistics
9609 Mailbox Tracking Category
10094 Knowledge Federated Article
10095 Knowledge Federated Article Incident
10076 Help Page
10039 EntityRefreshHistory
418 Dataflow
10038 DataflowRefreshHistory
10119 Insights Store Data Source
10102 Knowledge personalization
10097 Knowledge Article Image
10103 Knowledge Article Template
10096 Search provider
10120 Insights Store Virtual Entity
10100 Knowledge article language setting
10101 Knowledge Article Attachment
10066 AI Object Detection Label
10067 AI Object Detection Bounding Box
10068 AI Object Detection Image Mapping
10065 AI Object Detection Image
402 AI Configuration
10064 AI Form Processing Document
401 AI Model
10135 Analysis Result Detail
10006 Component Layer
10007 Component Layer Data Source
10134 Analysis Result
400 AI Template
10132 Analysis Component
10133 Analysis Job
9930 Knowledge Base Record
1200 Field Security Profile
55 FileAttachment
30 Filter Template
1201 Field Permission
4204 Fax
10012 FeatureControlSetting
9958 Feedback
10220 Flow Machine Image Version
4720 Flow Session
54 Global Search Configuration
10219 Flow Machine Image
2004 Fixed Monthly Fiscal Calendar
10058 Flow Machine
10059 Flow Machine Group
4600 Entity Map
9811 Entity Relationship
380 Environment Variable Definition
9810 Entity Key
85 Virtual Entity Data Source
432 Entity Image Configuration
9815 Entity Index
10011 ExportSolutionUpload
3008 External Party
9987 External Party Item
955 Expired Process
381 Environment Variable Value
4120 Exchange Sync Id Mapping
4711 Expander Event
4011 Inter Process Lock
7107 Invalid Dependency
4705 ISV Config
10020 Internal Catalog Assignment
3000 Integration Status
9986 Interaction for Email
1003 Internal Address
9953 Knowledge Article
9960 Knowledge Article Category
9955 Knowledge Article Views
10108 Key Vault Reference
127 Article
1082 Article Comment
1016 Article Template
9996 HolidayWrapper
1007 Image Descriptor
4410 Data Import
9919 Hierarchy Security Configuration
9600 Goal
9602 Rollup Query
8840 Hierarchy Rule
4423 Import Log
4411 Data Map
9816 Index Attribute
9107 Import Job
4413 Import Data
4428 Import Entity Mapping
4412 Import Source File
targetuseridentifierforsourcecrmuserlink Edm.String

Microsoft Dynamics 365 user.

Display Name: Target User Value

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 last updated 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 data map.
_owningteam_value owningteam

Unique identifier of the team who owns the data map.
_owninguser_value owninguser

Unique identifier of the user who owns the data map.

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_importmapbase_createdby
createdonbehalfby systemuser lk_importmap_createdonbehalfby
modifiedby systemuser lk_importmapbase_modifiedby
modifiedonbehalfby systemuser lk_importmap_modifiedonbehalfby
ownerid principal owner_importmaps
owningbusinessunit businessunit BusinessUnit_ImportMaps
owningteam team team_ImportMaps
owninguser systemuser SystemUser_ImportMaps

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
ColumnMapping_ImportMap columnmapping importmapid
ImportEntityMapping_ImportMap importentitymapping importmapid
ImportMap_AsyncOperations asyncoperation regardingobjectid_importmap
ImportMap_BulkDeleteFailures bulkdeletefailure regardingobjectid_importmap
ImportMap_ImportFile importfile importmapid
ImportMap_SyncErrors syncerror regardingobjectid_importmap_syncerror
OwnerMapping_ImportMap ownermapping importmapid
TransformationMapping_ImportMap transformationmapping importmapid

Operations

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

Name Binding
ExportMappingsImportMap Entity
GrantAccess Not Bound
ImportMappingsImportMap Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the importmap entity type.

Name Description
System Solution Internal CRM System Solution

See also