systemform EntityType
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 name column:
- 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
|
||||||||||||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||||||||||||
| isdesktopenabled | Edm.Boolean |
Information that specifies whether the dashboard is enabled for desktop. Display name: Is Desktop Enabled
Default options
|
||||||||||||||||||||||||||||||||||||||
| ismanaged | Edm.Boolean |
Display name: State Read only
Default options
|
||||||||||||||||||||||||||||||||||||||
| istabletenabled | Edm.Boolean |
Information that specifies whether the dashboard is enabled for tablet. Display name: Is Tablet Enabled
Default options
|
||||||||||||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||||||||||||
| 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 |