Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retention policy execution details.
The following table lists the messages for the retentionoperation 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 /retentionoperations(retentionoperationid)Update the ownerid property. |
AssignRequest |
Associate Event: True |
Associate records | Associate records |
Create Event: True |
POST /retentionoperationsSee Create |
Create records |
CreateMultiple Event: True |
CreateMultiple | CreateMultipleRequest |
Delete Event: True |
DELETE /retentionoperations(retentionoperationid)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 /retentionoperations(retentionoperationid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: True |
GET /retentionoperationsSee Query data |
Query data |
RetrievePrincipalAccess Event: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccess Event: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccess Event: True |
RevokeAccess | RevokeAccessRequest |
SetState Event: True |
PATCH /retentionoperations(retentionoperationid)Update the statecode and statuscode properties. |
SetStateRequest |
Update Event: True |
PATCH /retentionoperations(retentionoperationid)See Update |
Update records |
UpdateMultiple Event: True |
UpdateMultiple | UpdateMultipleRequest |
Upsert Event: False |
PATCH /retentionoperations(retentionoperationid)See Upsert a table row |
UpsertRequest |
UpsertMultiple Event: False |
UpsertMultiple | UpsertMultipleRequest |
The following table lists selected properties for the retentionoperation table.
Property | Value |
---|---|
DisplayName | RetentionOperation |
DisplayCollectionName | RetentionOperation |
SchemaName | retentionoperation |
CollectionSchemaName | retentionoperations |
EntitySetName | retentionoperations |
LogicalName | retentionoperation |
LogicalCollectionName | retentionoperations |
PrimaryIdAttribute | retentionoperationid |
PrimaryNameAttribute | name |
TableType | Standard |
OwnershipType | UserOwned |
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
Property | Value |
---|---|
Description | Addintional details. |
DisplayName | AdditionalDetails |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | additionaldetails |
RequiredLevel | None |
Type | Memo |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 5000 |
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | AsyncOperationId |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | asyncoperationid |
RequiredLevel | None |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 72 |
Property | Value |
---|---|
Description | Fetch XML format criteria used to select records for retention. |
DisplayName | Criteria |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | criteria |
RequiredLevel | None |
Type | Memo |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 1048575 |
Property | Value |
---|---|
Description | Endtime of the retention operation. |
DisplayName | EndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | endtime |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | True |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Auto |
SourceTypeMask | 0 |
Property | Value |
---|---|
Description | Total failed records. |
DisplayName | FailedCount |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | failedcount |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | 0 |
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 |
Property | Value |
---|---|
Description | Last marked version number of the retained records. |
DisplayName | LastMarkedVersionNumber |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | lastmarkedversionnumber |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
Property | Value |
---|---|
Description | The name of the retention operation. |
DisplayName | Name |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | name |
RequiredLevel | None |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
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 |
Property | Value |
---|---|
Description | Owner Id |
DisplayName | Owner |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | ownerid |
RequiredLevel | SystemRequired |
Type | Owner |
Targets | systemuser, team |
Property | Value |
---|---|
Description | Owner Id Type |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridtype |
RequiredLevel | SystemRequired |
Type | EntityName |
Property | Value |
---|---|
Description | Pagination criteria to process next page records. |
DisplayName | PagingCookie |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | pagingcookie |
RequiredLevel | None |
Type | Memo |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 5000 |
Property | Value |
---|---|
Description | Identifier for retention config. |
DisplayName | RetentionConfigId |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | retentionconfigid |
RequiredLevel | ApplicationRequired |
Type | Lookup |
Targets | retentionconfig |
Property | Value |
---|---|
Description | Total retained records. |
DisplayName | RetentionCount |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | retentioncount |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | 0 |
Property | Value |
---|---|
Description | Unique identifier for execution instance. |
DisplayName | RetentionOperationId |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | retentionoperationid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Property | Value |
---|---|
Description | Table name on which retention was executed. |
DisplayName | RootEntityLogicalName |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | rootentitylogicalname |
RequiredLevel | ApplicationRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
Property | Value |
---|---|
Description | Start time of the retention operation. |
DisplayName | StartTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | starttime |
RequiredLevel | ApplicationRequired |
Type | DateTime |
CanChangeDateTimeBehavior | True |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Auto |
SourceTypeMask | 0 |
Property | Value |
---|---|
Description | Status of the retentionoperation |
DisplayName | Status |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
DefaultFormValue | |
GlobalChoiceName | retentionoperation_statecode |
Value | Details |
---|---|
0 | Label: Scheduled DefaultStatus: 1 InvariantName: Scheduled |
2 | Label: Inprogress DefaultStatus: 2 InvariantName: Inprogress |
3 | Label: Completed DefaultStatus: 3 InvariantName: Completed |
Property | Value |
---|---|
Description | Reason for the status of the retentionoperation |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
DefaultFormValue | |
GlobalChoiceName | retentionoperation_statuscode |
Value | Details |
---|---|
0 | Label: Waiting State:0 TransitionData: None |
20 | Label: Marking State:2 TransitionData: None |
21 | Label: Copying State:2 TransitionData: None |
22 | Label: Deleting State:2 TransitionData: None |
30 | Label: Succeeded State:3 TransitionData: None |
31 | Label: Failed State:3 TransitionData: None |
32 | Label: Cancelled State:3 TransitionData: None |
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 |
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 |
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Property | Value |
---|---|
Description | Version Number |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
These relationships are many-to-one. Listed by SchemaName.
One-To-Many Relationship: businessunit business_unit_retentionoperation
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 |
One-To-Many Relationship: systemuser lk_retentionoperation_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 |
One-To-Many Relationship: systemuser lk_retentionoperation_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 |
One-To-Many Relationship: systemuser lk_retentionoperation_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 |
One-To-Many Relationship: systemuser lk_retentionoperation_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 |
One-To-Many Relationship: owner owner_retentionoperation
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 |
One-To-Many Relationship: retentionconfig retentionconfig_retentionoperatio
Property | Value |
---|---|
ReferencedEntity | retentionconfig |
ReferencedAttribute | retentionconfigid |
ReferencingAttribute | retentionconfigid |
ReferencingEntityNavigationPropertyName | retentionconfigid |
IsHierarchical | |
CascadeConfiguration | Archive: RemoveLink Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
One-To-Many Relationship: team team_retentionoperation
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 |
One-To-Many Relationship: systemuser user_retentionoperation
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 |
These relationships are one-to-many. Listed by SchemaName.
Many-To-One Relationship: asyncoperation retentionoperation_AsyncOperations
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | retentionoperation_AsyncOperations |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: bulkdeletefailure retentionoperation_BulkDeleteFailures
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | retentionoperation_BulkDeleteFailures |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: duplicaterecord retentionoperation_DuplicateBaseRecord
Property | Value |
---|---|
ReferencingEntity | duplicaterecord |
ReferencingAttribute | baserecordid |
ReferencedEntityNavigationPropertyName | retentionoperation_DuplicateBaseRecord |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: duplicaterecord retentionoperation_DuplicateMatchingRecord
Property | Value |
---|---|
ReferencingEntity | duplicaterecord |
ReferencingAttribute | duplicaterecordid |
ReferencedEntityNavigationPropertyName | retentionoperation_DuplicateMatchingRecord |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: mailboxtrackingfolder retentionoperation_MailboxTrackingFolders
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | retentionoperation_MailboxTrackingFolders |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: principalobjectattributeaccess retentionoperation_PrincipalObjectAttributeAccesses
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
ReferencedEntityNavigationPropertyName | retentionoperation_PrincipalObjectAttributeAccesses |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: processsession retentionoperation_ProcessSession
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | retentionoperation_ProcessSession |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: retentionoperationdetail retentionoperation_retentionopera
Property | Value |
---|---|
ReferencingEntity | retentionoperationdetail |
ReferencingAttribute | retentionoperationid |
ReferencedEntityNavigationPropertyName | retentionoperation_retentionopera |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-To-One Relationship: syncerror retentionoperation_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | retentionoperation_SyncErrors |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Dataverse table/entity reference
Dataverse Web API Reference
retentionoperation
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign in