importmap EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

Data map used in import.

Entity Set Path
[organization URI]/api/data/v9.2/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
Values 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
Values 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
Values 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
Values 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
Values 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
Values 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
Values 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
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the data map's status.

Display Name: Status Reason

Default Options
Values 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
Values Label
8005 Comment
8000 Post
8006 Like
8003 Follow
50 Position
4619 Plug-in Trace Log
10030 Plugin Package
4603 Plug-in Type Statistic
4602 Plug-in Type
8002 Post Regarding
10161 PowerfxRule
10252 powerbireportapdx
10263 Site
10262 Site Component
10251 Power BI Report
10248 Power BI Dataset
8001 Post Role
10250 Power BI Mashup Parameter
10249 powerbidatasetapdx
4605 Plug-in Assembly
9699 Organization Insights Metric
1021 Organization UI
7 Owner
9690 Organization Insights Notification
4708 Organization Statistic
10170 OrganizationDataSyncSubscriptionEntity
10169 OrganizationDataSyncSubscription
10066 Organization Setting
10171 OrganizationDataSyncSubscriptionFnoTable
4420 Owner Mapping
4418 List Value Mapping
4210 Phone Call
10427 Planner Sync Action
10426 Planner Business Scenario
9941 Personal Document Template
10009 Package History
10008 Package
10137 PDF Setting
1095 Partner Application
4250 Recurrence Rule
72 Record Filter
10198 Recycle Bin Configuration
4251 Recurring Appointment
10184 ReconciliationInfo
1189 Document Suggestions
5000 Recently Used
10183 ReconciliationEntityStepInfo
10182 ReconciliationEntityInfo
9813 Relationship Entity
9101 Report Related Entity
9102 Report Related Category
9103 Report Visibility
9104 Report Link
9100 Report
4500 Relationship Role
9814 Relationship Attribute
1140 Replication Backlog
4501 Relationship Role Map
2024 QueueMemberCount
31 Privilege Object Type Code
1023 Privilege
4710 Process Session
103 Privileges Removal Setting
1404 Principal Sync Attribute Map
10265 Power Pages Site Published
10264 Site Language
44 Field Sharing
61 PrincipalEntityBusinessUnitMap
4724 Process Stage
2020 Queue
2002 Quarterly Fiscal Calendar
2023 QueueItemCount
2029 Queue Item
7102 Publisher Address
4712 Process Trigger
10087 ProcessStageParameter
7101 Publisher
10032 ProvisionLanguageForUser
10005 Solution History Data Source
10004 Solution History
10110 Tour
10211 Timeline Pin
10247 Solution Health Rule Set
10014 Solution Component Summary
10016 Solution Component Data Source
10246 Solution Health Rule Argument
10245 Solution Health Rule
10213 Virtual Table Column Candidate
10278 Column Permission
10277 Ad Placement
10280 Content Snippet
10279 Column Permission Profile
10317 Package Submission Store
10111 BotContent
10136 Workflow Action Status
10316 Catalog Submission Files
10162 Ms Graph Resource To Subscription
10015 Solution Component Count Summary
10232 PM Inferred Task
10231 PM Calendar Version
10234 PM Process Template
10233 PM Process Extended Metadata Version
10230 PM Calendar
10075 OData v4 Data Source
10031 NonRelational Data Source
10229 PM Business Rule Automation Config
10228 PM Analysis History
10235 PM Process User Settings
10140 Service Configuration
10127 Schedule
10017 Solution Component Count Data Source
10141 SLA KPI
10209 Rich Text Attachment
10237 PM Recording
10236 PM Process Version
10239 PM View
10238 PM Template
9910 MultiEntitySearch
10306 Web Template
9900 Navigation Setting
9912 Multi Select Option Value
10305 Website Language
10302 Web Role
10301 Web Page Access Control Rule
10304 Website Access
10303 Website
950 New Process
1019 Organization
9809 OptionSet
10173 OrganizationDataSyncState
10172 OrganizationDataSyncFnoState
9870 Offline Command Definition
4110 Notification
5004 NL2SQ Registration Information
9950 Office Graph Document
4490 Office Document
10300 Web Page
10287 Power Pages Core Entity DS
10286 Poll Placement
10289 Publishing State Transition Rule
10288 Publishing State
10285 Page Template
10282 Basic Form Metadata
10281 Basic Form
10284 Table Permission
10283 List
10290 Redirect
10297 Form Step
10296 Multistep Form Metadata
10299 Web Link Set
10298 Web Link
10295 Multistep Form
10292 Site Marker
10291 Shortcut
10294 Web File
10293 Site Setting
60 SystemUserAuthorizationChangeTracker
8 User
51 System User Manager Map
42 SystemUser BusinessUnit Entity Map
1030 System Form
1400 Sync Attribute Mapping Profile
1401 Sync Attribute Mapping
7000 System Application Metadata
9869 Sync Error
14 System User Principal
92 Team template
1403 Team Sync-Attribute Mapping Profiles
2013 Territory
2010 Email Template
1203 Team Profiles
10060 TdsMetadata
4212 Task
10167 TeamMobileOfflineProfileMembership
9 Team
10049 Synapse Link Schedule
45 Subscription Statistic Offline
37 Subscription Manually Tracked Object
47 Subscription Sync Entry Offline
46 Subscription Statistic Outlook
1072 Subscription Clients
1043 String Map
1075 Status Map
29 Subscription
129 Subject
48 Subscription Sync Entry Outlook
10046 Synapse Link Profile
10045 Synapse Link External Table State
10048 Synapse Link Profile Entity State
10047 Synapse Link Profile Entity
10044 Synapse Database
35 Tracking information for deleted entities
33 Subscription Synchronization Information
10159 SupportUserTable
1190 SuggestionCardTemplate
150 User Settings
52 User Search Facet
9333 Web Resource
10163 Virtual Entity Metadata
10192 User Rating
10168 UserMobileOfflineProfileMembership
2016 User Mapping
1112 User Chart
4230 Saved View
4800 Web Wizard
4702 Workflow Wait Subscription
4706 Process Log
10089 Work Queue Item
10088 Work Queue
4704 Process Dependency
4802 Wizard Page
4803 Web Wizard Access Privilege
10076 Workflow Binary
4703 Process
1031 User Dashboard
8051 Trace Association
4811 Time Zone Rule
8052 Trace Regarding
8050 Trace
4812 Time Zone Localized Name
2015 Theme
9945 Text Analytics Entity Mapping
4810 Time Zone Definition
9932 Time Stamp Date Mapping
9105 Currency
2501 User Entity Instance Data
7001 User Application Metadata
1086 User Fiscal Calendar
2500 User Entity UI Settings
4220 UntrackedEmail
4427 Transformation Parameter Mapping
4426 Transformation Mapping
2012 Unresolved Address
951 Translation Process
1039 View
1309 Saved Organization Insights Configuration
4606 Sdk Message
1111 System Chart
7200 RuntimeDependency
9510 Rollup Properties
9511 Rollup Job
8199 Rule Item
8181 Routing Rule Set
4607 Sdk Message Filter
4610 Sdk Message Response
4614 Sdk Message Request Field
10256 SearchAttributeSettings
4611 Sdk Message Response Field
4609 Sdk Message Request
4608 Sdk Message Processing Step
4613 Sdk Message Pair
4616 Sdk Message Processing Step Secure Configuration
4615 Sdk Message Processing Step Image
9604 Rollup Field
10190 RetentionOperationDetail
10189 RetentionOperation
4579 Ribbon Client Metadata.
10059 RevokeInheritedAccessRecordsTracker
10188 RetentionFailureDetail
10185 RetentionCleanupInfo
10043 RetainedData Excel
10187 RetentionConfig
10186 RetentionCleanupOperation
1116 Ribbon Command
1036 Security Role
1113 Ribbon Tab To Command Mapping
1037 Role Template
10196 RoleEditorLayout
1117 Ribbon Rule
1120 Application Ribbons
1115 Ribbon Context Group
9880 Ribbon Metadata To Process
1130 Ribbon Difference
99 Social Profile
1300 SocialInsightsConfiguration
7103 Solution Component
7100 Solution
4216 Social Activity
9750 SLA
4709 Site Map
9752 SLA KPI Instance
9751 SLA Item
10000 Solution Component Attribute Configuration
10020 Staged Entity Attribute
10019 Staged Entity
10011 StageSolutionUpload
10021 Staged Metadata Async Operation
9890 SolutionHistoryData
10002 Solution Component Configuration
10001 Solution Component Batch Configuration
10003 Solution Component Relationship Configuration
7104 Solution Component Definition
9951 Similarity Rule
101 Service Plan
4618 Service Endpoint
10069 Service Plan Mapping
10070 Service Plan Custom Control
2001 Semiannual Fiscal Calendar
10258 SearchRelationshipSettings
10257 SearchCustomAnalyzer
10260 Search Telemetry
10259 SearchResultsCache
10067 Setting Definition
9507 Sharepoint Document
9509 SharePoint Data
9502 SharePoint Site
9508 Document Location
10036 Shared Workspace Pool
10033 Shared Object
10055 Shared Link Setting
10035 Shared Workspace Access Token
10034 Shared Workspace
10135 Module Run Detail
3231 Connection Role
10092 Connection Reference
372 Connector
3233 Connection Role Object Type Code
373 Connection Instance
10051 Component Version Data Source
10050 Component Version
3234 Connection
10052 Component Version (Internal)
2 Contact
10077 Credential
10429 CopilotSynonyms
10028 Custom API Request Parameter
10027 Custom API
10428 CopilotGlossaryTerm
9300 Record Creation and Update Rule
10112 ConversationTranscript
10261 CopilotExampleQuestion
9301 Record Creation and Update Rule Item
9650 Process Configuration
10058 CascadeGrantRevokeAccessVersionTracker
10057 CascadeGrantRevokeAccessRecordsTracker
10025 Catalog Assignment
10024 Catalog
9983 Action Card Type
10068 CanvasApp Extended Metadata
300 Canvas App
10205 Card State Item
10204 Card
9959 Category
36 Client update
10139 Teams chat
10124 Comment
4417 Column Mapping
1234 Channel Property Group
9400 Channel Access Profile Rule
3005 Channel Access Profile
1236 Channel Property
9401 Channel Access Profile Rule Item
4416 Duplicate Rule Condition
4414 Duplicate Detection Rule
10094 DVFileSearchAttribute
10093 DVFileSearch
4415 Duplicate Record
4101 Display String Map
4102 Display String
9940 Document Template
126 Indexed Article
10095 DVFileSearchEntity
4299 Email Search
4023 Email Hash
9997 Email Signature
9605 Email Server Profile
4202 Email
10097 DVTableSearchAttribute
10096 DVTableSearch
7755 ElasticFileAttachment
10098 DVTableSearchEntity
10078 Desktop Flow Module
10037 Data Lake Folder
4502 Customer Relationship
10039 Data Lake Workspace
10038 Data Lake Folder Permission
1071 Address
9753 Custom Control
10029 Custom API Response Property
9754 Custom Control Resource
9755 Custom Control Default Config
10040 Data Lake Workspace Permission
7108 Dependency Feature
7105 Dependency
10090 Desktop Flow Binary
7106 Dependency Node
9961 DelveActionHub
10041 Data Processing configuration
4450 Data Performance Dashboard
10197 Deleted Item Reference
10056 DelegatedAuthorization
5 Note
10107 AIPluginUserSetting
10199 App Action
2000 Annual Fiscal Calendar
10100 AIPluginTitle
10104 AIPluginInstance
10103 AIPluginExternalSchemaProperty
10106 AIPluginOperationParameter
10105 AIPluginOperation
10200 App Action Migration
10072 ApplicationUser
4707 Application File
9007 App Module Component
9006 Model-driven App
10061 Model-Driven App Element
9012 App Configuration
10201 App Action Rule
9011 App Config Master
9013 App Configuration Instance
10102 AIPluginExternalSchema
10138 Activity File Attachment
9968 ActionCardUserState
135 Activity Party
1001 Attachment
9973 Action Card User Settings
1 Account
10018 Microsoft Entra ID
9962 Action Card
8040 ACIViewMapper
4200 Activity
10273 Multistep Form Session
10272 Setting
10101 AIPlugin
10099 AICopilot
10271 Portal Comment
10268 External Identity
9949 Advanced Similarity Rule
10270 Invite Redemption
10269 Invitation
10177 BulkArchiveFailureDetail
10176 BulkArchiveConfig
10179 BulkArchiveOperationDetail
10178 BulkArchiveOperation
10115 Chatbot content pack
10164 Background Operation
9936 Azure Service Connection
10114 Chatbot subcomponent
10113 Chatbot
4425 Bulk Delete Failure
4003 Calendar
132 Announcement
301 Callback Registration
4004 Calendar Rule
6 Business Unit Map
4232 Business Data Localized Label
4424 Bulk Delete Operation
10 Business Unit
4725 Business Process Flow Instance
1094 Authorization Server
10191 Notification
9009 App Module Roles
10064 Model-Driven App Setting
4201 Appointment
8702 AppModule Metadata Async Operation
10063 Model-Driven App Component Node
10062 Model-Driven App Component Node's Edge
8701 AppModule Metadata Dependency
8700 AppModule Metadata
10065 Model-Driven App User Setting
4601 Attribute Map
431 Image Attribute Configuration
4567 Auditing
9820 Attribute Masking Rule
9808 Attribute
10175 ArchiveCleanupOperation
10174 ArchiveCleanupInfo
1002 Attachment
4700 System Job
402 AI Configuration
10227 AI Builder File Attached Data
10216 AI Form Processing Document
10214 AI Event
10226 AI Builder File
10224 AI Builder Dataset Record
10223 AI Builder Dataset File
10215 AI Builder Feedback Loop
10225 AI Builder Datasets Container
401 AI Model
10241 Analysis Job
10240 Analysis Component
10243 Analysis Result
10242 Analysis Override
400 AI Template
10218 AI Object Detection Label
10217 AI Object Detection Image
10220 AI Object Detection Image Mapping
10219 AI Object Detection Bounding Box
10222 AI Builder Dataset
10255 MakerFewShot
10254 MainFewShot
9812 Managed Property
10023 Managed Identity
9106 Mail Merge Template
9607 Mailbox Statistics
9606 Mailbox
9608 Mailbox Auto Tracking Folder
9609 Mailbox Tracking Category
74 Secured Masking Rule
9868 Mobile Offline Profile Item Association
9867 Mobile Offline Profile Item
2003 Monthly Fiscal Calendar
10166 MobileOfflineProfileItemFilter
10165 MobileOfflineProfileExtension
10181 MetadataForArchival
4231 Metadata Difference
9866 Mobile Offline Profile
9603 Goal Metric
10153 Knowledge Article Attachment
10152 Knowledge article language setting
10154 Knowledge personalization
10146 Search provider
10142 Integrated search provider
10253 File Upload
10145 Knowledge Federated Article Incident
10195 Insights Store Virtual Entity
10109 Help Page
10147 Knowledge Article Image
10157 Knowledge search filter
10156 Knowledge search personal filter config
10193 Mobile App
10150 Knowledge Search Insight
10143 Knowledge Management Setting
10134 Knowledge Asset Configuration
10155 Knowledge Article Template
10149 Knowledge Interaction Insight
10148 Knowledge Configuration
10144 Knowledge Federated Article
418 Dataflow
10210 Custom Control Extended Setting
10126 Dataflow Connection Reference
10129 Dataflow DatalakeFolder
10212 Virtual Connector Data Source
10125 App Insights Metadata
10244 Analysis Result Detail
10007 Component Layer Data Source
10006 Component Layer
10053 DataflowRefreshHistory
10208 Entity link chat configuration
10133 DMS Sync Status
10151 Favorite knowledge article
10054 EntityRefreshHistory
10132 DMS Sync Request
10194 Insights Store Data Source
10128 Dataflow Template
10131 Data Movement Service Request Status
10130 Data Movement Service Request
55 FileAttachment
1200 Field Security Profile
2004 Fixed Monthly Fiscal Calendar
30 Filter Template
1201 Field Permission
4204 Fax
9987 External Party Item
9958 Feedback
10013 FeatureControlSetting
10079 Flow Capacity Assignment
10085 Flow Machine Image Version
10084 Flow Machine Image
10091 Flow Run
10086 Flow Machine Network
10083 Flow Machine Group
10081 Flow Event
10080 Flow Credential Application
10082 Flow Machine
10425 Flow Log
3008 External Party
9815 Entity Index
432 Entity Image Configuration
4600 Entity Map
9810 Entity Key
85 Virtual Entity Data Source
9800 Entity
10180 EnableArchivalRequest
78 Virtual Entity Data Provider
430 Entity Analytics Config
73 EntityRecordFilter
955 Expired Process
4711 Expander Event
10012 ExportSolutionUpload
10042 Exported Excel
4120 Exchange Sync Id Mapping
380 Environment Variable Definition
9811 Entity Relationship
18085 Event Expander Breadcrumb
381 Environment Variable Value
1016 Article Template
1082 Article Comment
9953 Knowledge Article
10022 Key Vault Reference
127 Article
4011 Inter Process Lock
10026 Internal Catalog Assignment
4705 ISV Config
7107 Invalid Dependency
9960 Knowledge Article Category
2027 License
4207 Letter
4419 Lookup Mapping
9201 LocalConfigStore
9875 Language Provisioning State
9930 Knowledge Base Record
9955 Knowledge Article Views
9957 Language
9947 Knowledge Search Model
1003 Internal Address
9919 Hierarchy Security Configuration
8840 Hierarchy Rule
1007 Image Descriptor
9996 HolidayWrapper
9602 Rollup Query
10160 FxExpression
4720 Flow Session
9600 Goal
54 Global Search Configuration
4410 Data Import
9816 Index Attribute
4411 Data Map
9986 Interaction for Email
3000 Integration Status
4423 Import Log
4428 Import Entity Mapping
4413 Import Data
9107 Import Job
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 Lookup property data.

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 Bound to Entity
GrantAccess Not Bound
ImportMappingsImportMap Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

See also