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.0/appmodules
Base Type
crmbaseentity
Display Name
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
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
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
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
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
Value Label
1 Yes
0 No
isfeatured Edm.Boolean

Is Featured

Display Name: IsFeatured

Default Options
Value Label
1 Yes
0 No
ismanaged Edm.Boolean

Is Managed

Display Name: IsManaged

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
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

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
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 Retrieve data about lookup properties.

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_appconfig appconfig appmodule_appconfig
appmodule_appmodulecomponent appmodulecomponent appmoduleid
appmoduleroles_association role appmoduleroles_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 Entity
RetrieveUnpublishedMultiple Collection
ValidateApp Not Bound

Solutions

The following solutions include the appmodule entity type.

Name Description
System Solution Internal CRM System Solution

See also