userform EntityType

Entity Set Path
[organization URI]/api/data/v9.0/userforms
Base Type
crmbaseentity
Display Name
User Dashboard
Primary Key
userformid
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
createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read Only
description Edm.String

Type additional information to describe the form or dashboard, such as the filter criteria or intended audience.

Display Name: Description

formjson Edm.String

Json representation of the form layout.

Display Name: Json representation of the form layout.

formxml Edm.String

Shows the XML representation of the layout of the form or dashboard.

istabletenabled Edm.Boolean

Information that specifies whether the dashboard is enabled for tablet.

Display Name: Is Tablet Enabled

Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read Only
name Edm.String

Type a descriptive name for the form or dashboard.

Display Name: Name

objecttypecode Edm.String

Shows the record type (entity) code that the form applies to.

type Edm.Int32

Select the form type.

Display Name: Form Type

Default Options
Value Label
0 Dashboard
103 Power BI Dashboard
userformid Edm.Guid

Unique identifier of the user dashboard.

Display Name: User Dashboard

versionnumber Edm.Int64
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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who created the record on behalf of another user.

_ownerid_value ownerid

Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value owningbusinessunit

Shows the business unit that the record owner belongs to.

_owningteam_value owningteam

Unique identifier of the team who owns the dashboard.

_owninguser_value owninguser

Unique identifier of the user who owns the dashboard.

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
createdby systemuser lk_userform_createdby
createdonbehalfby systemuser lk_userformbase_createdonbehalfby
modifiedby systemuser lk_userform_modifiedby
modifiedonbehalfby systemuser lk_userformbase_modifiedonbehalfby
ownerid principal owner_userform
owningbusinessunit businessunit business_unit_userform
owningteam team team_userform
owninguser systemuser user_userform

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
UserForm_AsyncOperations asyncoperation regardingobjectid_userform
UserForm_BulkDeleteFailures bulkdeletefailure regardingobjectid_userform

Operations

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

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the userform entity type.

Name Description
System Solution Internal CRM System Solution

See Also