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 property or a list of properties from the app configuration master list that can be customized for any app in Dynamics 365. For internal use only.
Messages
The following table lists the messages for the App Configuration Instance (AppConfigInstance) 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 /appconfiginstancesSee Create |
Create records |
DeleteEvent: True |
DELETE /appconfiginstances(appconfiginstanceid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
RetrieveEvent: True |
GET /appconfiginstances(appconfiginstanceid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /appconfiginstancesSee Query data |
Query data |
RetrieveUnpublishedMultipleEvent: False |
RetrieveUnpublishedMultiple | RetrieveUnpublishedMultipleRequest |
UpdateEvent: True |
PATCH /appconfiginstances(appconfiginstanceid)See Update |
Update records |
UpsertEvent: False |
PATCH /appconfiginstances(appconfiginstanceid)See Upsert a table row |
UpsertRequest |
Properties
The following table lists selected properties for the App Configuration Instance (AppConfigInstance) table.
| Property | Value |
|---|---|
| DisplayName | App Configuration Instance |
| DisplayCollectionName | App Configuration Instance |
| SchemaName | AppConfigInstance |
| CollectionSchemaName | AppConfigInstances |
| EntitySetName | appconfiginstances |
| LogicalName | appconfiginstance |
| LogicalCollectionName | appconfiginstances |
| PrimaryIdAttribute | appconfiginstanceid |
| TableType | Standard |
| OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AppConfigId
- AppConfigIdUnique
- AppConfigInstanceIdUnique
- AppConfigMasterId
- ComponentType
- IntroducedVersion
- ObjectId
- Value
AppConfigId
| Property | Value |
|---|---|
| Description | System-calculated App Configuration unique identifier. |
| DisplayName | App Config ID |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfigid |
| RequiredLevel | ApplicationRequired |
| Type | Lookup |
| Targets | appconfig |
AppConfigIdUnique
| Property | Value |
|---|---|
| Description | Enter the App Configuration unique identifier of AppConfig entity for which this customization belongs. |
| DisplayName | App Config ID Unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfigidunique |
| RequiredLevel | None |
| Type | Uniqueidentifier |
AppConfigInstanceIdUnique
| Property | Value |
|---|---|
| Description | System-populated App Configuration Instance unique identifier. |
| DisplayName | AppConfigInstanceIdUnique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfiginstanceidunique |
| RequiredLevel | None |
| Type | Uniqueidentifier |
AppConfigMasterId
| Property | Value |
|---|---|
| Description | System-calculated App Configuration Master identifier. |
| DisplayName | App Config Master ID |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfigmasterid |
| RequiredLevel | ApplicationRequired |
| Type | Lookup |
| Targets | appconfigmaster |
ComponentType
| Property | Value |
|---|---|
| Description | ComponentType |
| DisplayName | Enter the componenet type of the artifact (Form/View etc.) for which customization is to be created. |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componenttype |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
IntroducedVersion
| Property | Value |
|---|---|
| Description | Shows the version in which the App Configuration Instance 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 |
ObjectId
| Property | Value |
|---|---|
| Description | ObjectId |
| DisplayName | Enter the object identifier for the artifact (Form/View etc.) for which customization is to be created. |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | objectid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
Value
| Property | Value |
|---|---|
| Description | Enter a value for the customization property that is valid as per the validator XML specified in the app configuration master record. |
| DisplayName | Value |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | value |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- AppConfigInstanceId
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- ImportSequenceNumber
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverriddenCreatedOn
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
AppConfigInstanceId
| Property | Value |
|---|---|
| Description | System-Populated App Configuration instance identifier. |
| DisplayName | AppConfig Instance ID |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appconfiginstanceid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
| Property | Value |
|---|---|
| Description | System-Populated Published or UnPublished state of App Configuration Instance. |
| 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 | Shows whether the App Configuration Instance is managed or not. |
| 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 | System-calculated field for Organization identifier. |
| DisplayName | Organization |
| 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 | Shows the last overwrite time for the App Configuration Instance. |
| 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 | Set the solution idenfitier for associated solution. |
| DisplayName | SolutionId |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | Set the supporting solution idenfitier for associated solution. |
| DisplayName | SupportingSolutionId |
| 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.
- appconfig_appconfiginstance
- appconfigmaster_appconfiginstance
- lk_appconfiginstance_createdby
- lk_appconfiginstance_createdonbehalfby
- lk_appconfiginstance_modifiedby
- lk_appconfiginstance_modifiedonbehalfby
- organization_appconfiginstance
appconfig_appconfiginstance
One-To-Many Relationship: appconfig appconfig_appconfiginstance
| Property | Value |
|---|---|
| ReferencedEntity | appconfig |
| ReferencedAttribute | appconfigid |
| ReferencingAttribute | appconfigid |
| ReferencingEntityNavigationPropertyName | appconfiginstance_appconfig |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: CascadeDelete: CascadeMerge: NoCascadeReparent: CascadeRollupView: NoCascadeShare: CascadeUnshare: Cascade |
appconfigmaster_appconfiginstance
One-To-Many Relationship: appconfigmaster appconfigmaster_appconfiginstance
| Property | Value |
|---|---|
| ReferencedEntity | appconfigmaster |
| ReferencedAttribute | appconfigmasterid |
| ReferencingAttribute | appconfigmasterid |
| ReferencingEntityNavigationPropertyName | appconfiginstance_appconfigmaster |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: CascadeDelete: CascadeMerge: NoCascadeReparent: CascadeRollupView: NoCascadeShare: CascadeUnshare: Cascade |
lk_appconfiginstance_createdby
One-To-Many Relationship: systemuser lk_appconfiginstance_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | appconfiginstance_createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfiginstance_createdonbehalfby
One-To-Many Relationship: systemuser lk_appconfiginstance_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | appconfiginstance_createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfiginstance_modifiedby
One-To-Many Relationship: systemuser lk_appconfiginstance_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | appconfiginstance_modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appconfiginstance_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_appconfiginstance_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | appconfiginstance_modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
organization_appconfiginstance
One-To-Many Relationship: organization organization_appconfiginstance
| Property | Value |
|---|---|
| ReferencedEntity | organization |
| ReferencedAttribute | organizationid |
| ReferencingAttribute | organizationid |
| ReferencingEntityNavigationPropertyName | organization_appconfiginstance_appconfiginstance |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
See also
Dataverse table/entity reference
Dataverse Web API Reference
appconfiginstance