retentionconfig EntityType
Holds retention policies for a table.
- Entity Set Path
- [organization URI]/api/data/v9.2/retentionconfigs
- Base Type
- crmbaseentity
- Display Name
- RetentionConfig
- Primary Key
- retentionconfigid
- 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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
asyncoperationid | Edm.String |
For internal use only. Tracks the status of Retention Policy Execution Display Name: AsyncOperationId |
||||||||||||
componentidunique | Edm.Guid |
For internal use only. Display Name: Row id unique Read Only
|
||||||||||||
componentstate | Edm.Int32 |
For internal use only. Display Name: Component State Read Only
Default Options
|
||||||||||||
createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||||
criteria | Edm.String |
Fetch XML format criteria to select records for retention. Display Name: Criteria |
||||||||||||
entitylogicalname | Edm.String |
Logical name of the table on which retention policy is setup. Display Name: EntityLogicalName |
||||||||||||
importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||||||||
iscustomizable | BooleanManagedProperty |
For internal use only. Display Name: Is Customizable |
||||||||||||
ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display Name: Is Managed Read Only
Default Options
|
||||||||||||
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 policy. Display Name: Name |
||||||||||||
nextrun | Edm.DateTimeOffset |
Date and time when retention policy will execute next. Display Name: NextRun |
||||||||||||
overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display Name: Record Created On |
||||||||||||
overwritetime | Edm.DateTimeOffset |
For internal use only. Display Name: Record Overwrite Time Read Only
|
||||||||||||
recurrence | Edm.String |
Frequency at which retention should run. Display Name: Recurrence |
||||||||||||
referenceconfigid | Edm.String |
For internal use only. Display Name: ReferenceConfigId |
||||||||||||
retentionconfigid | Edm.Guid |
Unique identifier for retention config. Display Name: RetentionConfig |
||||||||||||
solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||||
starttime | Edm.DateTimeOffset |
Date and time at when retention should execute. Display Name: StartTime |
||||||||||||
statecode | Edm.Int32 |
State of the Retention Config Display Name: State
Default Options
|
||||||||||||
statuscode | Edm.Int32 |
Reason for the status of the RetentionConfig Display Name: Status Reason
Default Options
|
||||||||||||
timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||||
uniquename | Edm.String |
Unique Name for the retention policy. Display Name: Unique Name |
||||||||||||
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
|
||||||||||||
viewid | Edm.String |
Reference view id of the criteria. Display Name: viewid |
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. |
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_retentionconfig_createdby |
createdonbehalfby | systemuser | lk_retentionconfig_createdonbehalfby |
modifiedby | systemuser | lk_retentionconfig_modifiedby |
modifiedonbehalfby | systemuser | lk_retentionconfig_modifiedonbehalfby |
ownerid | principal | owner_retentionconfig |
owningbusinessunit | businessunit | business_unit_retentionconfig |
owningteam | team | team_retentionconfig |
owninguser | systemuser | user_retentionconfig |
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 |
---|---|---|
retentionconfig_AsyncOperations | asyncoperation | regardingobjectid_retentionconfig |
retentionconfig_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_retentionconfig |
retentionconfig_DuplicateBaseRecord | duplicaterecord | baserecordid_retentionconfig |
retentionconfig_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_retentionconfig |
retentionconfig_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_retentionconfig |
retentionconfig_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_retentionconfig |
retentionconfig_ProcessSession | processsession | regardingobjectid_retentionconfig |
retentionconfig_retentionoperatio | retentionoperation | retentionconfigid |
retentionconfig_SyncErrors | syncerror | regardingobjectid_retentionconfig |
Operations
The following operations can be used with the retentionconfig 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 |