Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Messages
The following table lists the messages for the App Configuration (AppConfig) 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 |
|---|---|---|
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /appconfigsSee Create |
Create records |
DeleteEvent: True |
DELETE /appconfigs(appconfigid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
RetrieveEvent: True |
GET /appconfigs(appconfigid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /appconfigsSee Query data |
Query data |
RetrieveUnpublishedMultipleEvent: False |
RetrieveUnpublishedMultiple | RetrieveUnpublishedMultipleRequest |
UpdateEvent: True |
PATCH /appconfigs(appconfigid)See Update |
Update records |
UpsertEvent: False |
PATCH /appconfigs(appconfigid)See Upsert a table row |
UpsertRequest |
Properties
The following table lists selected properties for the App Configuration (AppConfig) table.
| Property | Value |
|---|---|
| DisplayName | App Configuration |
| DisplayCollectionName | App Configuration |
| SchemaName | AppConfig |
| CollectionSchemaName | AppConfigs |
| EntitySetName | appconfigs |
| LogicalName | appconfig |
| LogicalCollectionName | appconfigs |
| PrimaryIdAttribute | appconfigid |
| TableType | Standard |
| OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
AppConfigIdUnique
| Property | Value |
|---|---|
| Description | System-populated app configuration unique ID. |
| DisplayName | App Config ID Unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfigidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
AppConfigImportXml
| Property | Value |
|---|---|
| Description | The App Config diff computed for managed solutions containing the AppConfig entity. For internal use only. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfigimportxml |
| RequiredLevel | None |
| Type | Memo |
| Format | TextArea |
| FormatName | TextArea |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 1073741823 |
AppModuleId
| Property | Value |
|---|---|
| Description | Choose the app module to associate with the app configuration. |
| DisplayName | App Module ID |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appmoduleid |
| RequiredLevel | SystemRequired |
| Type | Lookup |
| Targets | appmodule |
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 |
StateCode
| Property | Value |
|---|---|
| Description | Shows whether the app configuration is Active or Inactive. Inactive records are read-only and can't be edited unless they are reactivated. |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | None |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | appconfig_statecode |
StateCode Choices/Options
| Value | Details |
|---|---|
| 0 | Label: Active DefaultStatus: 1 InvariantName: Active |
| 1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
StatusCode
| Property | Value |
|---|---|
| Description | Select the status. |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | appconfig_statuscode |
StatusCode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- AppConfigId
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- ImportSequenceNumber
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverriddenCreatedOn
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
AppConfigId
| Property | Value |
|---|---|
| Description | System-populated app configuration ID. |
| DisplayName | App Config ID |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfigid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
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 | Shows who created the record. |
| DisplayName | Created By |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
CreatedOn
| Property | Value |
|---|---|
| Description | 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. |
| 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 | Shows who created the record on behalf of another user. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Import Sequence Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | importsequencenumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
IsManaged
| Property | Value |
|---|---|
| Description | Is Managed |
| DisplayName | Indicates whether this is part of a managed solution. |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | ApplicationRequired |
| Type | Boolean |
| GlobalChoiceName | ismanaged |
| DefaultValue | False |
| True Label | Managed |
| False Label | Unmanaged |
ModifiedBy
| Property | Value |
|---|---|
| Description | Shows who last updated the record. |
| DisplayName | Modified By |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
ModifiedOn
| Property | Value |
|---|---|
| Description | 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. |
| 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 | Shows who last updated the record on behalf of another user. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier for the organization. |
| DisplayName | OrganizationId |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | SystemRequired |
| Type | Lookup |
| Targets | organization |
OverriddenCreatedOn
| Property | Value |
|---|---|
| Description | 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. |
| DisplayName | Record Created On |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateOnly |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
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 | Supporting Solution ID |
| 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.
- appmodule_appconfig
- lk_appconfig_createdby
- lk_appconfig_createdonbehalfby
- lk_appconfig_modifiedby
- lk_appconfig_modifiedonbehalfby
- organization_appconfig
appmodule_appconfig
One-To-Many Relationship: appmodule appmodule_appconfig
| Property | Value |
|---|---|
| ReferencedEntity | appmodule |
| ReferencedAttribute | appmoduleid |
| ReferencingAttribute | appmoduleid |
| ReferencingEntityNavigationPropertyName | appmodule_appconfig |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: CascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfig_createdby
One-To-Many Relationship: systemuser lk_appconfig_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | appconfig_createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfig_createdonbehalfby
One-To-Many Relationship: systemuser lk_appconfig_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | appconfig_createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfig_modifiedby
One-To-Many Relationship: systemuser lk_appconfig_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | appconfig_modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfig_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_appconfig_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | appconfig_modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
organization_appconfig
One-To-Many Relationship: organization organization_appconfig
| Property | Value |
|---|---|
| ReferencedEntity | organization |
| ReferencedAttribute | organizationid |
| ReferencingAttribute | organizationid |
| ReferencingEntityNavigationPropertyName | organization_appconfig |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
appconfig_appconfiginstance
Many-To-One Relationship: appconfiginstance appconfig_appconfiginstance
| Property | Value |
|---|---|
| ReferencingEntity | appconfiginstance |
| ReferencingAttribute | appconfigid |
| ReferencedEntityNavigationPropertyName | appconfig_appconfiginstance |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
navigationsetting_appconfig
Many-To-One Relationship: navigationsetting navigationsetting_appconfig
| Property | Value |
|---|---|
| ReferencingEntity | navigationsetting |
| ReferencingAttribute | appconfigid |
| ReferencedEntityNavigationPropertyName | appconfig_navigationsetting |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
appconfig