Restore Deleted Records Configuration (RecycleBinConfig) table/entity reference

Holds Restore Deleted Records configuration for entities

Messages

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

Events

The following table lists the events for the Restore Deleted Records Configuration (RecycleBinConfig) 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 Restore Deleted Records Configuration (RecycleBinConfig) table.

Property	Value
DisplayName	Restore Deleted Records Configuration
DisplayCollectionName	Restore Deleted Records Configurations
SchemaName	RecycleBinConfig
CollectionSchemaName	RecycleBinConfigs
EntitySetName	recyclebinconfigs
LogicalName	recyclebinconfig
LogicalCollectionName	recyclebinconfigs
PrimaryIdAttribute	recyclebinconfigid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

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

• CleanupIntervalInDays
• ExtensionOfRecordId
• ImportSequenceNumber
• IsCustomizable
• IsReadyForRecycleBin
• Name
• OverriddenCreatedOn
• RecycleBinConfigId
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

CleanupIntervalInDays

Property	Value
Description	Cleanup Interval In Days
DisplayName	Cleanup Interval In Days
IsValidForForm	True
IsValidForRead	True
LogicalName	cleanupintervalindays
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

ExtensionOfRecordId

Property	Value
Description	The metadata for Entity.
DisplayName	Metadata For Entity
IsValidForForm	True
IsValidForRead	True
LogicalName	extensionofrecordid
RequiredLevel	SystemRequired
Type	Lookup
Targets	entity

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

IsCustomizable

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

IsReadyForRecycleBin

Property	Value
Description	Is Ready (Create Synchronously).
DisplayName	Is Ready (Create Synchronously).
IsValidForForm	True
IsValidForRead	True
LogicalName	isreadyforrecyclebin
RequiredLevel	None
Type	Boolean
GlobalChoiceName	recyclebinconfig_isreadyforrecyclebin
DefaultValue	False
True Label	Yes
False Label	No

Name

Property	Value
Description	The name of the settings.
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

RecycleBinConfigId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Restore Deleted Records Configuration
IsValidForForm	False
IsValidForRead	True
LogicalName	recyclebinconfigid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

statecode

Property	Value
Description	Status of the Restore Deleted Records Configuration
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	recyclebinconfig_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 Restore Deleted Records Configuration
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	recyclebinconfig_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.

• BinTableName
• ComponentIdUnique
• ComponentState
• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• IsManaged
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• OverwriteTime
• SolutionId
• SupportingSolutionId
• VersionNumber

BinTableName

Property	Value
Description	The name of the Table storing deleted records.
DisplayName	Bin Table Name
IsValidForForm	True
IsValidForRead	True
LogicalName	bintablename
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

ComponentIdUnique

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	componentidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	componentstate

ComponentState Choices/Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

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

IsManaged

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	ismanaged
DefaultValue	False
True Label	Managed
False Label	Unmanaged

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

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

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_recyclebinconfig_createdby
• lk_recyclebinconfig_createdonbehalfby
• lk_recyclebinconfig_modifiedby
• lk_recyclebinconfig_modifiedonbehalfby
• organization_recyclebinconfig
• recyclebinconfig_extensionofrecordid

lk_recyclebinconfig_createdby

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

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

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

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

One-To-Many Relationship: organization organization_recyclebinconfig

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

recyclebinconfig_extensionofrecordid

One-To-Many Relationship: entity recyclebinconfig_extensionofrecordid

Property	Value
ReferencedEntity	entity
ReferencedAttribute	entityid
ReferencingAttribute	extensionofrecordid
ReferencingEntityNavigationPropertyName	extensionofrecordid
IsHierarchical
CascadeConfiguration	Archive: Cascade 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.

• recyclebinconfig_AsyncOperations
• recyclebinconfig_BulkDeleteFailures
• recyclebinconfig_MailboxTrackingFolders
• recyclebinconfig_PrincipalObjectAttributeAccesses
• recyclebinconfig_ProcessSession
• recyclebinconfig_SyncErrors

recyclebinconfig_AsyncOperations

Many-To-One Relationship: asyncoperation recyclebinconfig_AsyncOperations

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

recyclebinconfig_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure recyclebinconfig_BulkDeleteFailures

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

recyclebinconfig_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder recyclebinconfig_MailboxTrackingFolders

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

recyclebinconfig_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess recyclebinconfig_PrincipalObjectAttributeAccesses

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

recyclebinconfig_ProcessSession

Many-To-One Relationship: processsession recyclebinconfig_ProcessSession

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

recyclebinconfig_SyncErrors

Many-To-One Relationship: syncerror recyclebinconfig_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	recyclebinconfig_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
recyclebinconfig