AppConfigInstance Entity Reference

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

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/appconfiginstances
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/appconfiginstances(appconfiginstanceid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/appconfiginstances(appconfiginstanceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/appconfiginstances
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrieveUnpublishedMultiple RetrieveUnpublishedMultiple Function RetrieveUnpublishedMultipleRequest
Update PATCH [org URI]/api/data/v9.0/appconfiginstances(appconfiginstanceid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName AppConfigInstances
DisplayCollectionName App Configuration Instance
DisplayName App Configuration Instance
EntitySetName appconfiginstances
IsBPFEntity False
LogicalCollectionName appconfiginstances
LogicalName appconfiginstance
OwnershipType OrganizationOwned
PrimaryIdAttribute appconfiginstanceid
PrimaryNameAttribute
SchemaName AppConfigInstance

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AppConfigId

Property Value
Description System-calculated App Configuration unique identifier.
DisplayName App Config ID
IsValidForForm False
IsValidForRead True
LogicalName appconfigid
RequiredLevel ApplicationRequired
Targets appconfig
Type Lookup

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
IsValidForUpdate False
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
Targets appconfigmaster
Type Lookup

ComponentType

Property Value
Description ComponentType
DisplayName Enter the componenet type of the artifact (Form/View etc.) for which customization is to be created.
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName componenttype
MaxLength 100
RequiredLevel None
Type String

IntroducedVersion

Property Value
Description Shows the version in which the App Configuration Instance is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 100
RequiredLevel None
Type String

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
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName value
MaxLength 100
RequiredLevel SystemRequired
Type String

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

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

ComponentState 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
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 Shows whether the App Configuration Instance is managed or not.
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel ApplicationRequired
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

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 System-calculated field for Organization identifier.
DisplayName Organization
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 Shows the last overwrite time for the App Configuration Instance.
DisplayName Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

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
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

appconfig_appconfiginstance

See appconfig Entity appconfig_appconfiginstance One-To-Many relationship.

lk_appconfiginstance_modifiedby

See systemuser Entity lk_appconfiginstance_modifiedby One-To-Many relationship.

lk_appconfiginstance_createdby

See systemuser Entity lk_appconfiginstance_createdby One-To-Many relationship.

lk_appconfiginstance_createdonbehalfby

See systemuser Entity lk_appconfiginstance_createdonbehalfby One-To-Many relationship.

lk_appconfiginstance_modifiedonbehalfby

See systemuser Entity lk_appconfiginstance_modifiedonbehalfby One-To-Many relationship.

organization_appconfiginstance

See organization Entity organization_appconfiginstance One-To-Many relationship.

appconfigmaster_appconfiginstance

See appconfigmaster Entity appconfigmaster_appconfiginstance One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
appconfiginstance EntityType