App Configuration (AppConfig) table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
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
Message | Web API Operation | SDK class or method |
---|---|---|
Create | POST /appconfigs See Create |
CreateRequest or Create |
Delete | DELETE /appconfigs(appconfigid) See Delete |
DeleteRequest or Delete |
Retrieve | GET /appconfigs(appconfigid) See Retrieve |
RetrieveRequest or Retrieve |
RetrieveMultiple | GET /appconfigs See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
RetrieveUnpublishedMultiple | RetrieveUnpublishedMultiple | RetrieveUnpublishedMultipleRequest |
Update | PATCH /appconfigs(appconfigid) See Update |
UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | AppConfigs |
DisplayCollectionName | App Configuration |
DisplayName | App Configuration |
EntitySetName | appconfigs |
IsBPFEntity | False |
LogicalCollectionName | appconfigs |
LogicalName | appconfig |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | appconfigid |
PrimaryNameAttribute | |
SchemaName | AppConfig |
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 |
IsValidForUpdate | False |
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 | |
Format | TextArea |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | appconfigimportxml |
MaxLength | 1073741823 |
RequiredLevel | None |
Type | Memo |
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 |
Targets | appmodule |
Type | Lookup |
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 |
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 |
StateCode Choices/Options
Value | Label | DefaultStatus | InvariantName |
---|---|---|---|
0 | Active | 1 | Active |
1 | Inactive | 2 | Inactive |
StatusCode
Property | Value |
---|---|
Description | Select the status. |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
StatusCode Choices/Options
Value | Label | State |
---|---|---|
1 | Active | 0 |
2 | Inactive | 1 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- AppConfigId
- ComponentState
- CreatedBy
- CreatedByName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ImportSequenceNumber
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- 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 |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
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 |
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 | 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 |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
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 |
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 |
ImportSequenceNumber
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Import Sequence Number |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | importsequencenumber |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
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 |
IsManaged Choices/Options
Value | Label | Description |
---|---|---|
1 | Managed | |
0 | Unmanaged |
DefaultValue: 0
ModifiedBy
Property | Value |
---|---|
Description | Shows who last updated 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 | 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 |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
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 |
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 for the organization. |
DisplayName | OrganizationId |
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 |
OverriddenCreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
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 |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
OverwriteTime
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Internal use only |
DisplayName | Overwrite Time |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
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 |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
navigationsetting_appconfig
Same as the navigationsetting_appconfig many-to-one relationship for the navigationsetting table/entity.
Property | Value |
---|---|
ReferencingEntity | navigationsetting |
ReferencingAttribute | appconfigid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | appconfig_navigationsetting |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
appconfig_appconfiginstance
Same as the appconfig_appconfiginstance many-to-one relationship for the appconfiginstance table/entity.
Property | Value |
---|---|
ReferencingEntity | appconfiginstance |
ReferencingAttribute | appconfigid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | appconfig_appconfiginstance |
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 table. Listed by SchemaName.
- lk_appconfig_createdby
- lk_appconfig_modifiedonbehalfby
- lk_appconfig_createdonbehalfby
- organization_appconfig
- appmodule_appconfig
- lk_appconfig_modifiedby
lk_appconfig_createdby
See the lk_appconfig_createdby one-to-many relationship for the systemuser table/entity.
lk_appconfig_modifiedonbehalfby
See the lk_appconfig_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
lk_appconfig_createdonbehalfby
See the lk_appconfig_createdonbehalfby one-to-many relationship for the systemuser table/entity.
organization_appconfig
See the organization_appconfig one-to-many relationship for the organization table/entity.
appmodule_appconfig
See the appmodule_appconfig one-to-many relationship for the appmodule table/entity.
lk_appconfig_modifiedby
See the lk_appconfig_modifiedby one-to-many relationship for the systemuser table/entity.
See also
Dataverse table/entity reference
Web API Reference
appconfig EntityType