RoleEditorLayout table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Added by: Role Editor Solution
Messages
| Message | Web API Operation | SDK class or method |
|---|---|---|
| BulkRetain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
| Create | POST /roleeditorlayouts See Create |
CreateRequest or Create |
| CreateMultiple | CreateMultiple | CreateMultipleRequest |
| Delete | DELETE /roleeditorlayouts(roleeditorlayoutid) See Delete |
DeleteRequest or Delete |
| IsValidStateTransition | IsValidStateTransition | IsValidStateTransitionRequest |
| PurgeRetainedContent | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
| Retain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
| Retrieve | GET /roleeditorlayouts(roleeditorlayoutid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET /roleeditorlayouts See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| RollbackRetain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
| SetState | PATCH /roleeditorlayouts(roleeditorlayoutid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH /roleeditorlayouts(roleeditorlayoutid) See Update |
UpdateRequest or Update |
| UpdateMultiple | UpdateMultiple | UpdateMultipleRequest |
| ValidateRetentionConfig | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | RoleEditorLayouts |
| DisplayCollectionName | RoleEditorLayouts |
| DisplayName | RoleEditorLayout |
| EntitySetName | roleeditorlayouts |
| IsBPFEntity | False |
| LogicalCollectionName | roleeditorlayouts |
| LogicalName | roleeditorlayout |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | roleeditorlayoutid |
| PrimaryNameAttribute | name |
| SchemaName | RoleEditorLayout |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- DisplayName
- EntityLogicalName
- IsCustomizable
- IsPrivacyRelated
- ItemType
- Name
- OverriddenCreatedOn
- PrivilegeName
- RoleEditorLayoutHierarchyId
- RoleEditorLayoutId
- TabOrder
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
DisplayName
| Property | Value |
|---|---|
| Description | Display name used for tabs, sections and miscellaneous privileges. |
| DisplayName | DisplayName |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | displayname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
EntityLogicalName
| Property | Value |
|---|---|
| Description | For ItemType Entity: the logicalname of the entity. |
| DisplayName | EntityLogicalName |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | entitylogicalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
IsCustomizable
Added by: Basic Solution Solution
| 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 |
IsPrivacyRelated Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
ItemType
| Property | Value |
|---|---|
| Description | The type of role editor layout item. |
| DisplayName | ItemType |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | itemtype |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
ItemType Choices/Options
| Value | Label | Description |
|---|---|---|
| 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 |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | name |
| MaxLength | 128 |
| RequiredLevel | SystemRequired |
| Type | String |
OverriddenCreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time that the record was migrated. |
| DisplayName | Record Created On |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
PrivilegeName
| Property | Value |
|---|---|
| Description | For ItemType Privilege: Name of the privilege |
| DisplayName | PrivilegeName |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | privilegename |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
RoleEditorLayoutHierarchyId
| Property | Value |
|---|---|
| Description | Unique identifier for RoleEditorLayout associated with RoleEditorLayout. |
| DisplayName | RoleEditorLayoutHierarchy |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | roleeditorlayouthierarchyid |
| RequiredLevel | None |
| Targets | roleeditorlayout |
| Type | Lookup |
RoleEditorLayoutId
| Property | Value |
|---|---|
| Description | Unique identifier for role editor layout instances |
| DisplayName | Role Editor Layout |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| 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 |
| Format | None |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | taborder |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverwriteTime
- RoleEditorLayoutHierarchyIdName
- SolutionId
- SupportingSolutionId
ComponentIdUnique
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
ComponentState Choices/Options
| Value | Label | Description |
|---|---|---|
| 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 |
| Targets | |
| Type | Lookup |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
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 |
| Targets | |
| Type | Lookup |
IsManaged
Added by: Basic Solution Solution
| 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 |
IsManaged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Managed | |
| 0 | Unmanaged |
DefaultValue: 0
ModifiedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Targets | |
| Type | Lookup |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was modified. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
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 |
| Targets | |
| Type | Lookup |
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier for the organization |
| DisplayName | Organization Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | None |
| Targets | |
| Type | Lookup |
OverwriteTime
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
RoleEditorLayoutHierarchyIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | roleeditorlayouthierarchyidname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
SolutionId
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
One-To-Many Relationships
Listed by SchemaName.
- roleeditorlayout_SyncErrors
- roleeditorlayout_DuplicateMatchingRecord
- roleeditorlayout_DuplicateBaseRecord
- roleeditorlayout_AsyncOperations
- roleeditorlayout_MailboxTrackingFolders
- roleeditorlayout_ProcessSession
- roleeditorlayout_BulkDeleteFailures
- roleeditorlayout_PrincipalObjectAttributeAccesses
- roleeditorlayout_roleeditorlayout
roleeditorlayout_SyncErrors
Added by: System Solution Solution
Same as the roleeditorlayout_SyncErrors many-to-one relationship for the syncerror table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_DuplicateMatchingRecord
Added by: System Solution Solution
Same as the roleeditorlayout_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | duplicaterecordid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_DuplicateMatchingRecord |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_DuplicateBaseRecord
Added by: System Solution Solution
Same as the roleeditorlayout_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | baserecordid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_DuplicateBaseRecord |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_AsyncOperations
Added by: System Solution Solution
Same as the roleeditorlayout_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_MailboxTrackingFolders
Added by: System Solution Solution
Same as the roleeditorlayout_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_MailboxTrackingFolders |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_ProcessSession
Added by: System Solution Solution
Same as the roleeditorlayout_ProcessSession many-to-one relationship for the processsession table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_ProcessSession |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_BulkDeleteFailures
Added by: System Solution Solution
Same as the roleeditorlayout_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the roleeditorlayout_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_PrincipalObjectAttributeAccesses |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
roleeditorlayout_roleeditorlayout
Same as the roleeditorlayout_roleeditorlayout many-to-one relationship for the roleeditorlayout table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | roleeditorlayout |
| ReferencingAttribute | roleeditorlayouthierarchyid |
| IsHierarchical | True |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | roleeditorlayout_roleeditorlayout |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.
roleeditorlayout_roleeditorlayout
See the roleeditorlayout_roleeditorlayout one-to-many relationship for the roleeditorlayout table/entity.
organization_roleeditorlayout
Added by: System Solution Solution
See the organization_roleeditorlayout one-to-many relationship for the organization table/entity.
See also
Dataverse table/entity reference
Web API Reference
roleeditorlayout EntityType
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for