Custom Control (CustomControl) table/entity reference (Microsoft Dataverse)

2025-08-28

For internal use only.

Messages

The following table lists the messages for the Custom Control (CustomControl) 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
`Associate` Event: True	Associate records	Associate records
`Create` Event: True	`POST` /customcontrols See Create	Create records
`Delete` Event: True	`DELETE` /customcontrols(customcontrolid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`Retrieve` Event: True	`GET` /customcontrols(customcontrolid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /customcontrols See Query data	Query data
`Update` Event: True	`PATCH` /customcontrols(customcontrolid) See Update	Update records
`Upsert` Event: False	`PATCH` /customcontrols(customcontrolid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Custom Control (CustomControl) table.

Property	Value
DisplayName	Custom Control
DisplayCollectionName	Custom Controls
SchemaName	`CustomControl`
CollectionSchemaName	`CustomControls`
EntitySetName	`customcontrols`
LogicalName	`customcontrol`
LogicalCollectionName	`customcontrols`
PrimaryIdAttribute	`customcontrolid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

AuthoringManifest
ClientJson
CompatibleDataTypes
CustomControlId
IntroducedVersion
Manifest
Name
SupportedPlatform
Version

AuthoringManifest

Property	Value
Description	Authoring Manifest of the CustomControl.
DisplayName	Authoring Manifest
IsValidForForm	False
IsValidForRead	True
LogicalName	`authoringmanifest`
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

ClientJson

Property	Value
Description	Custom control data in JSON format.
DisplayName	Custom control data in JSON format.
IsValidForForm	False
IsValidForRead	True
LogicalName	`clientjson`
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

CompatibleDataTypes

Property	Value
Description	Compatible Data Types For Custom Controls
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`compatibledatatypes`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1000

CustomControlId

Property	Value
Description	Unique identifier of the Custom Control for the Microsoft Dynamics 365.
DisplayName	Custom Control Identifier
IsValidForForm	False
IsValidForRead	True
LogicalName	`customcontrolid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

IntroducedVersion

Property	Value
Description	Version in which the form is introduced.
DisplayName	Introduced Version
IsValidForForm	False
IsValidForRead	True
LogicalName	`introducedversion`
RequiredLevel	None
Type	String
Format	VersionNumber
FormatName	VersionNumber
ImeMode	Auto
IsLocalizable	False
MaxLength	48

Manifest

Property	Value
Description	Manifest of the CustomControl.
DisplayName	Manifest
IsValidForForm	False
IsValidForRead	True
LogicalName	`manifest`
RequiredLevel	SystemRequired
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

Name

Property	Value
Description	Name of the custom control.
DisplayName	Name
IsValidForForm	False
IsValidForRead	True
LogicalName	`name`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

SupportedPlatform

Property	Value
Description	Supported platforms of the CustomControl.
DisplayName	Supported Platforms
IsValidForForm	False
IsValidForRead	True
LogicalName	`supportedplatform`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

Version

Property	Value
Description	For internal use only.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`version`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	40

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentState
CreatedBy
CreatedOn
CreatedOnBehalfBy
CustomControlIdUnique
IsManaged
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
OverwriteTime
SolutionId
SupportingSolutionId
VersionNumber

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	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CustomControlIdUnique

Property	Value
Description	For internal use only.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`customcontrolidunique`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

IsManaged

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`ismanaged`
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	`ismanaged`
DefaultValue	False
True Label	Managed
False Label	Unmanaged

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier of the organization associated with the custom control.
DisplayName	Organization
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	SystemRequired
Type	Lookup
Targets	organization

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record 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	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	`supportingsolutionid`
RequiredLevel	None
Type	Uniqueidentifier

VersionNumber

Property	Value
Description	Version number of the Custom Control.
DisplayName	Version Number
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.

customcontrol_organization
lk_customcontrol_createdby
lk_customcontrol_createdonbehalfby
lk_customcontrol_modifiedby
lk_customcontrol_modifiedonbehalfby

customcontrol_organization

One-To-Many Relationship: organization customcontrol_organization

Property	Value
ReferencedEntity	`organization`
ReferencedAttribute	`organizationid`
ReferencingAttribute	`organizationid`
ReferencingEntityNavigationPropertyName	`organizationid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_customcontrol_createdby

One-To-Many Relationship: systemuser lk_customcontrol_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_customcontrol_createdonbehalfby

One-To-Many Relationship: systemuser lk_customcontrol_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_customcontrol_modifiedby

One-To-Many Relationship: systemuser lk_customcontrol_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_customcontrol_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_customcontrol_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

customcontrol_resource_id

Many-To-One Relationship: customcontrolresource customcontrol_resource_id

Property	Value
ReferencingEntity	`customcontrolresource`
ReferencingAttribute	`customcontrolid`
ReferencedEntityNavigationPropertyName	`customcontrol_resource_id`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Many-to-Many relationships

These relationships are many-to-many. Listed by SchemaName.

serviceplan_customcontrol

See serviceplan serviceplan_customcontrol Many-To-Many Relationship

Property	Value
IntersectEntityName	`serviceplancustomcontrol`
IsCustomizable	False
SchemaName	`serviceplan_customcontrol`
IntersectAttribute	`customcontrolid`
NavigationPropertyName	`serviceplan_customcontrol_association`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Feedback

Was this page helpful?