Recycle Bin Configuration (RecycleBinConfig) table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Holds recyclebin configuration for entities
Added by: RecycleBin Base Components 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 /recyclebinconfigs See Create |
CreateRequest or Create |
| CreateMultiple | CreateMultiple | CreateMultipleRequest |
| Delete | DELETE /recyclebinconfigs(recyclebinconfigid) 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 /recyclebinconfigs(recyclebinconfigid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET /recyclebinconfigs 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 /recyclebinconfigs(recyclebinconfigid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH /recyclebinconfigs(recyclebinconfigid) 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 | RecycleBinConfigs |
| DisplayCollectionName | Recycle Bin Configurations |
| DisplayName | Recycle Bin Configuration |
| EntitySetName | recyclebinconfigs |
| IsBPFEntity | False |
| LogicalCollectionName | recyclebinconfigs |
| LogicalName | recyclebinconfig |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | recyclebinconfigid |
| PrimaryNameAttribute | name |
| SchemaName | RecycleBinConfig |
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 |
| Format | None |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | cleanupintervalindays |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
ExtensionOfRecordId
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | The metadata for RecycleBin. |
| DisplayName | Metadata For RecycleBin |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | extensionofrecordid |
| RequiredLevel | SystemRequired |
| Targets | entity |
| Type | Lookup |
ImportSequenceNumber
Added by: Basic Solution Solution
| 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 |
IsCustomizable
Added by: Basic Solution Solution
| 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 for recycle bin. |
| DisplayName | Is ready for recycle bin. |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | isreadyforrecyclebin |
| RequiredLevel | None |
| Type | Boolean |
IsReadyForRecycleBin Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
Name
| Property | Value |
|---|---|
| Description | The name of the settings. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
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 |
RecycleBinConfigId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | RecycleBinConfigId |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | recyclebinconfigid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
statecode
| Property | Value |
|---|---|
| Description | Status of the Recycle Bin Configuration |
| DisplayName | Status |
| IsValidForCreate | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
statecode Choices/Options
| Value | Label | DefaultStatus | InvariantName |
|---|---|---|---|
| 0 | Active | 1 | Active |
| 1 | Inactive | 2 | Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the Recycle Bin Configuration |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
statuscode Choices/Options
| Value | Label | State |
|---|---|---|
| 1 | Active | 0 |
| 2 | Inactive | 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.
- BinTableName
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ExtensionOfRecordIdName
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
BinTableName
| Property | Value |
|---|---|
| Description | The name of the Table storing deleted records. |
| DisplayName | Bin Table Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | bintablename |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ComponentIdUnique
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
ComponentState Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Published | |
| 1 | Unpublished | |
| 2 | Deleted | |
| 3 | Deleted Unpublished |
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 |
ExtensionOfRecordIdName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | extensionofrecordidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
IsManaged
Added by: Basic Solution Solution
| 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 |
IsManaged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Managed | |
| 0 | Unmanaged |
DefaultValue: 0
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 |
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 |
OverwriteTime
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
SolutionId
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
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 |
One-To-Many Relationships
Listed by SchemaName.
- recyclebinconfig_SyncErrors
- recyclebinconfig_AsyncOperations
- recyclebinconfig_MailboxTrackingFolders
- recyclebinconfig_ProcessSession
- recyclebinconfig_BulkDeleteFailures
- recyclebinconfig_PrincipalObjectAttributeAccesses
recyclebinconfig_SyncErrors
Added by: System Solution Solution
Same as the recyclebinconfig_SyncErrors many-to-one relationship for the syncerror table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recyclebinconfig_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recyclebinconfig_AsyncOperations
Added by: System Solution Solution
Same as the recyclebinconfig_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recyclebinconfig_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recyclebinconfig_MailboxTrackingFolders
Added by: System Solution Solution
Same as the recyclebinconfig_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recyclebinconfig_MailboxTrackingFolders |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recyclebinconfig_ProcessSession
Added by: System Solution Solution
Same as the recyclebinconfig_ProcessSession many-to-one relationship for the processsession table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recyclebinconfig_ProcessSession |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recyclebinconfig_BulkDeleteFailures
Added by: System Solution Solution
Same as the recyclebinconfig_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recyclebinconfig_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recyclebinconfig_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the recyclebinconfig_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recyclebinconfig_PrincipalObjectAttributeAccesses |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
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.
- lk_recyclebinconfig_createdby
- lk_recyclebinconfig_createdonbehalfby
- lk_recyclebinconfig_modifiedby
- lk_recyclebinconfig_modifiedonbehalfby
- organization_recyclebinconfig
- recyclebinconfig_extensionofrecordid
lk_recyclebinconfig_createdby
Added by: System Solution Solution
See the lk_recyclebinconfig_createdby one-to-many relationship for the systemuser table/entity.
lk_recyclebinconfig_createdonbehalfby
Added by: System Solution Solution
See the lk_recyclebinconfig_createdonbehalfby one-to-many relationship for the systemuser table/entity.
lk_recyclebinconfig_modifiedby
Added by: System Solution Solution
See the lk_recyclebinconfig_modifiedby one-to-many relationship for the systemuser table/entity.
lk_recyclebinconfig_modifiedonbehalfby
Added by: System Solution Solution
See the lk_recyclebinconfig_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
organization_recyclebinconfig
Added by: System Solution Solution
See the organization_recyclebinconfig one-to-many relationship for the organization table/entity.
recyclebinconfig_extensionofrecordid
Added by: System Solution Solution
See the recyclebinconfig_extensionofrecordid one-to-many relationship for the entity table/entity.
See also
Dataverse table/entity reference
Web API Reference
recyclebinconfig EntityType
피드백
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요. https://aka.ms/ContentUserFeedback
다음에 대한 사용자 의견 제출 및 보기