Edit

Share via

RoleEditorLayout table/entity reference (Microsoft Dataverse)

Messages

The following table lists the messages for the RoleEditorLayout 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
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /roleeditorlayouts
See Create		 Create records
CreateMultiple
Event: True		 CreateMultiple CreateMultipleRequest
Delete
Event: True		 DELETE /roleeditorlayouts(roleeditorlayoutid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
IsValidStateTransition
Event: False		 IsValidStateTransition IsValidStateTransitionRequest
Retrieve
Event: True		 GET /roleeditorlayouts(roleeditorlayoutid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /roleeditorlayouts
See Query data		 Query data
SetState
Event: True		 PATCH /roleeditorlayouts(roleeditorlayoutid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /roleeditorlayouts(roleeditorlayoutid)
See Update		 Update records
UpdateMultiple
Event: True		 UpdateMultiple UpdateMultipleRequest
Upsert
Event: False		 PATCH /roleeditorlayouts(roleeditorlayoutid)
See Upsert a table row		 UpsertRequest
UpsertMultiple
Event: False		 UpsertMultiple UpsertMultipleRequest

Events

The following table lists the events for the RoleEditorLayout table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name Web API Operation SDK for .NET
BulkRetain BulkRetain Learn to use messages with the SDK for .NET
PurgeRetainedContent PurgeRetainedContent Learn to use messages with the SDK for .NET
Retain Retain Learn to use messages with the SDK for .NET
RollbackRetain RollbackRetain Learn to use messages with the SDK for .NET
ValidateRetentionConfig ValidateRetentionConfig Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the RoleEditorLayout table.

Property Value
DisplayName RoleEditorLayout
DisplayCollectionName RoleEditorLayouts
SchemaName RoleEditorLayout
CollectionSchemaName RoleEditorLayouts
EntitySetName roleeditorlayouts
LogicalName roleeditorlayout
LogicalCollectionName roleeditorlayouts
PrimaryIdAttribute roleeditorlayoutid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

DisplayName

Property Value
Description Display name used for tabs, sections and miscellaneous privileges.
DisplayName DisplayName
IsValidForForm True
IsValidForRead True
LogicalName displayname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 128

EntityLogicalName

Property Value
Description For ItemType Entity: the logicalname of the entity.
DisplayName EntityLogicalName
IsValidForForm True
IsValidForRead True
LogicalName entitylogicalname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsPrivacyRelated

Property Value
Description Whether this is a privacy related miscellaneous privilege.
DisplayName IsPrivacyRelated
IsValidForForm True
IsValidForRead True
LogicalName isprivacyrelated
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName roleeditorlayout_isprivacyrelated
DefaultValue False
True Label Yes
False Label No

ItemType

Property Value
Description The type of role editor layout item.
DisplayName ItemType
IsValidForForm True
IsValidForRead True
LogicalName itemtype
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName roleeditorlayout_itemtype

ItemType Choices/Options

Value Label
1 Root
2 Tab
3 Miscellaneous Section
4 Entity
5 Privilege

Name

Property Value
Description The name of the role editor layout item.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

PrivilegeName

Property Value
Description For ItemType Privilege: Name of the privilege
DisplayName PrivilegeName
IsValidForForm True
IsValidForRead True
LogicalName privilegename
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

RoleEditorLayoutHierarchyId

Property Value
Description Unique identifier for RoleEditorLayout associated with RoleEditorLayout.
DisplayName RoleEditorLayoutHierarchy
IsValidForForm True
IsValidForRead True
LogicalName roleeditorlayouthierarchyid
RequiredLevel None
Type Lookup
Targets roleeditorlayout

RoleEditorLayoutId

Property Value
Description Unique identifier for role editor layout instances
DisplayName Role Editor Layout
IsValidForForm False
IsValidForRead True
LogicalName roleeditorlayoutid
RequiredLevel SystemRequired
Type Uniqueidentifier

TabOrder

Property Value
Description For ItemType Tab: the order of which this tab is for the UI.
DisplayName TabOrder
IsValidForForm True
IsValidForRead True
LogicalName taborder
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Read-only columns/attributes

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

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Type Lookup
Targets

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

Many-to-One relationships

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

organization_roleeditorlayout

One-To-Many Relationship: organization organization_roleeditorlayout

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

roleeditorlayout_roleeditorlayout

One-To-Many Relationship: roleeditorlayout roleeditorlayout_roleeditorlayout

Property Value
ReferencedEntity roleeditorlayout
ReferencedAttribute roleeditorlayoutid
ReferencingAttribute roleeditorlayouthierarchyid
ReferencingEntityNavigationPropertyName RoleEditorLayoutHierarchyId
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

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

roleeditorlayout_AsyncOperations

Many-To-One Relationship: asyncoperation roleeditorlayout_AsyncOperations

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

roleeditorlayout_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure roleeditorlayout_BulkDeleteFailures

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

roleeditorlayout_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord roleeditorlayout_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName roleeditorlayout_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

roleeditorlayout_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord roleeditorlayout_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName roleeditorlayout_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

roleeditorlayout_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder roleeditorlayout_MailboxTrackingFolders

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

roleeditorlayout_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess roleeditorlayout_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName roleeditorlayout_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

roleeditorlayout_ProcessSession

Many-To-One Relationship: processsession roleeditorlayout_ProcessSession

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

roleeditorlayout_roleeditorlayout

Many-To-One Relationship: roleeditorlayout roleeditorlayout_roleeditorlayout

Property Value
ReferencingEntity roleeditorlayout
ReferencingAttribute roleeditorlayouthierarchyid
ReferencedEntityNavigationPropertyName roleeditorlayout_roleeditorlayout
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

roleeditorlayout_SyncErrors

Many-To-One Relationship: syncerror roleeditorlayout_SyncErrors

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

See also

Dataverse table/entity reference
Dataverse Web API Reference
roleeditorlayout