stagedentity EntityType
Stores staged entity metadata to be processed before fully created.
- Entity set path:
- [organization URI]/api/data/v9.2/stagedentities
- Base type:
- crmbaseentity
- Display name:
- Staged Entity
- Primary key:
- stagedentityid
- 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| collectionname | Edm.String |
The collection name of the staged entity. Display name: Collection Name |
||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||
| dataproviderid | Edm.Guid |
The ID of the data provider for virtual entity. Display name: Dataprovider ID |
||||||
| datasourceid | Edm.Guid |
The ID of the data source for virtual entity. Display name: Datasource ID |
||||||
| entitydescription | Edm.String |
The entity decription with properties for delta update Display name: EntityDescription |
||||||
| entitysetname | Edm.String |
The entity set name of the staged entity. Display name: Entity Set Name |
||||||
| externalcollectionname | Edm.String |
The external collection name of the staged entity for VT scenario. Display name: External Collection Name |
||||||
| externalname | Edm.String |
The external name for virtual entity. Display name: ExternalName |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| logicalcollectionname | Edm.String |
The logical collection name of the staged entity. Display name: Logical Collection Name |
||||||
| logicalname | Edm.String |
The logical name of the staged entity. Display name: Logical Name |
||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||
| name | Edm.String |
The name of the staged entity. Display name: Name |
||||||
| originallocalizedcollectioname | Edm.String |
The original localized collection name of the staged entity. Display name: Original Localized Collection Name |
||||||
| originallocalizedescription | Edm.String |
The localized description of the entity. Display name: OriginalLocalizedDescription |
||||||
| originallocalizedname | Edm.String |
The original localized name of the staged entity. Display name: Original Localized Name |
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||
| physicalname | Edm.String |
The physical name of the staged entity. Display name: Physical Name |
||||||
| stagedentityid | Edm.Guid |
Unique identifier for entity instances Display name: Entity identifier |
||||||
| statecode | Edm.Int32 |
Status of the Staged Entity Display name: Status
Default options
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the Staged Entity 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. |
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_stagedentity_createdby |
| createdonbehalfby | systemuser | lk_stagedentity_createdonbehalfby |
| modifiedby | systemuser | lk_stagedentity_modifiedby |
| modifiedonbehalfby | systemuser | lk_stagedentity_modifiedonbehalfby |
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 |
|---|---|---|
| stagedentity_AsyncOperations | asyncoperation | regardingobjectid_stagedentity |
| stagedentity_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_stagedentity |
| stagedentity_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_stagedentity |
| stagedentity_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_stagedentity |
| stagedentity_ProcessSession | processsession | regardingobjectid_stagedentity |
| stagedentity_SyncErrors | syncerror | regardingobjectid_stagedentity |