User Dashboard (UserForm) table/entity reference

Artigo
11/09/2024

User-owned dashboards.

Messages

The following table lists the messages for the User Dashboard (UserForm) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Assign` Event: True	`PATCH` /userforms(userformid) Update the `ownerid` property.	AssignRequest
`Create` Event: False	`POST` /userforms See Create	Create records
`Delete` Event: True	`DELETE` /userforms(userformid) See Delete	Delete records
`GrantAccess` Event: True	GrantAccess	GrantAccessRequest
`ModifyAccess` Event: True	ModifyAccess	ModifyAccessRequest
`Retrieve` Event: True	`GET` /userforms(userformid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /userforms See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`RetrieveSharedPrincipalsAndAccess` Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
`RevokeAccess` Event: True	RevokeAccess	RevokeAccessRequest
`Update` Event: True	`PATCH` /userforms(userformid) See Update	Update records
`Upsert` Event: False	`PATCH` /userforms(userformid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the User Dashboard (UserForm) table.

Property	Value
DisplayName	User Dashboard
DisplayCollectionName	User Dashboards
SchemaName	`UserForm`
CollectionSchemaName	`UserForms`
EntitySetName	`userforms`
LogicalName	`userform`
LogicalCollectionName	`userforms`
PrimaryIdAttribute	`userformid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`UserOwned`

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Description
FormJson
FormXml
IsTabletEnabled
Name
ObjectTypeCode
OwnerId
OwnerIdType
Type
UserFormId

Description

Property	Value
Description	Type additional information to describe the form or dashboard, such as the filter criteria or intended audience.
DisplayName	Description
IsValidForForm	False
IsValidForRead	True
LogicalName	`description`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

FormJson

Property	Value
Description	Json representation of the form layout.
DisplayName	Json representation of the form layout.
IsValidForForm	False
IsValidForRead	True
LogicalName	`formjson`
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

FormXml

Property	Value
Description	Shows the XML representation of the layout of the form or dashboard.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`formxml`
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

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
GlobalChoiceName	`userform_istabletenabled`
DefaultValue	False
True Label	Yes
False Label	No

Name

Property	Value
Description	Type a descriptive name for the form or dashboard.
DisplayName	Name
IsValidForForm	False
IsValidForRead	True
LogicalName	`name`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

ObjectTypeCode

Property	Value
Description	Shows the record type (entity) code that the form applies to.
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`objecttypecode`
RequiredLevel	None
Type	EntityName

OwnerId

Property	Value
Description	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.
DisplayName	Owner
IsValidForForm	False
IsValidForRead	True
LogicalName	`ownerid`
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridtype`
RequiredLevel	SystemRequired
Type	EntityName

Type

Property	Value
Description	Select the form type.
DisplayName	Form Type
IsValidForForm	False
IsValidForRead	True
LogicalName	`type`
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	`userform_type`

Type Choices/Options

Value	Label
0	Dashboard
103	Power BI Dashboard

UserFormId

Property	Value
Description	Unique identifier of the user dashboard.
DisplayName	User Dashboard
IsValidForForm	False
IsValidForRead	True
LogicalName	`userformid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
OwningTeam
OwningUser
VersionNumber

CreatedBy

Property	Value
Description	Shows who created the record.
DisplayName	Created By
IsValidForForm	False
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	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.
DisplayName	Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	False
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	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.
DisplayName	Modified On
IsValidForForm	False
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OwnerIdName

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridyominame`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Shows the business unit that the record owner belongs to.
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	`owningbusinessunit`
RequiredLevel	None
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier of the team who owns the dashboard.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	`owningteam`
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier of the user who owns the dashboard.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	`owninguser`
RequiredLevel	None
Type	Lookup
Targets	systemuser

VersionNumber

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`versionnumber`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_userform
lk_userform_createdby
lk_userform_modifiedby
lk_userformbase_createdonbehalfby
lk_userformbase_modifiedonbehalfby
owner_userform
team_userform
user_userform

business_unit_userform

One-To-Many Relationship: businessunit business_unit_userform

Property	Value
ReferencedEntity	`businessunit`
ReferencedAttribute	`businessunitid`
ReferencingAttribute	`owningbusinessunit`
ReferencingEntityNavigationPropertyName	`owningbusinessunit`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_userform_createdby

One-To-Many Relationship: systemuser lk_userform_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_userform_modifiedby

One-To-Many Relationship: systemuser lk_userform_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_userformbase_createdonbehalfby

One-To-Many Relationship: systemuser lk_userformbase_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_userformbase_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_userformbase_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

owner_userform

One-To-Many Relationship: owner owner_userform

Property	Value
ReferencedEntity	`owner`
ReferencedAttribute	`ownerid`
ReferencingAttribute	`ownerid`
ReferencingEntityNavigationPropertyName	`ownerid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

team_userform

One-To-Many Relationship: team team_userform

Property	Value
ReferencedEntity	`team`
ReferencedAttribute	`teamid`
ReferencingAttribute	`owningteam`
ReferencingEntityNavigationPropertyName	`owningteam`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

user_userform

One-To-Many Relationship: systemuser user_userform

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`owninguser`
ReferencingEntityNavigationPropertyName	`owninguser`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

UserForm_AsyncOperations
UserForm_BulkDeleteFailures

UserForm_AsyncOperations

Many-To-One Relationship: asyncoperation UserForm_AsyncOperations

Property	Value
ReferencingEntity	`asyncoperation`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`UserForm_AsyncOperations`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

UserForm_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure UserForm_BulkDeleteFailures

Property	Value
ReferencingEntity	`bulkdeletefailure`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`UserForm_BulkDeleteFailures`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Compartilhar via