retentionsuccessdetail table/entity reference (Microsoft Dataverse)

Retention Success details.

Messages

The following table lists the messages for the retentionsuccessdetail 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
Assign Event: True	PATCH /retentionsuccessdetails(retentionsuccessdetailid) Update the ownerid property.	AssignRequest
Associate Event: True	Associate records	Associate records
Create Event: True	POST /retentionsuccessdetails See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /retentionsuccessdetails(retentionsuccessdetailid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
GrantAccess Event: True	GrantAccess	GrantAccessRequest
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
ModifyAccess Event: True	ModifyAccess	ModifyAccessRequest
Retrieve Event: True	GET /retentionsuccessdetails(retentionsuccessdetailid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /retentionsuccessdetails See Query data	Query data
RetrievePrincipalAccess Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess Event: True	RevokeAccess	RevokeAccessRequest
SetState Event: True	PATCH /retentionsuccessdetails(retentionsuccessdetailid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /retentionsuccessdetails(retentionsuccessdetailid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /retentionsuccessdetails(retentionsuccessdetailid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the retentionsuccessdetail table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
BulkRetain	BulkRetain	Learn to use messages with the SDK for .NET
PurgeRetainedContent	PurgeRetainedContent	Learn to use messages with the SDK for .NET
Retain	Retain	Learn to use messages with the SDK for .NET
RollbackRetain	RollbackRetain	Learn to use messages with the SDK for .NET
ValidateRetentionConfig	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the retentionsuccessdetail table.

Property	Value
DisplayName	RetentionSuccessDetail
DisplayCollectionName	RetentionSuccessDetail
SchemaName	retentionsuccessdetail
CollectionSchemaName	retentionsuccessdetails
EntitySetName	retentionsuccessdetails
LogicalName	retentionsuccessdetail
LogicalCollectionName	retentionsuccessdetails
PrimaryIdAttribute	retentionsuccessdetailid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	UserOwned

Writable columns/attributes

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

• EntityLogicalName
• ImportSequenceNumber
• Name
• OperationId
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• RecordId
• retentionsuccessdetailId
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

EntityLogicalName

Property	Value
Description	Table logical name
DisplayName	EntityLogicalName
IsValidForForm	True
IsValidForRead	True
LogicalName	entitylogicalname
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

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

Name

Property	Value
Description	The name of the success detail.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OperationId

Property	Value
Description	Unique Id to denote the operation instance.
DisplayName	OperationId
IsValidForForm	True
IsValidForRead	True
LogicalName	operationid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	72

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

OwnerId

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

OwnerIdType

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

RecordId

Property	Value
Description	Id of the failed record.
DisplayName	RecordId
IsValidForForm	True
IsValidForRead	True
LogicalName	recordid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	72

retentionsuccessdetailId

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

statecode

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

statecode Choices/Options

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

statuscode

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

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 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
• msft_DataState
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• 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

msft_DataState

Property	Value
Description
DisplayName	msft_DataState
IsValidForForm	True
IsValidForRead	True
LogicalName	msft_datastate
RequiredLevel	None
Type	Picklist
DefaultFormValue
GlobalChoiceName	msft_datastate

msft_DataState Choices/Options

Value	Label
0	Default
1	Retain

OwnerIdName

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

OwnerIdYomiName

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

OwningBusinessUnit

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

OwningTeam

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

OwningUser

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

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.

• business_unit_retentionsuccessdetail
• lk_retentionsuccessdetail_createdby
• lk_retentionsuccessdetail_createdonbehalfby
• lk_retentionsuccessdetail_modifiedby
• lk_retentionsuccessdetail_modifiedonbehalfby
• owner_retentionsuccessdetail
• team_retentionsuccessdetail
• user_retentionsuccessdetail

business_unit_retentionsuccessdetail

One-To-Many Relationship: businessunit business_unit_retentionsuccessdetail

Property	Value
ReferencedEntity	businessunit
ReferencedAttribute	businessunitid
ReferencingAttribute	owningbusinessunit
ReferencingEntityNavigationPropertyName	owningbusinessunit
IsHierarchical
CascadeConfiguration	Archive: Restrict Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_retentionsuccessdetail_createdby

One-To-Many Relationship: systemuser lk_retentionsuccessdetail_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_retentionsuccessdetail_createdonbehalfby

One-To-Many Relationship: systemuser lk_retentionsuccessdetail_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_retentionsuccessdetail_modifiedby

One-To-Many Relationship: systemuser lk_retentionsuccessdetail_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_retentionsuccessdetail_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_retentionsuccessdetail_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

owner_retentionsuccessdetail

One-To-Many Relationship: owner owner_retentionsuccessdetail

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

team_retentionsuccessdetail

One-To-Many Relationship: team team_retentionsuccessdetail

Property	Value
ReferencedEntity	team
ReferencedAttribute	teamid
ReferencingAttribute	owningteam
ReferencingEntityNavigationPropertyName	owningteam
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

user_retentionsuccessdetail

One-To-Many Relationship: systemuser user_retentionsuccessdetail

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	owninguser
ReferencingEntityNavigationPropertyName	owninguser
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.

• retentionsuccessdetail_AsyncOperations
• retentionsuccessdetail_BulkDeleteFailures
• retentionsuccessdetail_DuplicateBaseRecord
• retentionsuccessdetail_DuplicateMatchingRecord
• retentionsuccessdetail_MailboxTrackingFolders
• retentionsuccessdetail_PrincipalObjectAttributeAccesses
• retentionsuccessdetail_ProcessSession
• retentionsuccessdetail_SyncErrors

retentionsuccessdetail_AsyncOperations

Many-To-One Relationship: asyncoperation retentionsuccessdetail_AsyncOperations

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

retentionsuccessdetail_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure retentionsuccessdetail_BulkDeleteFailures

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

retentionsuccessdetail_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord retentionsuccessdetail_DuplicateBaseRecord

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

retentionsuccessdetail_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord retentionsuccessdetail_DuplicateMatchingRecord

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

retentionsuccessdetail_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder retentionsuccessdetail_MailboxTrackingFolders

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

retentionsuccessdetail_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess retentionsuccessdetail_PrincipalObjectAttributeAccesses

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

retentionsuccessdetail_ProcessSession

Many-To-One Relationship: processsession retentionsuccessdetail_ProcessSession

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

retentionsuccessdetail_SyncErrors

Many-To-One Relationship: syncerror retentionsuccessdetail_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	retentionsuccessdetail_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
retentionsuccessdetail