AppModule Entity Reference

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

Messages

Message Web API Operation SDK Assembly
AddAppComponents AddAppComponents Action AddAppComponentsRequest
Create POST [org URI]/api/data/v9.0/appmodules
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/appmodules(appmoduleid)
See Delete
DeleteRequest or
Delete
RemoveAppComponents RemoveAppComponents Action RemoveAppComponentsRequest
Retrieve GET [org URI]/api/data/v9.0/appmodules(appmoduleid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveAppComponents RetrieveAppComponents Function RetrieveAppComponentsRequest
RetrieveMultiple GET [org URI]/api/data/v9.0/appmodules
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrieveUnpublishedMultiple RetrieveUnpublishedMultiple Function RetrieveUnpublishedMultipleRequest
Update PATCH [org URI]/api/data/v9.0/appmodules(appmoduleid)
See Update
UpdateRequest or
Update
ValidateApp ValidateApp Function ValidateAppRequest

Entity Properties

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

Writable attributes

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

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
IsValidForUpdate False
LogicalName appmoduleidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

AppModuleVersion

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

AppModuleXmlManaged

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

ClientType

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

ConfigXML

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

Description

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

EventHandlers

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

FormFactor

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

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration 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

IntroducedVersion

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

IsDefault

Property Value
Description Is Default
DisplayName Is Default
IsValidForForm False
IsValidForRead True
LogicalName isdefault
RequiredLevel ApplicationRequired
Type Boolean

IsDefault Options

Value Label
1 Yes
0 No

DefaultValue: False

IsFeatured

Property Value
Description Is Featured
DisplayName IsFeatured
IsValidForForm False
IsValidForRead True
LogicalName isfeatured
RequiredLevel SystemRequired
Type Boolean

IsFeatured Options

Value Label
1 Yes
0 No

DefaultValue: False

Name

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

NavigationType

Property Value
Description App navigation type
DisplayName Navigation type
IsValidForForm False
IsValidForRead True
LogicalName navigationtype
RequiredLevel SystemRequired
Type Picklist
Value Label
0 Single session
1 Multi session

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

PublishedOn

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

PublisherId

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

UniqueName

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

URL

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

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 attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ComponentState

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

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

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOn

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

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

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

Descriptor

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

IsManaged

Property Value
Description Is Managed
DisplayName IsManaged
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel ApplicationRequired
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

ModifiedBy

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

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

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

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

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OrganizationId

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

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description Internal use only
DisplayName Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

PublisherIdName

Property Value
Description name of the publisher.
DisplayName Publisher
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName publisheridname
MaxLength 100
RequiredLevel None
Type String

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
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

appmodule_appconfig

Same as appconfig entity appmodule_appconfig Many-To-One relationship.

Property Value
ReferencingEntity appconfig
ReferencingAttribute appmoduleid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName appmodule_appconfig
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

appmodule_appmodulecomponent

Same as appmodulecomponent entity appmodule_appmodulecomponent Many-To-One relationship.

Property Value
ReferencingEntity appmodulecomponent
ReferencingAttribute appmoduleidunique
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName appmodule_appmodulecomponent
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

organization_appmodule

See organization Entity organization_appmodule One-To-Many relationship.

lk_appmodule_modifiedby

See systemuser Entity lk_appmodule_modifiedby One-To-Many relationship.

publisher_appmodule

See publisher Entity publisher_appmodule One-To-Many relationship.

lk_appmodule_modifiedonbehalfby

See systemuser Entity lk_appmodule_modifiedonbehalfby One-To-Many relationship.

lk_appmodule_createdby

See systemuser Entity lk_appmodule_createdby One-To-Many relationship.

lk_appmodule_createdonbehalfby

See systemuser Entity lk_appmodule_createdonbehalfby One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the AppModule entity is the first entity in the relationship. Listed by SchemaName.

appmoduleroles_association

IntersectEntityName: appmoduleroles

Entity 1

Property Value
IntersectAttribute appmoduleid
IsCustomizable False
LogicalName appmodule
NavigationPropertyName appmoduleroles_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName role
IntersectAttribute roleid
NavigationPropertyName appmoduleroles_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

See also

About the Entity Reference
Web API Reference
appmodule EntityType