retaineddataexcel EntityType

A Place holder entity to save excel file for each exportretaineddata custom api requests.

Entity Set Path
[organization URI]/api/data/v9.2/retaineddataexcels
Base Type
crmbaseentity
Display Name
RetainedData Excel
Primary Key
retaineddataexcelid
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
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
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
excelcontent Edm.Binary

Display Name: ExcelContent

Read Only
excelcontent_name Edm.String
Read Only
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
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

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
retaineddataexcelid Edm.Guid

Unique identifier for entity instances

Display Name: RetainedData Excel

solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the RetainedData Excel

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the RetainedData Excel

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
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_retaineddataexcel_createdby
createdonbehalfby systemuser lk_retaineddataexcel_createdonbehalfby
modifiedby systemuser lk_retaineddataexcel_modifiedby
modifiedonbehalfby systemuser lk_retaineddataexcel_modifiedonbehalfby
ownerid principal owner_retaineddataexcel
owningbusinessunit businessunit business_unit_retaineddataexcel
owningteam team team_retaineddataexcel
owninguser systemuser user_retaineddataexcel

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
retaineddataexcel_AsyncOperations asyncoperation regardingobjectid_retaineddataexcel
retaineddataexcel_BulkDeleteFailures bulkdeletefailure regardingobjectid_retaineddataexcel
retaineddataexcel_DuplicateBaseRecord duplicaterecord baserecordid_retaineddataexcel
retaineddataexcel_DuplicateMatchingRecord duplicaterecord duplicaterecordid_retaineddataexcel
retaineddataexcel_FileAttachments fileattachment objectid_retaineddataexcel
retaineddataexcel_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_retaineddataexcel
retaineddataexcel_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_retaineddataexcel
retaineddataexcel_ProcessSession processsession regardingobjectid_retaineddataexcel
retaineddataexcel_SyncErrors syncerror regardingobjectid_retaineddataexcel

Operations

The following operations can be used with the retaineddataexcel 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

See also