appconfig EntityType

Contains a mapping between an app configuration instance and an app, which defines the properties that can be customized for the app. Optionally, also contains navigation setting for an app. For internal use only.

Entity Set Path
[organization URI]/api/data/v9.2/appconfigs
Base Type
crmbaseentity
Display Name
App Configuration
Primary Key
appconfigid
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
appconfigid Edm.Guid

System-populated app configuration ID.

Display Name: App Config ID

Read Only
appconfigidunique Edm.Guid

System-populated app configuration unique ID.

Display Name: App Config ID Unique

appconfigimportxml Edm.String

The App Config diff computed for managed solutions containing the AppConfig entity. For internal use only.

componentstate Edm.Int32

For internal use only

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.

Display Name: Created On

Read Only
importsequencenumber Edm.Int32

For internal use only.

Display Name: Import Sequence Number

Read Only
introducedversion Edm.String

Version in which the similarity rule is introduced.

Display Name: Introduced Version

ismanaged Edm.Boolean

Is Managed

Display Name: Indicates whether this is part of a managed solution.

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.

Display Name: Modified On

Read Only
overriddencreatedon Edm.DateTimeOffset

Shows the date and time when the record was migrated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.

Display Name: Record Created On

Read Only
overwritetime Edm.DateTimeOffset

Internal use only

Display Name: Overwrite Time

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Shows whether the app configuration is Active or Inactive. Inactive records are read-only and can't be edited unless they are reactivated.

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the status.

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
versionnumber Edm.Int64
Read Only

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
_appmoduleid_value appmodule_appconfig

Choose the app module to associate with the app configuration.

_createdby_value appconfig_createdby

Shows who created the record.

_createdonbehalfby_value appconfig_createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value appconfig_modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value appconfig_modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_organizationid_value organization_appconfig

Unique identifier for the organization.

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
appconfig_createdby systemuser systemuser_appconfig_createdby
appconfig_createdonbehalfby systemuser systemuser_appconfig_createdonbehalfby
appconfig_modifiedby systemuser systemuser_appconfig_modifiedby
appconfig_modifiedonbehalfby systemuser systemuser_appconfig_modifiedonbehalfby
appmodule_appconfig appmodule appmodule_appconfig
organization_appconfig organization organization_appconfig

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
appconfig_appconfiginstance appconfiginstance appconfiginstance_appconfig
appconfig_navigationsetting navigationsetting navigationsetting_appconfig

Operations

The following operations can be used with the appconfig entity type.

Name Binding
RetrieveUnpublishedMultiple Bound to Collection

See also