ColumnMapping Entity Reference

Article
02/16/2022
5 minutes de lecture

Mapping for columns in a data map.

Messages

Message	Web API Operation	SDK Assembly
Create	POST [org URI]/api/data/v9.0/columnmappings See Create	CreateRequest or Create
Delete	DELETE [org URI]/api/data/v9.0/columnmappings(columnmappingid) See Delete	DeleteRequest or Delete
Retrieve	GET [org URI]/api/data/v9.0/columnmappings(columnmappingid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/columnmappings See Query Data	RetrieveMultipleRequest or RetrieveMultiple

Entity Properties

Property	Value
CollectionSchemaName	ColumnMappings
DisplayCollectionName	Column Mappings
DisplayName	Column Mapping
EntitySetName	columnmappings
IsBPFEntity	False
LogicalCollectionName	columnmappings
LogicalName	columnmapping
OwnershipType	None
PrimaryIdAttribute	columnmappingid
PrimaryNameAttribute	sourceattributename
SchemaName	ColumnMapping

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ColumnMappingId
ImportMapId
IntroducedVersion
ProcessCode
SourceAttributeName
SourceEntityName
StatusCode
TargetAttributeName
TargetEntityName

ColumnMappingId

Property	Value
Description	Unique identifier of the column mapping.
DisplayName
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	columnmappingid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ImportMapId

Property	Value
Description	Unique identifier of the associated data map.
DisplayName	Data Map ID
IsValidForForm	True
IsValidForRead	True
LogicalName	importmapid
RequiredLevel	ApplicationRequired
Targets	importmap
Type	Lookup

IntroducedVersion

Property	Value
Description	Version in which the component is introduced.
DisplayName	Introduced Version
FormatName	VersionNumber
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	introducedversion
MaxLength	48
RequiredLevel	None
Type	String

ProcessCode

Property	Value
Description	Information about whether the column mapping needs to be processed.
DisplayName	Process Code
IsValidForForm	True
IsValidForRead	True
LogicalName	processcode
RequiredLevel	SystemRequired
Type	Picklist

ProcessCode Options

Value	Label
1	Process
2	Ignore
3	Internal

SourceAttributeName

Property	Value
Description	Name of the source attribute.
DisplayName	Source Attribute
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	sourceattributename
MaxLength	160
RequiredLevel	ApplicationRequired
Type	String

SourceEntityName

Property	Value
Description	Name of the source entity.
DisplayName	Source Entity Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	sourceentityname
MaxLength	160
RequiredLevel	ApplicationRequired
Type	String

StatusCode

Property	Value
Description	Reason for the status of the column mapping.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	SystemRequired
Type	Status

StatusCode Options

Value	Label	State
1	Active	0

TargetAttributeName

Property	Value
Description	Name of the Microsoft Dynamics 365 attribute.
DisplayName	Target Attribute
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	targetattributename
MaxLength	160
RequiredLevel	None
Type	String

TargetEntityName

Property	Value
Description	Name of the Microsoft Dynamics 365 entity.
DisplayName	Target Entity
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	targetentityname
MaxLength	160
RequiredLevel	None
Type	String

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ColumnMappingIdUnique
ComponentState
CreatedBy
CreatedByName
CreatedByYomiName
CreatedOn
CreatedOnBehalfBy
CreatedOnBehalfByName
CreatedOnBehalfByYomiName
ImportMapIdName
IsManaged
ModifiedBy
ModifiedByName
ModifiedByYomiName
ModifiedOn
ModifiedOnBehalfBy
ModifiedOnBehalfByName
ModifiedOnBehalfByYomiName
OverwriteTime
SolutionId
StateCode
SupportingSolutionId

ColumnMappingIdUnique

Property	Value
Description	Unique identifier of the Column Mapping.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	columnmappingidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist

ComponentState Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

CreatedBy

Property	Value
Description	Unique identifier of the user who created the column mapping.
DisplayName	Created By
IsValidForForm	False
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	None
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the column mapping was created.
DisplayName
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	createdon
RequiredLevel	SystemRequired
Type	DateTime

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the columnmapping.
DisplayName	Created By (Delegate)
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ImportMapIdName

Property	Value
Description	Name of the associated data map.
DisplayName	Data Map
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	importmapidname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

IsManaged

Property	Value
Description	Information that specifies whether this component is managed.
DisplayName	State
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean

IsManaged Options

Value	Label
1	Managed
0	Unmanaged

DefaultValue: False

ModifiedBy

Property	Value
Description	Unique identifier of the user who last modified the column mapping.
DisplayName	Modified By
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the column mapping was last modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	SystemRequired
Type	DateTime

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who last modified the columnmapping.
DisplayName	Modified By (Delegate)
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

OverwriteTime

Property	Value
DateTimeBehavior	UserLocal
Description	For internal use only.
DisplayName	Record Overwrite Time
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

StateCode

Property	Value
Description	Status of the column mapping.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

StateCode Options

Value	Label	DefaultStatus	InvariantName
0	Active	1	Active

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

One-To-Many Relationships

Listed by SchemaName.

PickListMapping_ColumnMapping
LookUpMapping_ColumnMapping

PickListMapping_ColumnMapping

Same as picklistmapping entity PickListMapping_ColumnMapping Many-To-One relationship.

Property	Value
ReferencingEntity	picklistmapping
ReferencingAttribute	columnmappingid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	PickListMapping_ColumnMapping
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

LookUpMapping_ColumnMapping

Same as lookupmapping entity LookUpMapping_ColumnMapping Many-To-One relationship.

Property	Value
ReferencingEntity	lookupmapping
ReferencingAttribute	columnmappingid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	LookUpMapping_ColumnMapping
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_columnmapping_createdonbehalfby
lk_columnmapping_createdby
ColumnMapping_ImportMap
lk_columnmapping_modifiedonbehalfby
lk_columnmapping_modifiedby

lk_columnmapping_createdonbehalfby

See systemuser Entity lk_columnmapping_createdonbehalfby One-To-Many relationship.

lk_columnmapping_createdby

See systemuser Entity lk_columnmapping_createdby One-To-Many relationship.

ColumnMapping_ImportMap

See importmap Entity ColumnMapping_ImportMap One-To-Many relationship.

lk_columnmapping_modifiedonbehalfby

See systemuser Entity lk_columnmapping_modifiedonbehalfby One-To-Many relationship.

lk_columnmapping_modifiedby

See systemuser Entity lk_columnmapping_modifiedby One-To-Many relationship.