SystemForm table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Organization-owned entity customizations including form layout and dashboards.
Messages
| Message | Web API Operation | SDK class or method |
|---|---|---|
| CopySystemForm | CopySystemForm | CopySystemFormRequest |
| Create | POST /systemforms See Create |
CreateRequest or Create |
| Delete | DELETE /systemforms(formid) See Delete |
DeleteRequest or Delete |
| Retrieve | GET /systemforms(formid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveFilteredForms | RetrieveFilteredForms | RetrieveFilteredFormsRequest |
| RetrieveMultiple | GET /systemforms See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| RetrieveUnpublished | RetrieveUnpublished | RetrieveUnpublishedRequest |
| RetrieveUnpublishedMultiple | RetrieveUnpublishedMultiple | RetrieveUnpublishedMultipleRequest |
| Update | PATCH /systemforms(formid) See Update |
UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | SystemForms |
| DisplayCollectionName | System Forms |
| DisplayName | System Form |
| EntitySetName | systemforms |
| IsBPFEntity | False |
| LogicalCollectionName | systemforms |
| LogicalName | systemform |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | formid |
| PrimaryNameAttribute | name |
| SchemaName | SystemForm |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AncestorFormId
- CanBeDeleted
- Description
- FormActivationState
- FormId
- FormJson
- FormPresentation
- FormXml
- IntroducedVersion
- IsAIRMerged
- IsCustomizable
- IsDefault
- IsDesktopEnabled
- IsTabletEnabled
- Name
- ObjectTypeCode
- Type
- UniqueName
- Version
AncestorFormId
| Property | Value |
|---|---|
| Description | Unique identifier of the parent form. |
| DisplayName | Parent Form |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | ancestorformid |
| RequiredLevel | None |
| Targets | systemform |
| Type | Lookup |
CanBeDeleted
| Property | Value |
|---|---|
| Description | Information that specifies whether this component can be deleted. |
| DisplayName | Can Be Deleted |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | canbedeleted |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
Description
| Property | Value |
|---|---|
| Description | Description of the form or dashboard. |
| DisplayName | Description |
| Format | Text |
| IsLocalizable | True |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | Memo |
FormActivationState
| Property | Value |
|---|---|
| Description | Specifies the state of the form. |
| DisplayName | Form State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formactivationstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
FormActivationState Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Inactive | |
| 1 | Active |
FormId
| Property | Value |
|---|---|
| Description | Unique identifier of the record type form. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | formid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
FormJson
| Property | Value |
|---|---|
| Description | Json representation of the form layout. |
| DisplayName | |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formjson |
| MaxLength | 1073741823 |
| RequiredLevel | SystemRequired |
| Type | Memo |
FormPresentation
| Property | Value |
|---|---|
| Description | Specifies whether this form is in the updated UI layout in Microsoft Dynamics CRM 2015 or Microsoft Dynamics CRM Online 2015 Update. |
| DisplayName | AIR Refreshed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formpresentation |
| RequiredLevel | SystemRequired |
| Type | Picklist |
FormPresentation Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | ClassicForm | |
| 1 | AirForm | |
| 2 | ConvertedICForm |
FormXml
| Property | Value |
|---|---|
| Description | XML representation of the form layout. |
| DisplayName | |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formxml |
| MaxLength | 1073741823 |
| RequiredLevel | SystemRequired |
| Type | Memo |
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 |
IsAIRMerged
| Property | Value |
|---|---|
| Description | Specifies whether this form is merged with the updated UI layout in Microsoft Dynamics CRM 2015 or Microsoft Dynamics CRM Online 2015 Update. |
| DisplayName | Refreshed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isairmerged |
| RequiredLevel | None |
| Type | Boolean |
IsAIRMerged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
IsCustomizable
| Property | Value |
|---|---|
| Description | Information that specifies whether this component can be customized. |
| DisplayName | Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
IsDefault
| Property | Value |
|---|---|
| Description | Information that specifies whether the form or the dashboard is the system default. |
| DisplayName | Default Form |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isdefault |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsDefault Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
IsDesktopEnabled
| Property | Value |
|---|---|
| Description | Information that specifies whether the dashboard is enabled for desktop. |
| DisplayName | Is Desktop Enabled |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isdesktopenabled |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsDesktopEnabled Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
IsTabletEnabled
| Property | Value |
|---|---|
| Description | Information that specifies whether the dashboard is enabled for tablet. |
| DisplayName | Is Tablet Enabled |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | istabletenabled |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsTabletEnabled Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
Name
| Property | Value |
|---|---|
| Description | Name of the form. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ObjectTypeCode
| Property | Value |
|---|---|
| Description | Code that represents the record type. |
| DisplayName | Entity Name |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | objecttypecode |
| RequiredLevel | None |
| Type | EntityName |
Type
| Property | Value |
|---|---|
| Description | Type of the form, for example, Dashboard or Preview. |
| DisplayName | Form Type |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | type |
| RequiredLevel | None |
| Type | Picklist |
Type Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Dashboard | |
| 1 | AppointmentBook | |
| 2 | Main | |
| 3 | MiniCampaignBO | |
| 4 | Preview | |
| 5 | Mobile - Express | |
| 6 | Quick View Form | |
| 7 | Quick Create | |
| 8 | Dialog | |
| 9 | Task Flow Form | |
| 10 | InteractionCentricDashboard | |
| 11 | Card | |
| 12 | Main - Interactive experience | |
| 13 | Contextual Dashboard | |
| 100 | Other | |
| 101 | MainBackup | |
| 102 | AppointmentBookBackup | |
| 103 | Power BI Dashboard |
UniqueName
| Property | Value |
|---|---|
| Description | Unique Name |
| DisplayName | Unique Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | uniquename |
| MaxLength | 200 |
| RequiredLevel | None |
| Type | String |
Version
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | version |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | None |
| Type | Integer |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- AncestorFormIdName
- ComponentState
- FormIdUnique
- FormXmlManaged
- IsManaged
- OrganizationId
- OrganizationIdName
- OverwriteTime
- PublishedOn
- SolutionId
- SupportingSolutionId
- VersionNumber
AncestorFormIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ancestorformidname |
| MaxLength | 50 |
| RequiredLevel | None |
| Type | String |
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 |
FormIdUnique
| Property | Value |
|---|---|
| Description | Unique identifier of the form used when synchronizing customizations for the Microsoft Dynamics 365 client for Outlook. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
FormXmlManaged
| Property | Value |
|---|---|
| Description | formXml diff as in a managed solution. for internal use only |
| DisplayName | |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formxmlmanaged |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
IsManaged
| Property | Value |
|---|---|
| Description | |
| DisplayName | State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsManaged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Managed | |
| 0 | Unmanaged |
DefaultValue: 0
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier of the organization. |
| DisplayName | |
| 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 |
PublishedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | |
| DisplayName | Published On |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | publishedon |
| RequiredLevel | None |
| 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 | Represents a version of customizations to be synchronized with the Microsoft Dynamics 365 client for Outlook. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- form_ancestor_form
- SystemForm_AsyncOperations
- processtrigger_systemform
- SystemForm_BulkDeleteFailures
form_ancestor_form
Same as the form_ancestor_form many-to-one relationship for the systemform table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | systemform |
| ReferencingAttribute | ancestorformid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | form_ancestor_form |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
SystemForm_AsyncOperations
Same as the SystemForm_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | SystemForm_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
processtrigger_systemform
Same as the processtrigger_systemform many-to-one relationship for the processtrigger table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | processtrigger |
| ReferencingAttribute | formid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | processtrigger_systemform |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
SystemForm_BulkDeleteFailures
Same as the SystemForm_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | SystemForm_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade 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.
form_ancestor_form
See the form_ancestor_form one-to-many relationship for the systemform table/entity.
organization_systemforms
See the organization_systemforms one-to-many relationship for the organization table/entity.
See also
Dataverse table/entity reference
Web API Reference
systemform EntityType
Feedback
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: https://aka.ms/ContentUserFeedback.
Submit and view feedback for