msdyn_assignmentrule table/entity reference

Note

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

Defines criteria based on which Entities are routed to Users or Sales Team

Added by: Assignment Rules Solution

Messages

Message	Web API Operation	SDK class or method
Assign	PATCH /msdyn_assignmentrules(msdyn_assignmentruleid) Update ownerid property.	AssignRequest
BulkRetain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create	POST /msdyn_assignmentrules See Create	CreateRequest or Create
CreateMultiple	CreateMultiple	CreateMultipleRequest
Delete	DELETE /msdyn_assignmentrules(msdyn_assignmentruleid) See Delete	DeleteRequest or Delete
GrantAccess	GrantAccess	GrantAccessRequest
IsValidStateTransition	IsValidStateTransition	IsValidStateTransitionRequest
ModifyAccess	ModifyAccess	ModifyAccessRequest
PurgeRetainedContent	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retrieve	GET /msdyn_assignmentrules(msdyn_assignmentruleid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /msdyn_assignmentrules See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess	RevokeAccessRequest
RollbackRetain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState	PATCH /msdyn_assignmentrules(msdyn_assignmentruleid) Update statecode and statuscode properties.	SetStateRequest
Update	PATCH /msdyn_assignmentrules(msdyn_assignmentruleid) See Update	UpdateRequest or Update
UpdateMultiple	UpdateMultiple	UpdateMultipleRequest
ValidateRetentionConfig	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property	Value
CollectionSchemaName	msdyn_assignmentrules
DisplayCollectionName	assignmentrules
DisplayName	Assignment Rule
EntitySetName	msdyn_assignmentrules
IsBPFEntity	False
LogicalCollectionName	msdyn_assignmentrules
LogicalName	msdyn_assignmentrule
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_assignmentruleid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_assignmentrule

Writable columns/attributes

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

• ImportSequenceNumber
• msdyn_assignmentruleId
• msdyn_assignmentwindow
• msdyn_attributefilter
• msdyn_Description
• msdyn_DistributeTo
• msdyn_distributewithavailability
• msdyn_distributewithcapacity
• msdyn_distributewithrecordcreation
• msdyn_DistributionType
• msdyn_entityfilter
• msdyn_evaluationorder
• msdyn_matchedrecords
• msdyn_matchtype
• msdyn_name
• msdyn_objecttype
• msdyn_objecttypecode
• msdyn_recordcreationwindow
• msdyn_segmentid
• msdyn_sellerfilter
• msdyn_SpecificSellersOrTeams
• msdyn_triggertype
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

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

msdyn_assignmentruleId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Assignment Rule
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_assignmentruleid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_assignmentwindow

Property	Value
Description	Assignment due in
DisplayName	Assignment due in
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_assignmentwindow
MaxValue	120
MinValue	0
RequiredLevel	ApplicationRequired
Type	Integer

msdyn_attributefilter

Property	Value
Description
DisplayName	Attribute Filter
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_attributefilter
MaxLength	4000
RequiredLevel	None
Type	Memo

msdyn_Description

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

msdyn_DistributeTo

Property	Value
Description	Setting depecting if the assignment is done for a team, queue or a seller.
DisplayName	Assign to Sellers, Teams or Queues.
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_distributeto
RequiredLevel	None
Type	Picklist

msdyn_DistributeTo Choices/Options

Value	Label	Description
0	Sellers
1	Team
2	Queue

msdyn_distributewithavailability

Property	Value
Description
DisplayName	DistributeWithAvailability
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_distributewithavailability
RequiredLevel	ApplicationRequired
Type	Boolean

msdyn_distributewithavailability Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

msdyn_distributewithcapacity

Property	Value
Description
DisplayName	DistributeWithCapacity
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_distributewithcapacity
RequiredLevel	ApplicationRequired
Type	Boolean

msdyn_distributewithcapacity Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

msdyn_distributewithrecordcreation

Property	Value
Description	CheckEligibilityByRecordAge
DisplayName	CheckEligibilityByRecordAge
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_distributewithrecordcreation
RequiredLevel	None
Type	Boolean

msdyn_distributewithrecordcreation Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

msdyn_DistributionType

Property	Value
Description
DisplayName	DistributionType
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_distributiontype
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_DistributionType Choices/Options

Value	Label	Description
0	RoundRobin
1	Load Balancing
2	Assign to any one team at random
3	Don't assign to any team
4	Add to any one queue at random
5	Don't add to any queue

msdyn_entityfilter

Property	Value
Description
DisplayName	Entity Filter
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_entityfilter
MaxLength	4000
RequiredLevel	None
Type	Memo

msdyn_evaluationorder

Property	Value
Description	Evaluation order of the rule
DisplayName	EvaluationOrder
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_evaluationorder
MaxValue	2147483647
MinValue	1
RequiredLevel	ApplicationRequired
Type	Integer

msdyn_matchedrecords

Property	Value
Description	Records routed by this rule
DisplayName	Records Routed
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_matchedrecords
MaxValue	2147483647
MinValue	0
RequiredLevel	None
Type	Integer

msdyn_matchtype

Property	Value
Description	Setting depecting if the seller or team assignment needs to be done either by filtering attributes or by specifying sellers or teams
DisplayName	MatchType
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_matchtype
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_matchtype Choices/Options

Value	Label	Description
0	Filter using Attributes
1	Specific List
2	Any Sellers

msdyn_name

Property	Value
Description	The name of the custom entity.
DisplayName	Assignment Rule
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_objecttype

Property	Value
Description
DisplayName	Reference to the related entity logical name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_objecttype
MaxLength	4000
RequiredLevel	None
Type	String

msdyn_objecttypecode

Property	Value
Description
DisplayName	Entity
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_objecttypecode
RequiredLevel	None
Type	Picklist

msdyn_objecttypecode Choices/Options

Value	Label	Description
3	Opportunity
4	Lead
5	Other

msdyn_recordcreationwindow

Property	Value
Description	Assignment due in
DisplayName	Assignment due in
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_recordcreationwindow
MaxValue	120
MinValue	0
RequiredLevel	None
Type	Integer

msdyn_segmentid

Property	Value
Description
DisplayName	Segment
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_segmentid
RequiredLevel	ApplicationRequired
Targets	msdyn_segment
Type	Lookup

msdyn_sellerfilter

Property	Value
Description
DisplayName	Seller Filter
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sellerfilter
MaxLength	4000
RequiredLevel	None
Type	Memo

msdyn_SpecificSellersOrTeams

Property	Value
Description	List of specific sellers or teams that needs to be assigned.
DisplayName	Sellers or Team.
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_SpecificSellersOrTeams
MaxLength	1000000
RequiredLevel	None
Type	Memo

msdyn_triggertype

Property	Value
Description	Trigger when the rule needs to be evaluated
DisplayName	TriggerType
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_triggertype
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_triggertype Choices/Options

Value	Label	Description
0	Entity Create
1	FieldUpdate

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

OwnerId

Added by: Active Solution Solution

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the Assignment Rule
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 Assignment Rule
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.

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• msdyn_segmentidName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningBusinessUnitName
• OwningTeam
• OwningUser
• VersionNumber

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

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

msdyn_segmentidName

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

OwnerIdName

Added by: Active Solution Solution

Property	Value
Description	Name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Added by: Active Solution Solution

Property	Value
Description	Yomi name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

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

OwningTeam

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

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.

msdyn_msdyn_assignmentrule_msdyn_salesroutingrun_assignmentrule

Same as the msdyn_msdyn_assignmentrule_msdyn_salesroutingrun_assignmentrule many-to-one relationship for the msdyn_salesroutingrun table/entity.

Property	Value
ReferencingEntity	msdyn_salesroutingrun
ReferencingAttribute	msdyn_assignmentruleid
IsHierarchical	False
IsCustomizable	True
ReferencedEntityNavigationPropertyName	msdyn_msdyn_assignmentrule_msdyn_salesroutingrun_assignmentrule
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order: 10000
CascadeConfiguration	Assign: NoCascade Delete: RemoveLink 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.

msdyn_msdyn_segment_msdyn_assignmentrule_segment

Added by: Segment solution Solution

See the msdyn_msdyn_segment_msdyn_assignmentrule_segment one-to-many relationship for the msdyn_segment table/entity.

Related information

Dataverse table/entity reference
Web API Reference