appmodule EntityType
A role-based, modular business app that provides task-based functionality for a particular area of work.
- Entity Set Path
- [organization URI]/api/data/v9.2/appmodules
- Base Type
- crmbaseentity
- Display Name
- Model-driven App
- Primary Key
- appmoduleid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| aiappdescription | Edm.String |
This field is used to store AI generated Description for Model-driven App Display Name: AI App Description |
||||||||||
| aidescriptiongeneratedon | Edm.DateTimeOffset |
This field stores the Time when last AI App Description was generated. Display Name: AI Description Generated On |
||||||||||
| appgraph | Edm.String |
This field is used to store App Graph for Model-driven App Display Name: App Graph |
||||||||||
| appmoduleid | Edm.Guid |
Unique identifier for entity instances Display Name: AppModuleId |
||||||||||
| appmoduleidunique | Edm.Guid |
Unique identifier of the App Module used when synchronizing customizations for the Microsoft Dynamics 365 client for Outlook Display Name: App Module Unique Id |
||||||||||
| appmoduleversion | Edm.String |
App Module Version Display Name: App Module Version |
||||||||||
| appmodulexmlmanaged | Edm.String |
App Module Xml Managed |
||||||||||
| clienttype | Edm.Int32 |
Client Type such as Web or UCI Display Name: Client Type |
||||||||||
| componentstate | Edm.Int32 |
For internal use only Display Name: Component State Read Only
Default Options
|
||||||||||
| configxml | Edm.String |
Contains configuration XML |
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||
| description | Edm.String |
Description for entity Display Name: Description |
||||||||||
| descriptor | Edm.String |
App Module Descriptor Display Name: Descriptor Read Only
|
||||||||||
| eventhandlers | Edm.String |
App Module Event Handlers Display Name: Event Handlers |
||||||||||
| formfactor | Edm.Int32 |
Form Factor Display Name: Form Factor |
||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
||||||||||
| introducedversion | Edm.String |
Version in which the similarity rule is introduced. Display Name: Introduced Version |
||||||||||
| isdefault | Edm.Boolean |
Is Default Display Name: Is Default
Default Options
|
||||||||||
| isfeatured | Edm.Boolean |
Is Featured Display Name: IsFeatured
Default Options
|
||||||||||
| ismanaged | Edm.Boolean |
Is Managed Display Name: IsManaged Read Only
Default Options
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display Name: Modified On Read Only
|
||||||||||
| name | Edm.String |
Name of App Module Display Name: Name |
||||||||||
| navigationtype | Edm.Int32 |
App navigation type Display Name: Navigation type
Default Options
|
||||||||||
| optimizedfor | Edm.String |
The client that this app is optimized for Display Name: Optimized Client |
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display Name: Record Created On |
||||||||||
| overwritetime | Edm.DateTimeOffset |
Internal use only Display Name: Overwrite Time Read Only
|
||||||||||
| publishedon | Edm.DateTimeOffset |
Date and time when the record was published. Display Name: Published On |
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Model-driven App Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Model-driven App Display Name: Status Reason
Default Options
|
||||||||||
| uniquename | Edm.String |
Unique Name of App Module Display Name: Unique Name |
||||||||||
| url | Edm.String |
Contains URL Display Name: URL |
||||||||||
| versionnumber | Edm.Int64 |
Read Only
|
||||||||||
| webresourceid | Edm.Guid |
Unique identifier of the Web Resource Display Name: Web Resource Id |
||||||||||
| welcomepageid | Edm.Guid |
Unique identifier of the Web Resource as Welcome Page Id Display Name: Welcome Page Id |
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 | appmodule_createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | appmodule_createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | appmodule_modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | appmodule_modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _organizationid_value | organization_appmodule_appmodule |
Unique identifier of the organization associated with the app. |
| _publisherid_value | publisher_appmodule_appmodule |
Unique identifier of the publisher. |
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 |
|---|---|---|
| appmodule_createdby | systemuser | systemuser_appmodule_createdby |
| appmodule_createdonbehalfby | systemuser | systemuser_appmodule_createdonbehalfby |
| appmodule_modifiedby | systemuser | systemuser_appmodule_modifiedby |
| appmodule_modifiedonbehalfby | systemuser | systemuser_appmodule_modifiedonbehalfby |
| organization_appmodule_appmodule | organization | organization_appmodule |
| publisher_appmodule_appmodule | publisher | publisher_appmodule |
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 |
|---|---|---|
| appmodule_appaction_appmoduleid | appaction | AppModuleId |
| appmodule_appconfig | appconfig | appmodule_appconfig |
| appmodule_appmodulecomponent | appmodulecomponent | appmoduleid |
| appmodule_appnotification_app | appnotification | AppModuleId |
| appmodule_userrating_app | userrating | AppModuleId |
| appmoduleroles_association | role | appmoduleroles_association |
| serviceplan_appmodule_association | serviceplan | serviceplan_appmodule_association |
Operations
The following operations can be used with the appmodule entity type.
| Name | Binding |
|---|---|
| AddAppComponents | Not Bound |
| RemoveAppComponents | Not Bound |
| RetrieveAppComponents | Not Bound |
| RetrieveUnpublished | Bound to Entity |
| RetrieveUnpublishedMultiple | Bound to Collection |
| ValidateApp | Not Bound |