SARunInstance (msdyn_saruninstance) table/entity reference (Microsoft Dynamics 365)

Messages

The following table lists the messages for the SARunInstance (msdyn_saruninstance) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Associate Event: True	Associate records	Associate records
BulkRetain Event: True	BulkRetain	Learn to use messages with the SDK for .NET
Create Event: True	POST /msdyn_saruninstances See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /msdyn_saruninstances(msdyn_saruninstanceid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
PurgeRetainedContent Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
Restore Event: True	Restore	Learn to use messages with the SDK for .NET
Retain Event: True	Retain	Learn to use messages with the SDK for .NET
Retrieve Event: True	GET /msdyn_saruninstances(msdyn_saruninstanceid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /msdyn_saruninstances See Query data	Query data
RollbackRetain Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
SetState Event: True	PATCH /msdyn_saruninstances(msdyn_saruninstanceid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /msdyn_saruninstances(msdyn_saruninstanceid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /msdyn_saruninstances(msdyn_saruninstanceid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest
ValidateRetentionConfig Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the SARunInstance (msdyn_saruninstance) table.

Property	Value
DisplayName	SARunInstance
DisplayCollectionName	SARunInstances
SchemaName	msdyn_saruninstance
CollectionSchemaName	msdyn_saruninstances
EntitySetName	msdyn_saruninstances
LogicalName	msdyn_saruninstance
LogicalCollectionName	msdyn_saruninstances
PrimaryIdAttribute	msdyn_saruninstanceid
PrimaryNameAttribute	msdyn_name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

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

• ImportSequenceNumber
• msdyn_Endtime
• msdyn_entityname
• msdyn_InstanceType
• msdyn_name
• msdyn_recordids
• msdyn_RecordsFailedCount
• msdyn_RecordsSuccededCount
• msdyn_saruninstanceId
• msdyn_SegmentId
• msdyn_StartTime
• msdyn_TotalRecords
• msdyn_TriggerType
• OverriddenCreatedOn
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

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

msdyn_Endtime

Property	Value
Description
DisplayName	End time
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_endtime
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Auto
SourceTypeMask	0

msdyn_entityname

Property	Value
Description
DisplayName	Entity logical name
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_entityname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

msdyn_InstanceType

Property	Value
Description
DisplayName	Instance type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_instancetype
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	0
GlobalChoiceName	msdyn_saruninstance_msdyn_instancetype

msdyn_InstanceType Choices/Options

Value	Label
0	Reassignment
1	ForceRoute

msdyn_name

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

msdyn_recordids

Property	Value
Description
DisplayName	Record ids to process
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_recordids
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

msdyn_RecordsFailedCount

Property	Value
Description
DisplayName	Records failed count
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_recordsfailedcount
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_RecordsSuccededCount

Property	Value
Description
DisplayName	Records succeded count
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_recordssuccededcount
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_saruninstanceId

Property	Value
Description	Unique identifier for entity instances
DisplayName	SARunInstance
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_saruninstanceid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_SegmentId

Property	Value
Description	Unique identifier for Segment associated with SARunInstance.
DisplayName	Segment
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_segmentid
RequiredLevel	None
Type	Lookup
Targets	msdyn_segment

msdyn_StartTime

Property	Value
Description
DisplayName	Start time
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_starttime
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Auto
SourceTypeMask	0

msdyn_TotalRecords

Property	Value
Description
DisplayName	Total records
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_totalrecords
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_TriggerType

Property	Value
Description
DisplayName	Trigger type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_triggertype
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	1
GlobalChoiceName	msdyn_saruninstance_msdyn_triggertype

msdyn_TriggerType Choices/Options

Value	Label
0	Manual
1	Scheduled

OverriddenCreatedOn

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

statecode

Property	Value
Description	Status of the SARunInstance
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	msdyn_saruninstance_statecode

statecode Choices/Options

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

statuscode

Property	Value
Description	Reason for the status of the SARunInstance
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	msdyn_saruninstance_statuscode

statuscode Choices/Options

Value	Details
0	Label: In Progress State:0 TransitionData: None
1	Label: Succeeded State:1 TransitionData: None
2	Label: Failed State:1 TransitionData: None
3	Label: Skipped State:1 TransitionData: None
4	Label: Queued State:0 TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

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

• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• VersionNumber

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

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
Type	Lookup
Targets	systemuser

ModifiedBy

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

ModifiedOn

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

ModifiedOnBehalfBy

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
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	None
Type	Lookup
Targets	organization

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• lk_msdyn_saruninstance_createdby
• lk_msdyn_saruninstance_createdonbehalfby
• lk_msdyn_saruninstance_modifiedby
• lk_msdyn_saruninstance_modifiedonbehalfby
• msdyn_msdyn_segment_msdyn_saruninstance
• organization_msdyn_saruninstance

lk_msdyn_saruninstance_createdby

One-To-Many Relationship: systemuser lk_msdyn_saruninstance_createdby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdby
ReferencingEntityNavigationPropertyName	createdby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_msdyn_saruninstance_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_saruninstance_createdonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdonbehalfby
ReferencingEntityNavigationPropertyName	createdonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_msdyn_saruninstance_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_saruninstance_modifiedby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedby
ReferencingEntityNavigationPropertyName	modifiedby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_msdyn_saruninstance_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_saruninstance_modifiedonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedonbehalfby
ReferencingEntityNavigationPropertyName	modifiedonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

msdyn_msdyn_segment_msdyn_saruninstance

One-To-Many Relationship: msdyn_segment msdyn_msdyn_segment_msdyn_saruninstance

Property	Value
ReferencedEntity	msdyn_segment
ReferencedAttribute	msdyn_segmentid
ReferencingAttribute	msdyn_segmentid
ReferencingEntityNavigationPropertyName	msdyn_SegmentId
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade RollupView: NoCascade Share: Cascade Unshare: Cascade

organization_msdyn_saruninstance

One-To-Many Relationship: organization organization_msdyn_saruninstance

Property	Value
ReferencedEntity	organization
ReferencedAttribute	organizationid
ReferencingAttribute	organizationid
ReferencingEntityNavigationPropertyName	organizationid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

• msdyn_msdyn_saruninstance_msdyn_sabatchinstance
• msdyn_msdyn_saruninstance_msdyn_salesroutingrun_saruninstanceid
• msdyn_saruninstance_AsyncOperations
• msdyn_saruninstance_BulkDeleteFailures
• msdyn_saruninstance_DuplicateBaseRecord
• msdyn_saruninstance_DuplicateMatchingRecord
• msdyn_saruninstance_MailboxTrackingFolders
• msdyn_saruninstance_PrincipalObjectAttributeAccesses
• msdyn_saruninstance_ProcessSession
• msdyn_saruninstance_SyncErrors

msdyn_msdyn_saruninstance_msdyn_sabatchinstance

Many-To-One Relationship: msdyn_sabatchruninstance msdyn_msdyn_saruninstance_msdyn_sabatchinstance

Property	Value
ReferencingEntity	msdyn_sabatchruninstance
ReferencingAttribute	msdyn_saruninstanceid
ReferencedEntityNavigationPropertyName	msdyn_msdyn_saruninstance_msdyn_sabatchinstance
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_msdyn_saruninstance_msdyn_salesroutingrun_saruninstanceid

Many-To-One Relationship: msdyn_salesroutingrun msdyn_msdyn_saruninstance_msdyn_salesroutingrun_saruninstanceid

Property	Value
ReferencingEntity	msdyn_salesroutingrun
ReferencingAttribute	msdyn_saruninstanceid
ReferencedEntityNavigationPropertyName	msdyn_msdyn_saruninstance_msdyn_salesroutingrun_saruninstanceid
IsCustomizable	False
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_saruninstance_AsyncOperations

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_AsyncOperations
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_saruninstance_BulkDeleteFailures

Property	Value
ReferencingEntity	bulkdeletefailure
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_BulkDeleteFailures
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord msdyn_saruninstance_DuplicateBaseRecord

Property	Value
ReferencingEntity	duplicaterecord
ReferencingAttribute	baserecordid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_DuplicateBaseRecord
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord msdyn_saruninstance_DuplicateMatchingRecord

Property	Value
ReferencingEntity	duplicaterecord
ReferencingAttribute	duplicaterecordid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_DuplicateMatchingRecord
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_saruninstance_MailboxTrackingFolders

Property	Value
ReferencingEntity	mailboxtrackingfolder
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_MailboxTrackingFolders
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_saruninstance_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	principalobjectattributeaccess
ReferencingAttribute	objectid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_PrincipalObjectAttributeAccesses
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_ProcessSession

Many-To-One Relationship: processsession msdyn_saruninstance_ProcessSession

Property	Value
ReferencingEntity	processsession
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_ProcessSession
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_saruninstance_SyncErrors

Many-To-One Relationship: syncerror msdyn_saruninstance_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_saruninstance_SyncErrors
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference