Model-driven App (AppModule) table/entity reference (Microsoft Dataverse)

2025-08-28

A role-based, modular business app that provides task-based functionality for a particular area of work.

Messages

The following table lists the messages for the Model-driven App (AppModule) 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
`AddAppComponents` Event: False	AddAppComponents	AddAppComponentsRequest
`Associate` Event: True	Associate records	Associate records
`Create` Event: False	`POST` /appmodules See Create	Create records
`Delete` Event: False	`DELETE` /appmodules(appmoduleid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`RemoveAppComponents` Event: False	RemoveAppComponents	RemoveAppComponentsRequest
`Retrieve` Event: False	`GET` /appmodules(appmoduleid) See Retrieve	Retrieve records
`RetrieveAppComponents` Event: False	RetrieveAppComponents	RetrieveAppComponentsRequest
`RetrieveMultiple` Event: False	`GET` /appmodules See Query data	Query data
`RetrieveUnpublished` Event: False	RetrieveUnpublished	RetrieveUnpublishedRequest
`RetrieveUnpublishedMultiple` Event: False	RetrieveUnpublishedMultiple	RetrieveUnpublishedMultipleRequest
`Update` Event: False	`PATCH` /appmodules(appmoduleid) See Update	Update records
`Upsert` Event: False	`PATCH` /appmodules(appmoduleid) See Upsert a table row	UpsertRequest
`ValidateApp` Event: False	ValidateApp	ValidateAppRequest

Properties

The following table lists selected properties for the Model-driven App (AppModule) table.

Property	Value
DisplayName	Model-driven App
DisplayCollectionName	Model-driven Apps
SchemaName	`AppModule`
CollectionSchemaName	`AppModules`
EntitySetName	`appmodules`
LogicalName	`appmodule`
LogicalCollectionName	`appmodules`
PrimaryIdAttribute	`appmoduleid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

aiappdescription
aidescriptiongeneratedon
appgraph
AppModuleId
AppModuleIdUnique
AppModuleVersion
AppModuleXmlManaged
ClientType
ConfigXML
Description
EventHandlers
FormFactor
ImportSequenceNumber
IntroducedVersion
IsDefault
IsFeatured
Name
NavigationType
OptimizedFor
OverriddenCreatedOn
PublishedOn
PublisherId
statecode
statuscode
UniqueName
URL
WebResourceId
WelcomePageId

aiappdescription

Property	Value
Description	This field is used to store AI generated Description for Model-driven App
DisplayName	AI App Description
IsValidForForm	True
IsValidForRead	True
LogicalName	`aiappdescription`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

aidescriptiongeneratedon

Property	Value
Description	This field stores the Time when last AI App Description was generated.
DisplayName	AI Description Generated On
IsValidForForm	True
IsValidForRead	True
LogicalName	`aidescriptiongeneratedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

appgraph

Property	Value
Description	This field is used to store App Graph for Model-driven App
DisplayName	App Graph
IsValidForForm	True
IsValidForRead	True
LogicalName	`appgraph`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

AppModuleId

Property	Value
Description	Unique identifier for entity instances
DisplayName	AppModuleId
IsValidForForm	False
IsValidForRead	True
LogicalName	`appmoduleid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

AppModuleIdUnique

Property	Value
Description	Unique identifier of the App Module used when synchronizing customizations for the Microsoft Dynamics 365 client for Outlook
DisplayName	App Module Unique Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`appmoduleidunique`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

AppModuleVersion

Property	Value
Description	App Module Version
DisplayName	App Module Version
IsValidForForm	False
IsValidForRead	True
LogicalName	`appmoduleversion`
RequiredLevel	None
Type	String
Format	VersionNumber
FormatName	VersionNumber
ImeMode	Auto
IsLocalizable	False
MaxLength	48

AppModuleXmlManaged

Property	Value
Description	App Module Xml Managed
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`appmodulexmlmanaged`
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

ClientType

Property	Value
Description	Client Type such as Web or UCI
DisplayName	Client Type
IsValidForForm	False
IsValidForRead	True
LogicalName	`clienttype`
RequiredLevel	ApplicationRequired
Type	Integer
MaxValue	31
MinValue	1

ConfigXML

Property	Value
Description	Contains configuration XML
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`configxml`
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

Description

Property	Value
Description	Description for entity
DisplayName	Description
IsValidForForm	False
IsValidForRead	True
LogicalName	`description`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	True
MaxLength	2000

EventHandlers

Property	Value
Description	App Module Event Handlers
DisplayName	Event Handlers
IsValidForForm	False
IsValidForRead	True
LogicalName	`eventhandlers`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

FormFactor

Property	Value
Description	Form Factor
DisplayName	Form Factor
IsValidForForm	False
IsValidForRead	True
LogicalName	`formfactor`
RequiredLevel	ApplicationRequired
Type	Integer
MaxValue	8
MinValue	1

ImportSequenceNumber

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

IntroducedVersion

Property	Value
Description	Version in which the similarity rule is introduced.
DisplayName	Introduced Version
IsValidForForm	False
IsValidForRead	True
LogicalName	`introducedversion`
RequiredLevel	None
Type	String
Format	VersionNumber
FormatName	VersionNumber
ImeMode	Auto
IsLocalizable	False
MaxLength	100

IsDefault

Property	Value
Description	Is Default
DisplayName	Is Default
IsValidForForm	False
IsValidForRead	True
LogicalName	`isdefault`
RequiredLevel	ApplicationRequired
Type	Boolean
GlobalChoiceName	`appmodule_isdefault`
DefaultValue	False
True Label	Yes
False Label	No

IsFeatured

Property	Value
Description	Is Featured
DisplayName	IsFeatured
IsValidForForm	False
IsValidForRead	True
LogicalName	`isfeatured`
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	`appmodule_isfeatured`
DefaultValue	False
True Label	Yes
False Label	No

Name

Property	Value
Description	Name of App Module
DisplayName	Name
IsValidForForm	False
IsValidForRead	True
LogicalName	`name`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	True
MaxLength	100

NavigationType

Property	Value
Description	App navigation type
DisplayName	Navigation type
IsValidForForm	False
IsValidForRead	True
LogicalName	`navigationtype`
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	`appmodule_navigationtype`

NavigationType Choices/Options

Value	Label
0	Single session
1	Multi session

OptimizedFor

Property	Value
Description	The client that this app is optimized for
DisplayName	Optimized Client
IsValidForForm	False
IsValidForRead	True
LogicalName	`optimizedfor`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

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

PublishedOn

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

PublisherId

Property	Value
Description	Unique identifier of the publisher.
DisplayName	Publisher
IsValidForForm	False
IsValidForRead	True
LogicalName	`publisherid`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	publisher

statecode

Property	Value
Description	Status of the Model-driven App
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`appmodule_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 Model-driven App
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	SystemRequired
Type	Status
DefaultFormValue
GlobalChoiceName	`appmodule_statuscode`

statuscode Choices/Options

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

UniqueName

Property	Value
Description	Unique Name of App Module
DisplayName	Unique Name
IsValidForForm	False
IsValidForRead	True
LogicalName	`uniquename`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

URL

Property	Value
Description	Contains URL
DisplayName	URL
IsValidForForm	False
IsValidForRead	True
LogicalName	`url`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

WebResourceId

Property	Value
Description	Unique identifier of the Web Resource
DisplayName	Web Resource Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`webresourceid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

WelcomePageId

Property	Value
Description	Unique identifier of the Web Resource as Welcome Page Id
DisplayName	Welcome Page Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`welcomepageid`
RequiredLevel	None
Type	Uniqueidentifier

Read-only columns/attributes

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

ComponentState
CreatedBy
CreatedOn
CreatedOnBehalfBy
Descriptor
IsManaged
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
OverwriteTime
SolutionId
SupportingSolutionId
VersionNumber

ComponentState

Property	Value
Description	For internal use only
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	`componentstate`
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	-1
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	False
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	False
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	False
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

Descriptor

Property	Value
Description	App Module Descriptor
DisplayName	Descriptor
IsValidForForm	False
IsValidForRead	True
LogicalName	`descriptor`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

IsManaged

Property	Value
Description	Is Managed
DisplayName	IsManaged
IsValidForForm	False
IsValidForRead	True
LogicalName	`ismanaged`
RequiredLevel	ApplicationRequired
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	False
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	False
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	False
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier of the organization associated with the app.
DisplayName	Organization
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	SystemRequired
Type	Lookup
Targets	organization

OverwriteTime

Property	Value
Description	Internal use only
DisplayName	Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	`overwritetime`
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
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
DisplayName
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_appmodule_createdby
lk_appmodule_createdonbehalfby
lk_appmodule_modifiedby
lk_appmodule_modifiedonbehalfby
organization_appmodule
publisher_appmodule

lk_appmodule_createdby

One-To-Many Relationship: systemuser lk_appmodule_createdby

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

lk_appmodule_createdonbehalfby

One-To-Many Relationship: systemuser lk_appmodule_createdonbehalfby

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

lk_appmodule_modifiedby

One-To-Many Relationship: systemuser lk_appmodule_modifiedby

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

lk_appmodule_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_appmodule_modifiedonbehalfby

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

organization_appmodule

One-To-Many Relationship: organization organization_appmodule

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

publisher_appmodule

One-To-Many Relationship: publisher publisher_appmodule

Property	Value
ReferencedEntity	`publisher`
ReferencedAttribute	`publisherid`
ReferencingAttribute	`publisherid`
ReferencingEntityNavigationPropertyName	`publisher_appmodule_appmodule`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `Cascade` Delete: `Restrict` Merge: `NoCascade` Reparent: `Cascade` RollupView: `NoCascade` Share: `Cascade` Unshare: `Cascade`

One-to-Many relationships

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

appmodule_appaction_appmoduleid
appmodule_appconfig
appmodule_appmodulecomponent
appmodule_appnotification_app
appmodule_userrating_app

appmodule_appaction_appmoduleid

Many-To-One Relationship: appaction appmodule_appaction_appmoduleid

Property	Value
ReferencingEntity	`appaction`
ReferencingAttribute	`appmoduleid`
ReferencedEntityNavigationPropertyName	`appmodule_appaction_appmoduleid`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

appmodule_appconfig

Many-To-One Relationship: appconfig appmodule_appconfig

Property	Value
ReferencingEntity	`appconfig`
ReferencingAttribute	`appmoduleid`
ReferencedEntityNavigationPropertyName	`appmodule_appconfig`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

appmodule_appmodulecomponent

Many-To-One Relationship: appmodulecomponent appmodule_appmodulecomponent

Property	Value
ReferencingEntity	`appmodulecomponent`
ReferencingAttribute	`appmoduleidunique`
ReferencedEntityNavigationPropertyName	`appmodule_appmodulecomponent`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

appmodule_appnotification_app

Many-To-One Relationship: appnotification appmodule_appnotification_app

Property	Value
ReferencingEntity	`appnotification`
ReferencingAttribute	`appmoduleid`
ReferencedEntityNavigationPropertyName	`appmodule_appnotification_app`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

appmodule_userrating_app

Many-To-One Relationship: userrating appmodule_userrating_app

Property	Value
ReferencingEntity	`userrating`
ReferencingAttribute	`appmoduleid`
ReferencedEntityNavigationPropertyName	`appmodule_userrating_app`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Many-to-Many relationships

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

appmoduleroles_association
serviceplan_appmodule

appmoduleroles_association

See role appmoduleroles_association Many-To-Many Relationship

Property	Value
IntersectEntityName	`appmoduleroles`
IsCustomizable	False
SchemaName	`appmoduleroles_association`
IntersectAttribute	`appmoduleid`
NavigationPropertyName	`appmoduleroles_association`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

serviceplan_appmodule

See serviceplan serviceplan_appmodule Many-To-Many Relationship

Property	Value
IntersectEntityName	`serviceplanappmodules`
IsCustomizable	False
SchemaName	`serviceplan_appmodule`
IntersectAttribute	`appmoduleid`
NavigationPropertyName	`serviceplan_appmodule_association`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Feedback

Was this page helpful?