importmap EntityType

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
4490 Office Document
4110 Notification
9870 Offline Command Definition
9950 Office Graph Document
950 New Process
9910 MultiEntitySearch
10185 Work Order Type
9900 Navigation Setting
9912 Multi Select Option Value
1019 Organization
4209 Order Close
1021 Organization UI
4708 Organization Statistic
953 Opportunity Sales Process
4208 Opportunity Close
3 Opportunity
1083 Opportunity Line
25 OpportunityCompetitors
10005 Filter
10004 Wall View
10030 Work template
10175 Warehouse
10102 User Work History
10029 Transaction Origin
10100 Transaction Connection
10174 Unique Number
10101 Transaction Type
10182 Work Order Service
10181 Resource Restriction (Deprecated)
10184 Work Order Sub-Status
10183 Work Order Service Task
10180 Work Order Product
10177 Work Order Characteristic (Deprecated)
10176 Work Order
10179 Work Order Incident
10178 Work Order Details Generation Queue (Deprecated)
31 Privilege Object Type Code
1023 Privilege
4724 Process Stage
4710 Process Session
1404 Principal Sync Attribute Map
8001 Post Role
8002 Post Regarding
44 Field Sharing
1022 Price List
7101 Publisher
1028 Product Relationship
2002 Quarterly Fiscal Calendar
7102 Publisher Address
21 ProductSalesLiterature
1024 Product
4712 Process Trigger
1026 Price List Item
1025 Product Association
4210 Phone Call
9941 Personal Document Template
4418 List Value Mapping
952 Phone To Case Process
1095 Partner Application
9690 Organization Insights Notification
9699 Organization Insights Metric
4420 Owner Mapping
7 Owner
8005 Comment
8000 Post
8006 Like
8003 Follow
50 Position
4619 Plug-in Trace Log
4605 Plug-in Assembly
4603 Plug-in Type Statistic
4602 Plug-in Type
10099 Transaction Category Price
10158 Quote Invoicing Product
10157 Quote Booking Setup
10080 Quote Line Analytics Breakdown
10159 Quote Invoicing Setup
10156 Quote Booking Service Task
10153 Quote Booking Incident
10152 Purchase Order Sub Status
10155 Quote Booking Service
10154 Quote Booking Product
10087 Quote Project Price List
10086 Quote Line Transaction Classification
10017 Requirement Organization Unit
10016 Requirement Characteristic
10085 Quote Line Transaction Category
10082 Quote Line Resource Category
10081 Quote Line Invoice Schedule
10084 Quote Line Detail
10083 Quote Line Milestone
10073 Project Price List
10072 Project Parameter Price List
10075 Project Task Dependency
10074 Project Task
10071 Project Parameter
10146 Product Inventory
10068 Process Notes
10070 Project Approval
10069 Project
10149 Purchase Order Product
10148 Purchase Order Bill
10151 Purchase Order Receipt Product
10150 Purchase Order Receipt
10147 Purchase Order
10077 Project Team Member
10076 Project Task Status User
10079 Project Transaction Category
10078 Project Team Member Sign-Up
10170 Ship Via
10169 Service Task Type
10171 Tax Code
10026 System User Scheduler Setting
10025 Scheduling Parameter
10167 RTV Product
10166 RTV
10024 Schedule Board Setting
10168 RTV Sub-Status
10096 Transaction Category
10173 Time Off Request
10098 Transaction Category Hierarchy Element
10097 Transaction Category Classification
10095 Time Off Calendar
10094 Time Entry
10172 Tax Code Detail
10028 Time Group Detail
10027 Time Group
10160 Resource Pay Type
10090 Role Price
10021 Resource Requirement
10091 Resource Request
10089 Resource Assignment Detail (Deprecated)
10019 Requirement Resource Preference
10018 Requirement Resource Category
10088 Resource Assignment
10020 Requirement Status
10165 RMA Sub-Status
10164 RMA Receipt Product
10093 Role Utilization
10092 Role competency requirement
10163 RMA Receipt
10023 Resource Territory
10022 Resource Requirement Detail
10162 RMA Product
10161 RMA
2020 Queue
14 System User Principal
51 System User Manager Map
9 Team
4212 Task
42 SystemUser BusinessUnit Entity Map
7000 System Application Metadata
9869 Sync Error
8 User
1030 System Form
2015 Theme
9945 Text Analytics Entity Mapping
4810 Time Zone Definition
9932 Time Stamp Date Mapping
2013 Territory
1403 Team Sync-Attribute Mapping Profiles
1203 Team Profiles
2010 Email Template
92 Team template
29 Subscription
129 Subject
37 Subscription Manually Tracked Object
1072 Subscription Clients
1043 String Map
7100 Solution
99 Social Profile
1075 Status Map
7103 Solution Component
1190 SuggestionCardTemplate
35 Tracking information for deleted entities
1400 Sync Attribute Mapping Profile
1401 Sync Attribute Mapping
33 Subscription Synchronization Information
46 Subscription Statistic Outlook
45 Subscription Statistic Offline
48 Subscription Sync Entry Outlook
47 Subscription Sync Entry Offline
4230 Saved View
2016 User Mapping
52 User Search Facet
1112 User Chart
1031 User Dashboard
2501 User Entity Instance Data
7001 User Application Metadata
1086 User Fiscal Calendar
2500 User Entity UI Settings
4704 Process Dependency
4703 Process
4702 Workflow Wait Subscription
4706 Process Log
4802 Wizard Page
9333 Web Resource
150 User Settings
4803 Web Wizard Access Privilege
4800 Web Wizard
9943 Topic Model Execution History
9942 Topic Model Configuration
8050 Trace
8051 Trace Association
9944 Topic Model
4811 Time Zone Rule
4812 Time Zone Localized Name
9946 Topic History
9948 Text Analytics Topic
4220 UntrackedEmail
2012 Unresolved Address
1056 Unit Group
1055 Unit
951 Translation Process
9105 Currency
8052 Trace Regarding
4427 Transformation Parameter Mapping
4426 Transformation Mapping
1300 SocialInsightsConfiguration
1116 Ribbon Command
4579 Ribbon Client Metadata.
1120 Application Ribbons
1115 Ribbon Context Group
4006 Resource Specification
4002 Resource
9103 Report Visibility
4010 Resource Expansion
4005 Scheduling Group
9511 Rollup Job
9604 Rollup Field
8181 Routing Rule Set
9510 Rollup Properties
1037 Role Template
1117 Ribbon Rule
1130 Ribbon Difference
1036 Security Role
1113 Ribbon Tab To Command Mapping
1144 Rating Model
1085 Quote Line
1189 Document Suggestions
1142 Rating Value
4211 Quote Close
2023 QueueItemCount
2029 Queue Item
1084 Quote
2024 QueueMemberCount
9102 Report Related Category
9100 Report
9104 Report Link
9101 Report Related Entity
1140 Replication Backlog
4251 Recurring Appointment
4250 Recurrence Rule
4501 Relationship Role Map
4500 Relationship Role
4618 Service Endpoint
20 Service Contract Contact
9507 Sharepoint Document
9509 SharePoint Data
4214 Service Activity
4611 Sdk Message Response Field
4610 Sdk Message Response
4001 Service
2001 Semiannual Fiscal Calendar
9751 SLA Item
9750 SLA
4216 Social Activity
9752 SLA KPI Instance
4709 Site Map
9502 SharePoint Site
9508 Document Location
4009 Site
9951 Similarity Rule
32 Sales Process Instance
1089 Order Line
1039 View
1309 Saved Organization Insights Configuration
1088 Order
7200 RuntimeDependency
8199 Rule Item
1070 Sales Attachment
1038 Sales Literature
4616 Sdk Message Processing Step Secure Configuration
4615 Sdk Message Processing Step Image
4614 Sdk Message Request Field
4609 Sdk Message Request
4608 Sdk Message Processing Step
4606 Sdk Message
1111 System Chart
4613 Sdk Message Pair
4607 Sdk Message Filter
1080 Discount List
1013 Discount
4101 Display String Map
4102 Display String
7106 Dependency Node
9961 DelveActionHub
4450 Data Performance Dashboard
7108 Dependency Feature
7105 Dependency
1235 Property Association
1048 Property
1049 Property Option Set Item
1333 Property Instance
4416 Duplicate Rule Condition
9940 Document Template
126 Indexed Article
4414 Duplicate Detection Rule
4415 Duplicate Record
18 ContactQuotes
19 ContactOrders
1011 Contract Line
1010 Contract
22 ContactLeads
4007 Resource Group
3233 Connection Role Object Type Code
17 ContactInvoices
2 Contact
1071 Address
9754 Custom Control Resource
4502 Customer Relationship
4503 Opportunity Relationship
9755 Custom Control Default Config
9300 Record Creation and Update Rule
2011 Contract Template
9753 Custom Control
9301 Record Creation and Update Rule Item
1200 Field Security Profile
1201 Field Permission
2004 Fixed Monthly Fiscal Calendar
30 Filter Template
9958 Feedback
3008 External Party
955 Expired Process
4204 Fax
9987 External Party Item
4410 Data Import
1007 Image Descriptor
4428 Import Entity Mapping
4413 Import Data
9919 Hierarchy Security Configuration
9600 Goal
54 Global Search Configuration
8840 Hierarchy Rule
9602 Rollup Query
9701 Entitlement Channel
9700 Entitlement
6363 Entitlement Product
7272 Entitlement Contact
9997 Email Signature
4023 Email Hash
4202 Email
9605 Email Server Profile
4299 Email Search
4000 Facility/Equipment
4600 Entity Map
4711 Expander Event
4120 Exchange Sync Id Mapping
85 Virtual Entity Data Source
9703 Entitlement Template Channel
9702 Entitlement Template
78 Virtual Entity Data Provider
4545 Entitlement Template Product
3231 Connection Role
1002 Attachment
4700 System Job
4567 Auditing
4601 Attribute Map
4201 Appointment
8701 AppModule Metadata Dependency
8700 AppModule Metadata
9009 App Module Roles
8702 AppModule Metadata Async Operation
1147 Bookable Resource Category
1146 Bookable Resource Booking Header
1148 Bookable Resource Characteristic
1149 Bookable Resource Category Assn
4421 BookableResourceBooking to Exchange Id Mapping
9936 Azure Service Connection
1094 Authorization Server
1145 Bookable Resource Booking
1150 Bookable Resource
1001 Attachment
9968 ActionCardUserState
4200 Activity
135 Activity Party
9973 Action Card User Settings
16 AccountLeads
1 Account
9962 Action Card
8040 ACIViewMapper
4707 Application File
9011 App Config Master
9007 App Module Component
9006 App
9013 App Configuration Instance
5 Note
9949 Advanced Similarity Rule
9012 App Configuration
2000 Annual Fiscal Calendar
1234 Channel Property Group
1236 Channel Property
113 Child Incident Count
1141 Characteristic
9401 Channel Access Profile Rule Item
9959 Category
9983 Action Card Type
9400 Channel Access Profile Rule
3005 Channel Access Profile
26 CompetitorSalesLiterature
1006 Competitor Product
3234 Connection
9650 Process Configuration
1004 Competitor Address
4417 Column Mapping
36 Client update
123 Competitor
4215 Commitment
4232 Business Data Localized Label
4405 Bulk Operation Log
10 Business Unit
4725 Business Process Flow Instance
4406 Quick Campaign
1152 Booking Status
1151 Bookable Resource Group
4424 Bulk Delete Operation
4425 Bulk Delete Failure
4404 Campaign Activity Item
4402 Campaign Activity
4401 Campaign Response
4403 Campaign Item
4400 Campaign
132 Announcement
6 Business Unit Map
4004 Calendar Rule
4003 Calendar
4412 Import Source File
10128 Incident Type
10049 Find Work Event
10130 Incident Type Product
10129 Incident Type Characteristic
10127 Field Service System Job
10048 Field Computation
10047 Fact
10126 Field Service Setting
10125 Field Service Price List Item
10135 Inventory Journal
10134 Inventory Adjustment Product
10052 Invoice Frequency
10136 Inventory Transfer
10133 Inventory Adjustment
10132 Incident Type Service Task
10131 Incident Type Service
10051 Integration Job Detail
10050 Integration Job
10013 Configuration
10012 Client Extension
10038 Project Contract Line Invoice Schedule
10037 Contact Price List
10036 Competency Requirement (Deprecated)
10122 Agreement Business Process
10121 Case to Work Order Business Process
10035 Invoice Process
10123 Work Order Business Process
10044 Expense
10043 Estimate Line
10046 Expense Receipt
10045 Expense Category
10042 Estimate
10124 Customer Asset
10039 Project Contract Line Milestone
10041 Delegation
10040 Actual Data Export (Deprecated)
10067 Project Contract Project Price List
10066 Project Contract Line Transaction Classification
10194 OrgInsights User Dashboard Definition
10014 Organizational Unit
10065 Project Contract Line Transaction Category
10140 Order Invoicing Setup Date
10139 Order Invoicing Setup
10064 Project Contract Line Detail
10063 Project Contract Line Resource Category
10002 Post Configuration
10145 Postal Code
10015 Priority
10003 Post Rule Configuration
10001 Profile Album
10142 Payment Detail
10141 Payment
10144 Payment Term
10143 Payment Method
10190 IoT Device Registration History
10189 IoT Device Command
10056 Journal Line
10055 Journal
10188 IoT Device Category
10054 Invoice Line Detail
10053 Invoice Frequency Detail
10187 IoT Device
10186 IoT Alert
10062 Opportunity Project Price List
10061 Opportunity Line Transaction Classification
10138 Order Invoicing Product
10137 Order Invoicing Date
10060 Opportunity Line Transaction Category
10000 OData v4 Data Source
10057 Result Cache
10059 Opportunity Line Detail
10058 Opportunity Line Resource Category
10034 Project Stages
4 Lead
9957 Language
24 LeadCompetitors
1017 Lead Address
9947 Knowledge Search Model
9960 Knowledge Article Category
9954 Knowledge Article Incident
9930 Knowledge Base Record
9955 Knowledge Article Views
9201 LocalConfigStore
4301 Marketing List Member
9606 Mailbox
4419 Lookup Mapping
4300 Marketing List
954 Lead To Opportunity Sales Process
27 LeadProduct
2027 License
4207 Letter
3000 Integration Status
4206 Case Resolution
1003 Internal Address
9986 Interaction for Email
9931 Incident KnowledgeBaseRecord
4423 Import Log
9107 Import Job
112 Case
4411 Data Map
1082 Article Comment
127 Article
9953 Knowledge Article
1016 Article Template
4705 ISV Config
7107 Invalid Dependency
4011 Inter Process Lock
1091 Invoice Line
1090 Invoice
10117 Agreement Sub-Status
10116 Agreement Invoice Setup
10033 Batch Job
10032 Approval
10115 Agreement Invoice Product
10112 Agreement Booking Service Task
10111 Agreement Booking Service
10114 Agreement Invoice Date
10113 Agreement Booking Setup
10119 Booking Timestamp
10011 Booking Setup Metadata
10191 CFS - IoT Alert Process Flow
10120 Purchase Order Business Process
10010 Booking Rule
10008 Booking Alert Status
10007 Booking Alert
10118 Booking Journal
10009 Booking Change
9866 Mobile Offline Profile
9603 Goal Metric
9868 Mobile Offline Profile Item Association
9867 Mobile Offline Profile Item
4231 Metadata Difference
9608 Mailbox Auto Tracking Folder
9607 Mailbox Statistics
10193 Plug-in Profile
9106 Mail Merge Template
10108 Agreement Booking Date
10107 Agreement
10110 Agreement Booking Product
10109 Agreement Booking Incident
10006 Actual
10195 News
2003 Monthly Fiscal Calendar
10031 Account Project Price List
10196 Wrong Company?
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