StagedEntity table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Stores staged entity metadata to be processed before fully created.
Added by: Metadata Extension Solution
Messages
| Message | Web API Operation | SDK class or method |
|---|---|---|
| Create | POST /stagedentities See Create |
CreateRequest or Create |
| Delete | DELETE /stagedentities(stagedentityid) See Delete |
DeleteRequest or Delete |
| Retrieve | GET /stagedentities(stagedentityid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET /stagedentities See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| Update | PATCH /stagedentities(stagedentityid) See Update |
UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | StagedEntities |
| DisplayCollectionName | Staged Entities |
| DisplayName | Staged Entity |
| EntitySetName | stagedentities |
| IsBPFEntity | False |
| LogicalCollectionName | stagedentities |
| LogicalName | stagedentity |
| OwnershipType | None |
| PrimaryIdAttribute | stagedentityid |
| PrimaryNameAttribute | name |
| SchemaName | StagedEntity |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CollectionName
- DataproviderId
- DatasourceId
- EntityDescription
- EntitySetName
- ExternalCollectionName
- ExternalName
- ImportSequenceNumber
- LogicalCollectionName
- LogicalName
- Name
- OriginalLocalizedCollectionName
- OriginalLocalizedDescription
- OriginalLocalizedName
- OverriddenCreatedOn
- PhysicalName
- StagedEntityId
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
CollectionName
| Property | Value |
|---|---|
| Description | The collection name of the staged entity. |
| DisplayName | Collection Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | collectionname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
DataproviderId
| Property | Value |
|---|---|
| Description | The ID of the data provider for virtual entity. |
| DisplayName | Dataprovider ID |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | dataproviderid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
DatasourceId
| Property | Value |
|---|---|
| Description | The ID of the data source for virtual entity. |
| DisplayName | Datasource ID |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | datasourceid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
EntityDescription
| Property | Value |
|---|---|
| Description | The entity decription with properties for delta update |
| DisplayName | EntityDescription |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | entitydescription |
| MaxLength | 8000 |
| RequiredLevel | None |
| Type | Memo |
EntitySetName
| Property | Value |
|---|---|
| Description | The entity set name of the staged entity. |
| DisplayName | Entity Set Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | entitysetname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
ExternalCollectionName
| Property | Value |
|---|---|
| Description | The external collection name of the staged entity for VT scenario. |
| DisplayName | External Collection Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | externalcollectionname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
ExternalName
| Property | Value |
|---|---|
| Description | The external name for virtual entity. |
| DisplayName | ExternalName |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | externalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Sequence number of the import that created this record. |
| DisplayName | Import Sequence Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | importsequencenumber |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
LogicalCollectionName
| Property | Value |
|---|---|
| Description | The logical collection name of the staged entity. |
| DisplayName | Logical Collection Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | logicalcollectionname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
LogicalName
| Property | Value |
|---|---|
| Description | The logical name of the staged entity. |
| DisplayName | Logical Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | logicalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
Name
| Property | Value |
|---|---|
| Description | The name of the staged entity. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
OriginalLocalizedCollectionName
| Property | Value |
|---|---|
| Description | The original localized collection name of the staged entity. |
| DisplayName | Original Localized Collection Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | originallocalizedcollectioname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
OriginalLocalizedDescription
| Property | Value |
|---|---|
| Description | The localized description of the entity. |
| DisplayName | OriginalLocalizedDescription |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | originallocalizedescription |
| MaxLength | 8000 |
| RequiredLevel | None |
| Type | Memo |
OriginalLocalizedName
| Property | Value |
|---|---|
| Description | The original localized name of the staged entity. |
| DisplayName | Original Localized Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | originallocalizedname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
OverriddenCreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time that the record was migrated. |
| DisplayName | Record Created On |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
PhysicalName
| Property | Value |
|---|---|
| Description | The physical name of the staged entity. |
| DisplayName | Physical Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | physicalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
StagedEntityId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Entity identifier |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | stagedentityid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
statecode
| Property | Value |
|---|---|
| Description | Status of the Staged Entity |
| DisplayName | Status |
| IsValidForCreate | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
statecode Choices/Options
| Value | Label | DefaultStatus | InvariantName |
|---|---|---|---|
| 0 | Active | 1 | Active |
| 1 | Inactive | 2 | Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the Staged Entity |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
statuscode Choices/Options
| Value | Label | State |
|---|---|---|
| 1 | Active | 0 |
| 2 | Inactive | 1 |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- VersionNumber
CreatedBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who created the record. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedOnBehalfByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ModifiedBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was modified. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who modified the record. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedOnBehalfByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
VersionNumber
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- stagedentity_SyncErrors
- stagedentity_AsyncOperations
- stagedentity_MailboxTrackingFolders
- stagedentity_ProcessSession
- stagedentity_BulkDeleteFailures
- stagedentity_PrincipalObjectAttributeAccesses
stagedentity_SyncErrors
Added by: System Solution Solution
Same as the stagedentity_SyncErrors many-to-one relationship for the syncerror table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | stagedentity_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
stagedentity_AsyncOperations
Added by: System Solution Solution
Same as the stagedentity_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | stagedentity_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
stagedentity_MailboxTrackingFolders
Added by: System Solution Solution
Same as the stagedentity_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | stagedentity_MailboxTrackingFolders |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
stagedentity_ProcessSession
Added by: System Solution Solution
Same as the stagedentity_ProcessSession many-to-one relationship for the processsession table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | stagedentity_ProcessSession |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
stagedentity_BulkDeleteFailures
Added by: System Solution Solution
Same as the stagedentity_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | stagedentity_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
stagedentity_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the stagedentity_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | stagedentity_PrincipalObjectAttributeAccesses |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.
- lk_stagedentity_createdby
- lk_stagedentity_createdonbehalfby
- lk_stagedentity_modifiedby
- lk_stagedentity_modifiedonbehalfby
lk_stagedentity_createdby
Added by: System Solution Solution
See the lk_stagedentity_createdby one-to-many relationship for the systemuser table/entity.
lk_stagedentity_createdonbehalfby
Added by: System Solution Solution
See the lk_stagedentity_createdonbehalfby one-to-many relationship for the systemuser table/entity.
lk_stagedentity_modifiedby
Added by: System Solution Solution
See the lk_stagedentity_modifiedby one-to-many relationship for the systemuser table/entity.
lk_stagedentity_modifiedonbehalfby
Added by: System Solution Solution
See the lk_stagedentity_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
See also
Dataverse table/entity reference
Web API Reference
stagedentity EntityType
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for