PickListMapping entity reference

Note

Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.

In a data map, maps list values from the source file to Microsoft Dynamics 365.

Messages

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

Entity properties

Property Value
CollectionSchemaName PickListMappings
DisplayCollectionName List Value Mappings
DisplayName List Value Mapping
EntitySetName picklistmappings
IsBPFEntity False
LogicalCollectionName picklistmappings
LogicalName picklistmapping
OwnershipType None
PrimaryIdAttribute picklistmappingid
PrimaryNameAttribute
SchemaName PickListMapping

Writable attributes

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

ColumnMappingId

Property Value
Description Unique identifier of the column mapping with which this list value mapping is associated.
DisplayName Column Mapping Id
IsValidForForm True
IsValidForRead True
LogicalName columnmappingid
RequiredLevel ApplicationRequired
Targets columnmapping
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

PickListMappingId

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

ProcessCode

Property Value
Description Information about whether the list value 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
4 Unmapped

SourceValue

Property Value
Description Source value to be replaced.
DisplayName Source Value
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName sourcevalue
MaxLength 2097152
RequiredLevel None
Type String

StatusCode

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

StatusCode Options

Value Label State
0 Active 0

TargetValue

Property Value
Description Microsoft Dynamics 365 list value with which to replace the source value.
DisplayName Target Value
Format None
IsValidForForm True
IsValidForRead True
LogicalName targetvalue
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Read-only attributes

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

ColumnMappingIdName

Property Value
Description Name of the column mapping.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName columnmappingidname
MaxLength 100
RequiredLevel SystemRequired
Type String

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 list value 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 list value 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 picklistmapping.
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

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 list value 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 list value 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 picklistmapping.
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

PickListMappingIdUnique

Property Value
Description Unique identifier of the Pick List Mapping.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName picklistmappingidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

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 picklist mapping.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 0 Active

SupportingSolutionId

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

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_picklistmapping_modifiedonbehalfby

See systemuser Entity lk_picklistmapping_modifiedonbehalfby One-To-Many relationship.

PickListMapping_ColumnMapping

See columnmapping Entity PickListMapping_ColumnMapping One-To-Many relationship.

lk_picklistmapping_createdby

See systemuser Entity lk_picklistmapping_createdby One-To-Many relationship.

lk_picklistmapping_createdonbehalfby

See systemuser Entity lk_picklistmapping_createdonbehalfby One-To-Many relationship.

lk_picklistmapping_modifiedby

See systemuser Entity lk_picklistmapping_modifiedby One-To-Many relationship.

See also

About entity reference
Web API reference
picklistmapping EntityType

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).