msdyn_salesroutingrun.md

title	description	ms.date	ms.service	ms.topic	ms.assetid	author	ms.author	ms.reviewer	search.audienceType
msdyn_salesroutingrun table/entity reference	Includes schema information and supported messages for the msdyn_salesroutingrun table/entity.	02/27/2024	dynamics-365-sales	reference	3948cc48-07c8-7f60-0608-71c37158ad7c	lavanyakr01	lavanyakr	lavanyakr	developer

msdyn_salesroutingrun table/entity reference

Note

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

Added by: Assignment Rules Solution

Messages

Message	Web API Operation	SDK class or method
Assign	PATCH /msdyn_salesroutingruns(msdyn_salesroutingrunid) Update ownerid property.	xref:Microsoft.Crm.Sdk.Messages.AssignRequest
BulkRetain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create	POST /msdyn_salesroutingruns See Create	xref:Microsoft.Xrm.Sdk.Messages.CreateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Create*
CreateMultiple	<xref:Microsoft.Dynamics.CRM.CreateMultiple?displayProperty=nameWithType />	xref:Microsoft.Xrm.Sdk.Messages.CreateMultipleRequest
Delete	DELETE /msdyn_salesroutingruns(msdyn_salesroutingrunid) See Delete	xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete*
GrantAccess	<xref:Microsoft.Dynamics.CRM.GrantAccess?displayProperty=nameWithType />	xref:Microsoft.Crm.Sdk.Messages.GrantAccessRequest
IsValidStateTransition	<xref:Microsoft.Dynamics.CRM.IsValidStateTransition?displayProperty=nameWithType />	xref:Microsoft.Crm.Sdk.Messages.IsValidStateTransitionRequest
ModifyAccess	<xref:Microsoft.Dynamics.CRM.ModifyAccess?displayProperty=nameWithType />	xref:Microsoft.Crm.Sdk.Messages.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_salesroutingruns(msdyn_salesroutingrunid) See Retrieve	xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve*
RetrieveMultiple	GET /msdyn_salesroutingruns See Query Data	xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple*
RetrievePrincipalAccess	<xref:Microsoft.Dynamics.CRM.RetrievePrincipalAccess?displayProperty=nameWithType />	xref:Microsoft.Crm.Sdk.Messages.RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	<xref:Microsoft.Dynamics.CRM.RetrieveSharedPrincipalsAndAccess?displayProperty=nameWithType />	xref:Microsoft.Crm.Sdk.Messages.RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	<xref:Microsoft.Dynamics.CRM.RevokeAccess?displayProperty=nameWithType />	xref:Microsoft.Crm.Sdk.Messages.RevokeAccessRequest
RollbackRetain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState	PATCH /msdyn_salesroutingruns(msdyn_salesroutingrunid) Update statecode and statuscode properties.	xref:Microsoft.Crm.Sdk.Messages.SetStateRequest
Update	PATCH /msdyn_salesroutingruns(msdyn_salesroutingrunid) See Update	xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Update*
UpdateMultiple	<xref:Microsoft.Dynamics.CRM.UpdateMultiple?displayProperty=nameWithType />	xref:Microsoft.Xrm.Sdk.Messages.UpdateMultipleRequest
ValidateRetentionConfig	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property	Value
CollectionSchemaName	msdyn_salesroutingruns
DisplayCollectionName	Sales routing runs
DisplayName	Sales routing run
EntitySetName	msdyn_salesroutingruns
IsBPFEntity	False
LogicalCollectionName	msdyn_salesroutingruns
LogicalName	msdyn_salesroutingrun
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_salesroutingrunid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_salesroutingrun

Writable columns/attributes

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

• ImportSequenceNumber
• msdyn_assignmentruleid
• msdyn_isrecordassigned
• msdyn_name
• msdyn_ownerassigned
• msdyn_ownerassignedIdType
• msdyn_previousowner
• msdyn_previousownerIdType
• msdyn_salesroutingrunId
• msdyn_segmentid
• msdyn_targetobject
• msdyn_targetobjectIdType
• 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
DisplayName	Assignment Rule
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_assignmentruleid
RequiredLevel	ApplicationRequired
Targets	msdyn_assignmentrule
Type	Lookup

msdyn_isrecordassigned

Property	Value
Description
DisplayName	Is record assigned
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_isrecordassigned
RequiredLevel	None
Type	Boolean

msdyn_isrecordassigned Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

msdyn_name

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

msdyn_ownerassigned

Property	Value
Description	Assigned owner id
DisplayName	Assigned owner
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_ownerassigned
RequiredLevel	ApplicationRequired
Targets	queue,systemuser,team
Type	Lookup

msdyn_ownerassignedIdType

Added by: Active Solution Solution

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_ownerassignedidtype
RequiredLevel	None
Type	EntityName

msdyn_previousowner

Property	Value
Description	Previous owner id
DisplayName	Previous owner
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_previousowner
RequiredLevel	None
Targets	queue,systemuser,team
Type	Lookup

msdyn_previousownerIdType

Added by: Active Solution Solution

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_previousowneridtype
RequiredLevel	None
Type	EntityName

msdyn_salesroutingrunId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Sales routing run
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_salesroutingrunid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_segmentid

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

msdyn_targetobject

Property	Value
Description
DisplayName	Target Object
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_targetobject
RequiredLevel	None
Targets	lead,msdyn_salessuggestion,opportunity
Type	Lookup

msdyn_targetobjectIdType

Added by: Active Solution Solution

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_targetobjectidtype
RequiredLevel	None
Type	EntityName

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 Sales routing run
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

statecode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Inprogress	1	Inprogress
1	Succeeded	2	Succeeded
2	Failed	3	Failed

statuscode

Property	Value
Description	Reason for the status of the Sales routing run
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

statuscode Choices/Options

Value	Label	State
1	Run is in progress	0
2	Owner assigned successfully	1
3	There was an issue with the server	2
4	Record doesn't meet any conditions	2
5	No sellers meet the conditions	2
6	Eligible sellers don't have availability	2
7	Eligible sellers don't have capacity	2
8	No assignment rule for this record's segment	2
9	Owner assigned manually	1
10	Record unassigned as seller lacks security role privileges	2
11	Seller not assigned as record is older than the set timeframe	2
12	Found multiple eligible teams	2
13	Couldn't find eligible team	2
14	Found multiple eligible queues	2
15	Couldn't find eligible queue	2

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_assignmentruleidName
• msdyn_ownerassignedName
• msdyn_ownerassignedYomiName
• msdyn_previousownerName
• msdyn_previousownerYomiName
• msdyn_segmentidName
• msdyn_targetobjectName
• msdyn_targetobjectYomiName
• 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	Assignment attempt
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_assignmentruleidName

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

msdyn_ownerassignedName

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

msdyn_ownerassignedYomiName

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

msdyn_previousownerName

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

msdyn_previousownerYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_previousowneryominame
MaxLength	1000
RequiredLevel	None
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

msdyn_targetobjectName

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

msdyn_targetobjectYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_targetobjectyominame
MaxLength	1000
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

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_assignmentrule_msdyn_salesroutingrun_assignmentrule
• msdyn_lead_msdyn_salesroutingrun_targetobject
• msdyn_opportunity_msdyn_salesroutingrun_targetobject
• msdyn_msdyn_segment_msdyn_salesroutingrun_segment

msdyn_msdyn_assignmentrule_msdyn_salesroutingrun_assignmentrule

See the msdyn_msdyn_assignmentrule_msdyn_salesroutingrun_assignmentrule one-to-many relationship for the msdyn_assignmentrule table/entity.

msdyn_lead_msdyn_salesroutingrun_targetobject

Added by: Lead Management Solution

See the msdyn_lead_msdyn_salesroutingrun_targetobject one-to-many relationship for the lead table/entity.

msdyn_opportunity_msdyn_salesroutingrun_targetobject

Added by: Sales Solution

See the msdyn_opportunity_msdyn_salesroutingrun_targetobject one-to-many relationship for the opportunity table/entity.

msdyn_msdyn_segment_msdyn_salesroutingrun_segment

Added by: Segment solution Solution

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

Related information

Dataverse table/entity reference
Web API Reference