systemform EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

Organization-owned entity customizations including form layout and dashboards.

Entity Set Path
[organization URI]/api/data/v9.2/systemforms
Base Type
crmbaseentity
Display Name
System Form
Primary Key
formid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
canbedeleted BooleanManagedProperty

Information that specifies whether this component can be deleted.

Display Name: Can Be Deleted
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
description Edm.String

Description of the form or dashboard.

Display Name: Description
formactivationstate Edm.Int32

Specifies the state of the form.

Display Name: Form State

Default Options
Values Label
0 Inactive
1 Active
formid Edm.Guid

Unique identifier of the record type form.

formidunique Edm.Guid

Unique identifier of the form used when synchronizing customizations for the Microsoft Dynamics 365 client for Outlook.

Read Only
formjson Edm.String

Json representation of the form layout.

formpresentation Edm.Int32

Specifies whether this form is in the updated UI layout in Microsoft Dynamics CRM 2015 or Microsoft Dynamics CRM Online 2015 Update.

Display Name: AIR Refreshed

Default Options
Values Label
0 ClassicForm
1 AirForm
2 ConvertedICForm
formxml Edm.String

XML representation of the form layout.

formxmlmanaged Edm.String

formXml diff as in a managed solution. for internal use only

Read Only
introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version
isairmerged Edm.Boolean

Specifies whether this form is merged with the updated UI layout in Microsoft Dynamics CRM 2015 or Microsoft Dynamics CRM Online 2015 Update.

Display Name: Refreshed

Default Options
Values Label
1 Yes
0 No
iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable
isdefault Edm.Boolean

Information that specifies whether the form or the dashboard is the system default.

Display Name: Default Form

Default Options
Values Label
1 Yes
0 No
isdesktopenabled Edm.Boolean

Information that specifies whether the dashboard is enabled for desktop.

Display Name: Is Desktop Enabled

Default Options
Values Label
1 Yes
0 No
ismanaged Edm.Boolean

Display Name: State

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
istabletenabled Edm.Boolean

Information that specifies whether the dashboard is enabled for tablet.

Display Name: Is Tablet Enabled

Default Options
Values Label
1 Yes
0 No
name Edm.String

Name of the form.

Display Name: Name
objecttypecode Edm.String

Code that represents the record type.

Display Name: Entity Name
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
publishedon Edm.DateTimeOffset

Display Name: Published On

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
type Edm.Int32

Type of the form, for example, Dashboard or Preview.

Display Name: Form Type

Default Options
Values Label
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 Edm.String

Unique Name

Display Name: Unique Name
version Edm.Int32

For internal use only.

versionnumber Edm.Int64

Represents a version of customizations to be synchronized with the Microsoft Dynamics 365 client for Outlook.

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_ancestorformid_value ancestorformid

Unique identifier of the parent form.
_organizationid_value organizationid

Unique identifier of the organization.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
ancestorformid systemform form_ancestor_form
organizationid organization organization_systemforms

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
form_ancestor_form systemform ancestorformid
processtrigger_systemform processtrigger formid
SystemForm_AsyncOperations asyncoperation regardingobjectid_systemform
SystemForm_BulkDeleteFailures bulkdeletefailure regardingobjectid_systemform

Operations

The following operations can be used with the systemform entity type.

Name Binding
CopySystemForm Bound to Entity
RetrieveFilteredForms Bound to Collection
RetrieveUnpublished Bound to Entity
RetrieveUnpublishedMultiple Bound to Collection

See also