retentionoperationdetail table/entity reference (Microsoft Dataverse)

2025-10-31

Table level details of retention execution.

Messages

The following table lists the messages for the retentionoperationdetail 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
`Create` Event: True	`POST` /retentionoperationdetails See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /retentionoperationdetails(retentionoperationdetailid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`Retrieve` Event: True	`GET` /retentionoperationdetails(retentionoperationdetailid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /retentionoperationdetails See Query data	Query data
`SetState` Event: True	`PATCH` /retentionoperationdetails(retentionoperationdetailid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /retentionoperationdetails(retentionoperationdetailid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /retentionoperationdetails(retentionoperationdetailid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest

Properties

The following table lists selected properties for the retentionoperationdetail table.

Property	Value
DisplayName	RetentionOperationDetail
DisplayCollectionName	RetentionOperationDetail
SchemaName	`retentionoperationdetail`
CollectionSchemaName	`retentionoperationdetails`
EntitySetName	`retentionoperationdetails`
LogicalName	`retentionoperationdetail`
LogicalCollectionName	`retentionoperationdetails`
PrimaryIdAttribute	`retentionoperationdetailid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

EntityLogicalName
FailedCount
ImportSequenceNumber
IsRootEntity
Name
OverriddenCreatedOn
RetentionCount
retentionoperationdetailId
RetentionOperationId
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

FailedCount

Property	Value
Description	Total failed records.
DisplayName	FailedCount
IsValidForForm	True
IsValidForRead	True
LogicalName	`failedcount`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

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

IsRootEntity

Property	Value
Description	Is this a root table on which retention ran.
DisplayName	IsRootEntity
IsValidForForm	True
IsValidForRead	True
LogicalName	`isrootentity`
RequiredLevel	ApplicationRequired
Type	Boolean
GlobalChoiceName	`retentionoperationdetail_isrootentity`
DefaultValue	False
True Label	Yes
False Label	No

Name

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

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

RetentionCount

Property	Value
Description	Total retained records.
DisplayName	RetentionCount
IsValidForForm	True
IsValidForRead	True
LogicalName	`retentioncount`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

retentionoperationdetailId

Property	Value
Description	Unique identifier for entity instances
DisplayName	RetentionOperationDetailId
IsValidForForm	False
IsValidForRead	True
LogicalName	`retentionoperationdetailid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

RetentionOperationId

Property	Value
Description	Reference id of the retention operation.
DisplayName	RetentionOperationId
IsValidForForm	True
IsValidForRead	True
LogicalName	`retentionoperationid`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	retentionoperation

statecode

Property	Value
Description	Status of the retentionoperationdetail
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`retentionoperationdetail_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 retentionoperationdetail
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`retentionoperationdetail_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
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_retentionoperationdetail_createdby
lk_retentionoperationdetail_createdonbehalfby
lk_retentionoperationdetail_modifiedby
lk_retentionoperationdetail_modifiedonbehalfby
organization_retentionoperationdetail
retentionoperation_retentionopera

lk_retentionoperationdetail_createdby

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

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

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

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

organization_retentionoperationdetail

One-To-Many Relationship: organization organization_retentionoperationdetail

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`

retentionoperation_retentionopera

One-To-Many Relationship: retentionoperation retentionoperation_retentionopera

Property	Value
ReferencedEntity	`retentionoperation`
ReferencedAttribute	`retentionoperationid`
ReferencingAttribute	`retentionoperationid`
ReferencingEntityNavigationPropertyName	`RetentionOperationId`
IsHierarchical
CascadeConfiguration	Archive: `RemoveLink` Assign: `Cascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `Cascade` RollupView: `NoCascade` Share: `Cascade` Unshare: `Cascade`

One-to-Many relationships

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

retentionoperationdetail_AsyncOperations
retentionoperationdetail_BulkDeleteFailures
retentionoperationdetail_MailboxTrackingFolders
retentionoperationdetail_PrincipalObjectAttributeAccesses
retentionoperationdetail_ProcessSession
retentionoperationdetail_SyncErrors

retentionoperationdetail_AsyncOperations

Many-To-One Relationship: asyncoperation retentionoperationdetail_AsyncOperations

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

retentionoperationdetail_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure retentionoperationdetail_BulkDeleteFailures

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

retentionoperationdetail_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder retentionoperationdetail_MailboxTrackingFolders

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

retentionoperationdetail_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess retentionoperationdetail_PrincipalObjectAttributeAccesses

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

retentionoperationdetail_ProcessSession

Many-To-One Relationship: processsession retentionoperationdetail_ProcessSession

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

retentionoperationdetail_SyncErrors

Many-To-One Relationship: syncerror retentionoperationdetail_SyncErrors

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

Feedback

Was this page helpful?