CustomControl table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
For internal use only.
Messages
Message | Web API Operation | SDK class or method |
---|---|---|
Create | POST /customcontrols See Create |
CreateRequest or Create |
Delete | DELETE /customcontrols(customcontrolid) See Delete |
DeleteRequest or Delete |
Retrieve | GET /customcontrols(customcontrolid) See Retrieve |
RetrieveRequest or Retrieve |
RetrieveMultiple | GET /customcontrols See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
Update | PATCH /customcontrols(customcontrolid) See Update |
UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | CustomControls |
DisplayCollectionName | Custom Controls |
DisplayName | Custom Control |
EntitySetName | customcontrols |
IsBPFEntity | False |
LogicalCollectionName | customcontrols |
LogicalName | customcontrol |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | customcontrolid |
PrimaryNameAttribute | name |
SchemaName | CustomControl |
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 |
Format | TextArea |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | authoringmanifest |
MaxLength | 1073741823 |
RequiredLevel | None |
Type | Memo |
ClientJson
Property | Value |
---|---|
Description | Custom control data in JSON format. |
DisplayName | Custom control data in JSON format. |
Format | TextArea |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | clientjson |
MaxLength | 1073741823 |
RequiredLevel | None |
Type | Memo |
CompatibleDataTypes
Property | Value |
---|---|
Description | Compatible Data Types For Custom Controls |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | compatibledatatypes |
MaxLength | 1000 |
RequiredLevel | SystemRequired |
Type | String |
CustomControlId
Property | Value |
---|---|
Description | Unique identifier of the Custom Control for the Microsoft Dynamics 365. |
DisplayName | Custom Control Identifier |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | customcontrolid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
IntroducedVersion
Property | Value |
---|---|
Description | Version in which the form is introduced. |
DisplayName | Introduced Version |
FormatName | VersionNumber |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | introducedversion |
MaxLength | 48 |
RequiredLevel | None |
Type | String |
Manifest
Property | Value |
---|---|
Description | Manifest of the CustomControl. |
DisplayName | Manifest |
Format | TextArea |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | manifest |
MaxLength | 1073741823 |
RequiredLevel | SystemRequired |
Type | Memo |
Name
Property | Value |
---|---|
Description | Name of the custom control. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | name |
MaxLength | 200 |
RequiredLevel | SystemRequired |
Type | String |
SupportedPlatform
Added by: Base Custom Controls Core Extensions Solution
Property | Value |
---|---|
Description | Supported platforms of the CustomControl. |
DisplayName | Supported Platforms |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | supportedplatform |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Version
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | version |
MaxLength | 40 |
RequiredLevel | SystemRequired |
Type | String |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- CustomControlIdUnique
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- 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 |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
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 |
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 |
CreatedByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the record was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
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 |
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 |
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 |
IsManaged Choices/Options
Value | Label | Description |
---|---|---|
1 | Managed | |
0 | Unmanaged |
DefaultValue: 0
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who modified the record. |
DisplayName | Modified By |
IsValidForForm | True |
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 |
ModifiedByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the record was modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
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 |
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 of the organization associated with the custom control. |
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 |
OverwriteTime
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | For internal use only. |
DisplayName | Record 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 | 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 |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
customcontrol_resource_id
Same as the customcontrol_resource_id many-to-one relationship for the customcontrolresource table/entity.
Property | Value |
---|---|
ReferencingEntity | customcontrolresource |
ReferencingAttribute | customcontrolid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | customcontrol_resource_id |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
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_customcontrol_createdby
- lk_customcontrol_createdonbehalfby
- customcontrol_organization
- lk_customcontrol_modifiedonbehalfby
- lk_customcontrol_modifiedby
lk_customcontrol_createdby
See the lk_customcontrol_createdby one-to-many relationship for the systemuser table/entity.
lk_customcontrol_createdonbehalfby
See the lk_customcontrol_createdonbehalfby one-to-many relationship for the systemuser table/entity.
customcontrol_organization
See the customcontrol_organization one-to-many relationship for the organization table/entity.
lk_customcontrol_modifiedonbehalfby
See the lk_customcontrol_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
lk_customcontrol_modifiedby
See the lk_customcontrol_modifiedby one-to-many relationship for the systemuser table/entity.
Many-To-Many Relationships
Relationship details provided where the CustomControl table is the first table in the relationship. Listed by SchemaName.
serviceplan_customcontrol
See the serviceplan_customcontrol many-to-many relationship for the serviceplan table/entity.
See also
Dataverse table/entity reference
Web API Reference
customcontrol EntityType
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for