Share via


systemform EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Organization-owned entity customizations including form layout and dashboards.

Entity Set path:[organization URI]/api/data/v8.2/systemforms

Base Type: crmbaseentity EntityType

Display Name: System Form

Primary Key: formid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to systemform

Operations using the systemform entity type.

Properties

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

Name

Type

Details

canbedeleted

BooleanManagedProperty ComplexType

Description: Information that specifies whether this component can be deleted.

Display Name: Can Be Deleted

componentstate

Edm.Int32

Description: For internal use only.

Default Options:

0 : Published
1 : Unpublished
2 : Deleted
3 : Deleted Unpublished

Display Name: Component State

Read-only property

description

Edm.String

Description: Description of the form or dashboard.

Display Name: Description

formactivationstate

Edm.Int32

Description: Specifies the state of the form.

Default Options:

0 : Inactive
1 : Active

Display Name: Form State

formid

Edm.Guid

Description: Unique identifier of the record type form.

formidunique

Edm.Guid

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

Read-only property

formpresentation

Edm.Int32

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

Default Options:

0 : ClassicForm
1 : AirForm

Display Name: AIR Refreshed

formxml

Edm.String

Description: XML representation of the form layout.

introducedversion

Edm.String

Description: Version in which the form is introduced.

Display Name: Introduced Version

isairmerged

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Refreshed

iscustomizable

BooleanManagedProperty ComplexType

Description: Information that specifies whether this component can be customized.

Display Name: Customizable

isdefault

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Default Form

isdesktopenabled

Edm.Boolean

Description: Information that specifies whether the dashboard is enabled for desktop.

Default Options:

1 : Yes
0 : No

Display Name: Is Desktop Enabled

ismanaged

Edm.Boolean

Description:

Default Options:

1 : Managed
0 : Unmanaged

Display Name: State

Read-only property

istabletenabled

Edm.Boolean

Description: Information that specifies whether the dashboard is enabled for tablet.

Default Options:

1 : Yes
0 : No

Display Name: Is Tablet Enabled

name

Edm.String

Description: Name of the form.

Display Name: Name

objecttypecode

Edm.String

Description: Code that represents the record type.

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

publishedon

Edm.DateTimeOffset

Description:

Read-only property

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

type

Edm.Int32

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

Default Options:

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
100 : Other
101 : MainBackup
102 : AppointmentBookBackup
103 : Power BI Dashboard

Display Name: Form Type

uniquename

Edm.String

Description: Unique Name

Display Name: Unique Name

version

Edm.Int32

Description: For internal use only.

versionnumber

Edm.Int64

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

Read-only property

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 Retrieve data about lookup properties

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 EntityType

form_ancestor_form

organizationid

organization EntityType

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 EntityType

ancestorformid

SystemForm_AsyncOperations

asyncoperation EntityType

regardingobjectid_systemform

SystemForm_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_systemform

Operations bound to systemform

The following operations are bound to the systemform entity type.

Name

Bound to

CopySystemForm Action

Entity

RetrieveFilteredForms Function

Collection

RetrieveUnpublishedMultiple Function

Collection

Operations using the systemform entity type.

The following operations use the systemform entity type in a parameter or return type.

Name

How used

Description

CopySystemForm Action

entity Parameter

Creates a new entity form that is based on an existing entity form.

CopySystemForm Action

Target Parameter

Creates a new entity form that is based on an existing entity form.

CopySystemForm Action

ReturnType

Creates a new entity form that is based on an existing entity form.

RetrieveFilteredForms Function

entityset Parameter

Retrieves the entity forms that are available for a specified user.

RetrieveFilteredForms Function

ReturnType

Retrieves the entity forms that are available for a specified user.

RetrieveUnpublishedMultiple Function

entityset Parameter

Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria.

RetrieveUnpublishedMultiple Function

ReturnType

Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright