retentionoperation EntityType
Retention policy execution details.
- Entity Set Path
- [organization URI]/api/data/v9.2/retentionoperations
- Base Type
- crmbaseentity
- Display Name
- RetentionOperation
- Primary Key
- retentionoperationid
- Primary Key Attribute
- name
- Operations Supported
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity.Some properties are read-only.
| Name | Type | Details | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| additionaldetails | Edm.String |
Addintional details. Display Name: AdditionalDetails |
||||||||||||||||
| asyncoperationid | Edm.String |
For internal use only. Display Name: AsyncOperationId |
||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||||||||
| criteria | Edm.String |
Fetch XML format criteria used to select records for retention. Display Name: Criteria |
||||||||||||||||
| endtime | Edm.DateTimeOffset |
Endtime of the retention operation. Display Name: EndTime |
||||||||||||||||
| failedcount | Edm.Int32 |
Total failed records. Display Name: FailedCount |
||||||||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||||||||||||
| lastmarkedversionnumber | Edm.Int64 |
Last marked version number of the retained records. Display Name: LastMarkedVersionNumber |
||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display Name: Modified On Read Only
|
||||||||||||||||
| name | Edm.String |
The name of the retention operation. Display Name: Name |
||||||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display Name: Record Created On |
||||||||||||||||
| pagingcookie | Edm.String |
Pagination criteria to process next page records. Display Name: PagingCookie |
||||||||||||||||
| retentioncount | Edm.Int32 |
Total retained records. Display Name: RetentionCount |
||||||||||||||||
| retentionoperationid | Edm.Guid |
Unique identifier for execution instance. Display Name: RetentionOperationId |
||||||||||||||||
| rootentitylogicalname | Edm.String |
Table name on which retention was executed. Display Name: RootEntityLogicalName |
||||||||||||||||
| starttime | Edm.DateTimeOffset |
Start time of the retention operation. Display Name: StartTime |
||||||||||||||||
| statecode | Edm.Int32 |
Status of the retentionoperation Display Name: Status
Default Options
|
||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the retentionoperation Display Name: Status Reason
Default Options
|
||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
||||||||||||||||
| versionnumber | Edm.Int64 |
Version Number Display Name: Version Number Read Only
|
Lookup Properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
| _retentionconfigid_value | retentionconfigid |
Identifier for retention config. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_retentionoperation_createdby |
| createdonbehalfby | systemuser | lk_retentionoperation_createdonbehalfby |
| modifiedby | systemuser | lk_retentionoperation_modifiedby |
| modifiedonbehalfby | systemuser | lk_retentionoperation_modifiedonbehalfby |
| ownerid | principal | owner_retentionoperation |
| owningbusinessunit | businessunit | business_unit_retentionoperation |
| owningteam | team | team_retentionoperation |
| owninguser | systemuser | user_retentionoperation |
| retentionconfigid | retentionconfig | retentionconfig_retentionoperatio |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| retentionoperation_AsyncOperations | asyncoperation | regardingobjectid_retentionoperation |
| retentionoperation_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_retentionoperation |
| retentionoperation_DuplicateBaseRecord | duplicaterecord | baserecordid_retentionoperation |
| retentionoperation_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_retentionoperation |
| retentionoperation_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_retentionoperation |
| retentionoperation_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_retentionoperation |
| retentionoperation_ProcessSession | processsession | regardingobjectid_retentionoperation |
| retentionoperation_retentionopera | retentionoperationdetail | RetentionOperationId |
| retentionoperation_SyncErrors | syncerror | regardingobjectid_retentionoperation |
Operations
The following operations can be used with the retentionoperation entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |