retentionsuccessdetail EntityType
Retention Success details.
- Entity set path:
- [organization URI]/api/data/v9.2/retentionsuccessdetails
- Base type:
- crmbaseentity
- Display name:
- RetentionSuccessDetail
- Primary key:
- retentionsuccessdetailid
- Primary name column:
- 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||
| entitylogicalname | Edm.String |
Table logical name Display name: EntityLogicalName |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||
| msft_datastate | Edm.Int32 |
Display name: msft_DataState Read only
Default options
|
||||||
| name | Edm.String |
The name of the success detail. Display name: Name |
||||||
| operationid | Edm.String |
Unique Id to denote the operation instance. Display name: OperationId |
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||
| recordid | Edm.String |
Id of the failed record. Display name: RecordId |
||||||
| retentionsuccessdetailid | Edm.Guid |
Unique identifier for entity instances Display name: RetentionSuccessDetailId |
||||||
| statecode | Edm.Int32 |
Status of the RetentionSuccessDetail Display name: Status
Default options
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the RetentionSuccessDetail 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. |
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_retentionsuccessdetail_createdby |
| createdonbehalfby | systemuser | lk_retentionsuccessdetail_createdonbehalfby |
| modifiedby | systemuser | lk_retentionsuccessdetail_modifiedby |
| modifiedonbehalfby | systemuser | lk_retentionsuccessdetail_modifiedonbehalfby |
| ownerid | principal | owner_retentionsuccessdetail |
| owningbusinessunit | businessunit | business_unit_retentionsuccessdetail |
| owningteam | team | team_retentionsuccessdetail |
| owninguser | systemuser | user_retentionsuccessdetail |
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 |
|---|---|---|
| retentionsuccessdetail_AsyncOperations | asyncoperation | regardingobjectid_retentionsuccessdetail |
| retentionsuccessdetail_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_retentionsuccessdetail |
| retentionsuccessdetail_DuplicateBaseRecord | duplicaterecord | baserecordid_retentionsuccessdetail |
| retentionsuccessdetail_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_retentionsuccessdetail |
| retentionsuccessdetail_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_retentionsuccessdetail |
| retentionsuccessdetail_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_retentionsuccessdetail |
| retentionsuccessdetail_ProcessSession | processsession | regardingobjectid_retentionsuccessdetail |
| retentionsuccessdetail_SyncErrors | syncerror | regardingobjectid_retentionsuccessdetail |
Operations
The following operations can be used with the retentionsuccessdetail entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |