msdyn_saruninstance table/entity reference

Note

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

Added by: Segment solution Solution

Messages

Message Web API Operation SDK class or method
BulkRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create POST /msdyn_saruninstances
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /msdyn_saruninstances(msdyn_saruninstanceid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
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_saruninstances(msdyn_saruninstanceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /msdyn_saruninstances
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RollbackRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState PATCH /msdyn_saruninstances(msdyn_saruninstanceid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /msdyn_saruninstances(msdyn_saruninstanceid)
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_saruninstances
DisplayCollectionName SARunInstances
DisplayName SARunInstance
EntitySetName msdyn_saruninstances
IsBPFEntity False
LogicalCollectionName msdyn_saruninstances
LogicalName msdyn_saruninstance
OwnershipType OrganizationOwned
PrimaryIdAttribute msdyn_saruninstanceid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_saruninstance

Writable columns/attributes

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

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_Endtime

Property Value
DateTimeBehavior UserLocal
Description
DisplayName End time
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName msdyn_endtime
RequiredLevel None
Type DateTime

msdyn_InstanceType

Property Value
Description
DisplayName Instance type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_instancetype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_InstanceType Choices/Options

Value Label Description
0 Reassignment

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_RecordsFailedCount

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

msdyn_RecordsSuccededCount

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

msdyn_saruninstanceId

Property Value
Description Unique identifier for entity instances
DisplayName SARunInstance
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
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
Targets msdyn_segment
Type Lookup

msdyn_StartTime

Property Value
DateTimeBehavior UserLocal
Description
DisplayName Start time
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName msdyn_starttime
RequiredLevel None
Type DateTime

msdyn_TotalRecords

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

msdyn_TriggerType

Property Value
Description
DisplayName Trigger type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_triggertype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_TriggerType Choices/Options

Value Label Description
0 Manual
1 Scheduled

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

statecode

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

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 0 Active
1 Inactive 2 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

statuscode Choices/Options

Value Label State
0 In Progress 0
1 Succeeded 1
2 Failed 1
3 Skipped 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

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

OrganizationId

Added by: Active Solution Solution

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

OrganizationIdName

Added by: Active Solution Solution

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

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_segment_msdyn_saruninstance

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

Dataverse table/entity reference
Web API Reference