Virtual Entity Metadata (VirtualEntityMetadata) table/entity reference

Holds metadata values for virtual entities

Messages

The following table lists the messages for the Virtual Entity Metadata (VirtualEntityMetadata) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Create
Event: True
POST /virtualentitymetadatas
See Create
Create records
CreateMultiple
Event: True
CreateMultiple CreateMultipleRequest
Delete
Event: True
DELETE /virtualentitymetadatas(virtualentitymetadataid)
See Delete
Delete records
IsValidStateTransition
Event: False
IsValidStateTransition IsValidStateTransitionRequest
Retrieve
Event: True
GET /virtualentitymetadatas(virtualentitymetadataid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /virtualentitymetadatas
See Query data
Query data
SetState
Event: True
PATCH /virtualentitymetadatas(virtualentitymetadataid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /virtualentitymetadatas(virtualentitymetadataid)
See Update
Update records
UpdateMultiple
Event: True
UpdateMultiple UpdateMultipleRequest
Upsert
Event: False
PATCH /virtualentitymetadatas(virtualentitymetadataid)
See Upsert a table row
UpsertRequest
UpsertMultiple
Event: False
UpsertMultiple UpsertMultipleRequest

Properties

The following table lists selected properties for the Virtual Entity Metadata (VirtualEntityMetadata) table.

Property Value
DisplayName Virtual Entity Metadata
DisplayCollectionName Virtual Entity Metadatas
SchemaName VirtualEntityMetadata
CollectionSchemaName VirtualEntityMetadatas
EntitySetName virtualentitymetadatas
LogicalName virtualentitymetadata
LogicalCollectionName virtualentitymetadatas
PrimaryIdAttribute virtualentitymetadataid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ExtensionOfRecordId

Property Value
Description The name of the virtual entity that these settings are for.
DisplayName Virtual Entity
IsValidForForm True
IsValidForRead True
LogicalName extensionofrecordid
RequiredLevel SystemRequired
Type Lookup
Targets entity

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsAttachmentsSupported

Property Value
Description Indicates if attachments are supported for the virtual entity
DisplayName Is Attachments Supported
IsValidForForm True
IsValidForRead True
LogicalName isattachmentssupported
RequiredLevel None
Type Boolean
GlobalChoiceName virtualentitymetadata_isattachmentssupported
DefaultValue False
True Label Yes
False Label No

IsChangedFieldsEnabledForUpdateEvent

Property Value
Description Whether the OnExternalUpdated message ChangedFields parameter will include data about which fields have changed.
DisplayName Includes data on changed fields for the update message
IsValidForForm True
IsValidForRead True
LogicalName ischangedfieldsenabledforupdateevent
RequiredLevel None
Type Boolean
GlobalChoiceName virtualentitymetadata_ischangedfieldsenabledforupdateevent
DefaultValue False
True Label Yes
False Label No

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsOnExternalCreatedEnabled

Property Value
Description Will enable a message to send information about new records created in the external data source.
DisplayName Enable external create message
IsValidForForm True
IsValidForRead True
LogicalName isonexternalcreatedenabled
RequiredLevel None
Type Boolean
GlobalChoiceName virtualentitymetadata_isonexternalcreatedenabled
DefaultValue False
True Label Yes
False Label No

IsOnExternalDeletedEnabled

Property Value
Description Will enable a message to send information about deleted records in the external data source.
DisplayName Enable external delete message
IsValidForForm True
IsValidForRead True
LogicalName isonexternaldeletedenabled
RequiredLevel None
Type Boolean
GlobalChoiceName virtualentitymetadata_isonexternaldeletedenabled
DefaultValue False
True Label Yes
False Label No

IsOnExternalUpdatedEnabled

Property Value
Description Will enable a message to send information about updated records in the external data source.
DisplayName Enable external update message
IsValidForForm True
IsValidForRead True
LogicalName isonexternalupdatedenabled
RequiredLevel None
Type Boolean
GlobalChoiceName virtualentitymetadata_isonexternalupdatedenabled
DefaultValue False
True Label Yes
False Label No

Name

Property Value
Description The name of the settings.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

statecode

Property Value
Description Status of the VirtualEntityMetadata
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName virtualentitymetadata_statecode

statecode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: Inactive

statuscode

Property Value
Description Reason for the status of the VirtualEntityMetadata
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName virtualentitymetadata_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

VirtualEntityMetadataId

Property Value
Description Unique identifier for entity instances
DisplayName VirtualEntityMetadata
IsValidForForm False
IsValidForRead True
LogicalName virtualentitymetadataid
RequiredLevel SystemRequired
Type Uniqueidentifier

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

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
Type Lookup
Targets systemuser

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

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
Type Lookup
Targets systemuser

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Type Lookup
Targets organization

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_virtualentitymetadata_createdby

One-To-Many Relationship: systemuser lk_virtualentitymetadata_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_virtualentitymetadata_createdonbehalfby

One-To-Many Relationship: systemuser lk_virtualentitymetadata_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_virtualentitymetadata_modifiedby

One-To-Many Relationship: systemuser lk_virtualentitymetadata_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_virtualentitymetadata_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_virtualentitymetadata_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_virtualentitymetadata

One-To-Many Relationship: organization organization_virtualentitymetadata

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

virtualentitymetadata_extensionofrecordid

One-To-Many Relationship: entity virtualentitymetadata_extensionofrecordid

Property Value
ReferencedEntity entity
ReferencedAttribute entityid
ReferencingAttribute extensionofrecordid
ReferencingEntityNavigationPropertyName extensionofrecordid
IsHierarchical
CascadeConfiguration Archive: Cascade
Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
RollupView: NoCascade
Share: Cascade
Unshare: Cascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

virtualentitymetadata_AsyncOperations

Many-To-One Relationship: asyncoperation virtualentitymetadata_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName virtualentitymetadata_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

virtualentitymetadata_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure virtualentitymetadata_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName virtualentitymetadata_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

virtualentitymetadata_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder virtualentitymetadata_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName virtualentitymetadata_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

virtualentitymetadata_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess virtualentitymetadata_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName virtualentitymetadata_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

virtualentitymetadata_ProcessSession

Many-To-One Relationship: processsession virtualentitymetadata_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName virtualentitymetadata_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

virtualentitymetadata_SyncErrors

Many-To-One Relationship: syncerror virtualentitymetadata_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName virtualentitymetadata_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
virtualentitymetadata