ServicePlanMapping table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Service Plan Mapping

Added by: License Enforcement Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/serviceplanmappings
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/serviceplanmappings(serviceplanmappingid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
Retrieve GET [org URI]/api/data/v9.0/serviceplanmappings(serviceplanmappingid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/serviceplanmappings
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/serviceplanmappings(serviceplanmappingid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/serviceplanmappings(serviceplanmappingid)
See Update
UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName ServicePlanMappings
DisplayCollectionName Service Plan Mappings
DisplayName Service Plan Mapping
EntitySetName serviceplanmappings
IsBPFEntity False
LogicalCollectionName serviceplanmappings
LogicalName serviceplanmapping
OwnershipType None
PrimaryIdAttribute serviceplanmappingid
PrimaryNameAttribute name
SchemaName ServicePlanMapping

Writable columns/attributes

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

Entity

Property Value
Description Unique identifier of the table/entity that needs to be enforced. If the entity is not provided in the mapping, it will enforce all tables/entities for the SdkMessage.
DisplayName Entity
IsValidForForm True
IsValidForRead True
LogicalName entity
RequiredLevel None
Targets entity
Type Lookup

FeatureControl

Property Value
Description Feature Control to enable/disable the current mapping enforcement(This Feature Control will be controlled by solution owners).
DisplayName Feature Control
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName featurecontrol
MaxLength 300
RequiredLevel None
Type String

ImportSequenceNumber

Added by: Basic Solution Solution

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsCustomizable

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

Name

Property Value
Description The name of the mapping(optional).
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel None
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

SdkMessage

Property Value
Description Unique identifier of the Sdk Message that needs to be enforced. If the SdkMessage is not provided in the mapping, it will enforce all Sdk Messages for the table/entity.
DisplayName Sdk Message
IsValidForForm True
IsValidForRead True
LogicalName sdkmessage
RequiredLevel None
Targets sdkmessage
Type Lookup

ServicePlan

Property Value
Description Unique identifier of the Service Plan that the user must have to perform operation(s) on the current mapping component(s)
DisplayName Service Plan
IsValidForForm True
IsValidForRead True
LogicalName serviceplan
RequiredLevel SystemRequired
Targets serviceplan
Type Lookup

ServicePlanMappingId

Property Value
Description Unique identifier for entity instances
DisplayName Service Plan Mapping
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName serviceplanmappingid
RequiredLevel SystemRequired
Type Uniqueidentifier

statecode

Property Value
Description Status of the Service Plan Mapping
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the Service Plan Mapping
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

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

ComponentIdUnique

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Added by: Basic Solution Solution

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

ComponentState Choices/Options

Value Label Description
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Added by: Active Solution Solution

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

CreatedByName

Added by: Active Solution Solution

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

CreatedByYomiName

Added by: Active Solution Solution

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

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

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

CreatedOnBehalfByName

Added by: Active Solution Solution

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

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

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

EntityName

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

IsManaged

Added by: Basic Solution Solution

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: False

ModifiedBy

Added by: Active Solution Solution

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

ModifiedByName

Added by: Active Solution Solution

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

ModifiedByYomiName

Added by: Active Solution Solution

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

ModifiedOn

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

ModifiedOnBehalfBy

Added by: Active Solution Solution

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

ModifiedOnBehalfByName

Added by: Active Solution Solution

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

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

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

OverwriteTime

Added by: Basic Solution Solution

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

SdkMessageName

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

ServicePlanName

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

SolutionId

Added by: Basic Solution Solution

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

SupportingSolutionId

Added by: Basic Solution Solution

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

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

serviceplanmapping_SyncErrors

Added by: System Solution Solution

Same as syncerror table serviceplanmapping_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord table serviceplanmapping_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord table serviceplanmapping_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation table serviceplanmapping_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder table serviceplanmapping_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_ProcessSession

Added by: System Solution Solution

Same as processsession table serviceplanmapping_ProcessSession Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure table serviceplanmapping_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

serviceplanmapping_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess table serviceplanmapping_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName serviceplanmapping_PrincipalObjectAttributeAccesses
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 table. Listed by SchemaName.

lk_serviceplanmapping_createdby

Added by: System Solution Solution

See systemuser Table lk_serviceplanmapping_createdby One-To-Many relationship.

lk_serviceplanmapping_createdonbehalfby

Added by: System Solution Solution

See systemuser Table lk_serviceplanmapping_createdonbehalfby One-To-Many relationship.

lk_serviceplanmapping_modifiedby

Added by: System Solution Solution

See systemuser Table lk_serviceplanmapping_modifiedby One-To-Many relationship.

lk_serviceplanmapping_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Table lk_serviceplanmapping_modifiedonbehalfby One-To-Many relationship.

entity_serviceplanmapping

Added by: System Solution Solution

See entity Table entity_serviceplanmapping One-To-Many relationship.

sdkmessage_serviceplanmapping

Added by: System Solution Solution

See sdkmessage Table sdkmessage_serviceplanmapping One-To-Many relationship.

serviceplan_serviceplanmapping

See serviceplan Table serviceplan_serviceplanmapping One-To-Many relationship.

See also

About the table reference
Web API Reference
Microsoft.Dynamics.CRM.serviceplanmapping