title
description
ms.date
ms.topic
ms.assetid
author
ms.author
search.audienceType
Theme entity reference (Dynamics 365 Customer Engagement) | Microsoft Docs
Includes schema information and supported messages for the Theme entity.
08/30/2022
reference
3948cc48-07c8-7f60-0608-71c37158ad7c
KumarVivek
matp
Information that's used to set custom visual theme options for client applications.
Message
SDK class or method
Create
xref:Microsoft.Xrm.Sdk.Messages.CreateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Create*
Delete
xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete*
PublishTheme
xref:Microsoft.Crm.Sdk.Messages.PublishThemeRequest
Retrieve
xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve*
RetrieveMultiple
xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple*
Update
xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Update*
Property
Value
CollectionSchemaName
Themes
DisplayCollectionName
Themes
DisplayName
Theme
EntitySetName
themes
IsBPFEntity
False
LogicalCollectionName
themes
LogicalName
theme
OwnershipType
OrganizationOwned
PrimaryIdAttribute
themeid
PrimaryNameAttribute
name
SchemaName
Theme
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName .
Property
Value
Description
Choose the Unified Interface secondary theme color to be used on the process control
DisplayName
Accent Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
accentcolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
For internal use only.
DisplayName
Background Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
backgroundcolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the color that controls will use for borders
DisplayName
Control Hover Border Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
controlborder
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the background color for controls to use to indicate when you hover over items
DisplayName
Control Hover Fill Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
controlshade
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the default custom entity color if no color is assigned
DisplayName
Default Custom Entity Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
defaultcustomentitycolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the default color for system entities if no color is assigned
DisplayName
Default Entity Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
defaultentitycolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the color for all links, such as e-mail address and lookup links, and for all buttons that are in focus
DisplayName
Link and Button Text Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
globallinkcolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the color for title text, such as form tab labels
DisplayName
Title Text Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
headercolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the color that commands or lists will use to indicate hovered over items
DisplayName
Hover Link Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
hoverlinkeffect
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Sequence number of the import that created this record.
DisplayName
Import Sequence Number
Format
None
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
importsequencenumber
MaxValue
2147483647
MinValue
-2147483648
RequiredLevel
None
Type
Integer
Property
Value
Description
Default status of theme.
DisplayName
Default Theme
IsValidForForm
True
IsValidForRead
True
LogicalName
isdefaulttheme
RequiredLevel
SystemRequired
Type
Boolean
IsDefaultTheme Choices/Options
Value
Label
Description
1
Yes
0
No
DefaultValue : 0
Property
Value
Description
Upload a web resource to use as a logo. Recommended dimensions are a height of 50 pixels and a maximum width of 400 pixels.
DisplayName
Logo
IsValidForForm
True
IsValidForRead
True
LogicalName
logoid
RequiredLevel
None
Targets
webresource
Type
Lookup
Property
Value
Description
Enter text that will be used as the tooltip and alt text for the logo.
DisplayName
Logo Tooltip
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
logotooltip
MaxLength
80
RequiredLevel
None
Type
String
Property
Value
Description
Choose the Unified Interface primary theme color to be used on main command bar, buttons and tabs
DisplayName
Main Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
maincolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
The name of the Theme Entity.
DisplayName
Theme Name
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
name
MaxLength
100
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Choose the primary Navigation Bar background color
DisplayName
Navigation Bar Fill Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
navbarbackgroundcolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the secondary Navigation Bar background color
DisplayName
Navigation Bar Shelf Fill Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
navbarshelfcolor
MaxLength
7
RequiredLevel
None
Type
String
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
PageHeaderBackgroundColor
Property
Value
Description
Choose the page header background color
DisplayName
Page Header Fill Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
pageheaderbackgroundcolor
MaxLength
7
RequiredLevel
None
Type
String
PanelHeaderBackgroundColor
Property
Value
Description
Choose the panel header background color
DisplayName
Panel Header Fill Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
panelheaderbackgroundcolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the primary background color for process controls
DisplayName
Legacy Accent Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
processcontrolcolor
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Choose the color that commands or lists will use to indicate selected items
DisplayName
Selected Link Color
FormatName
Text
IsLocalizable
False
IsValidForForm
True
IsValidForRead
True
LogicalName
selectedlinkeffect
MaxLength
7
RequiredLevel
None
Type
String
Property
Value
Description
Reason for the status of the Theme
DisplayName
Status Reason
IsValidForForm
True
IsValidForRead
True
LogicalName
statuscode
RequiredLevel
None
Type
Status
statuscode Choices/Options
Value
Label
State
1
Custom
0
2
System
1
Property
Value
Description
Unique identifier for entity instances
DisplayName
Theme
IsValidForForm
False
IsValidForRead
True
IsValidForUpdate
False
LogicalName
themeid
RequiredLevel
SystemRequired
Type
Uniqueidentifier
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
Property
Value
Description
Exchange rate for the currency associated with the Theme with respect to the base currency.
DisplayName
Currency
IsValidForForm
True
IsValidForRead
True
LogicalName
transactioncurrencyid
RequiredLevel
None
Targets
transactioncurrency
Type
Lookup
Property
Value
Description
Define type of theme.
DisplayName
Type
IsValidForForm
True
IsValidForRead
True
IsValidForUpdate
False
LogicalName
type
RequiredLevel
SystemRequired
Type
Boolean
Value
Label
Description
1
Custom
0
System
DefaultValue : 1
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
These attributes return false for both IsValidForCreate or IsValidForUpdate . Listed by SchemaName .
Property
Value
Description
Unique identifier of the user who created the record.
DisplayName
Created By
IsValidForForm
True
IsValidForRead
True
LogicalName
createdby
RequiredLevel
None
Targets
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdbyname
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdbyyominame
MaxLength
100
RequiredLevel
SystemRequired
Type
String
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
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
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdonbehalfbyname
MaxLength
100
RequiredLevel
None
Type
String
CreatedOnBehalfByYomiName
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
createdonbehalfbyyominame
MaxLength
100
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Exchange rate for the currency associated with the Theme with respect to the base currency.
DisplayName
ExchangeRate
IsValidForForm
True
IsValidForRead
True
LogicalName
exchangerate
MaxValue
100000000000
MinValue
0.0000000001
Precision
10
RequiredLevel
None
Type
Decimal
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
logoidname
MaxLength
400
RequiredLevel
None
Type
String
Property
Value
Description
Unique identifier of the user who modified the record.
DisplayName
Modified By
IsValidForForm
True
IsValidForRead
True
LogicalName
modifiedby
RequiredLevel
None
Targets
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedbyname
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedbyyominame
MaxLength
100
RequiredLevel
SystemRequired
Type
String
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
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
systemuser
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedonbehalfbyname
MaxLength
100
RequiredLevel
None
Type
String
ModifiedOnBehalfByYomiName
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
modifiedonbehalfbyyominame
MaxLength
100
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Unique identifier for the organization
DisplayName
Organization Id
IsValidForForm
False
IsValidForRead
True
LogicalName
organizationid
RequiredLevel
None
Targets
organization
Type
Lookup
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
organizationidname
MaxLength
100
RequiredLevel
SystemRequired
Type
String
Property
Value
Description
Status of the Theme
DisplayName
Status
IsValidForForm
True
IsValidForRead
True
LogicalName
statecode
RequiredLevel
SystemRequired
Type
State
statecode Choices/Options
Value
Label
DefaultStatus
InvariantName
0
Custom
1
Active
1
System
2
Inactive
TransactionCurrencyIdName
Property
Value
Description
DisplayName
FormatName
Text
IsLocalizable
False
IsValidForForm
False
IsValidForRead
True
LogicalName
transactioncurrencyidname
MaxLength
100
RequiredLevel
None
Type
String
Property
Value
Description
DisplayName
IsValidForForm
False
IsValidForRead
True
LogicalName
versionnumber
MaxValue
9223372036854775807
MinValue
-9223372036854775808
RequiredLevel
None
Type
BigInt
One-To-Many Relationships
Listed by SchemaName .
Same as the theme_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property
Value
ReferencingEntity
asyncoperation
ReferencingAttribute
regardingobjectid
IsHierarchical
False
IsCustomizable
True
ReferencedEntityNavigationPropertyName
theme_AsyncOperations
AssociatedMenuConfiguration
Behavior: UseCollectionName Group: Details Label: Order:
CascadeConfiguration
Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade
Same as the theme_ProcessSession many-to-one relationship for the processsession entity.
Property
Value
ReferencingEntity
processsession
ReferencingAttribute
regardingobjectid
IsHierarchical
False
IsCustomizable
True
ReferencedEntityNavigationPropertyName
theme_ProcessSession
AssociatedMenuConfiguration
Behavior: UseCollectionName Group: Details Label: Order:
CascadeConfiguration
Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade
Same as the theme_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
Property
Value
ReferencingEntity
bulkdeletefailure
ReferencingAttribute
regardingobjectid
IsHierarchical
False
IsCustomizable
True
ReferencedEntityNavigationPropertyName
theme_BulkDeleteFailures
AssociatedMenuConfiguration
Behavior: UseCollectionName Group: Details Label: Order:
CascadeConfiguration
Assign: NoCascade Delete: Cascade 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 entity. Listed by SchemaName .
See the lk_theme_createdby one-to-many relationship for the systemuser entity.
lk_theme_createdonbehalfby
See the lk_theme_createdonbehalfby one-to-many relationship for the systemuser entity.
See the lk_theme_modifiedby one-to-many relationship for the systemuser entity.
lk_theme_modifiedonbehalfby
See the lk_theme_modifiedonbehalfby one-to-many relationship for the systemuser entity.
See the organization_theme one-to-many relationship for the organization entity.
TransactionCurrency_Theme
See the TransactionCurrency_Theme one-to-many relationship for the transactioncurrency entity.
See the lk_theme_logoid one-to-many relationship for the webresource entity.
About the Entity Reference
Web API EntityType Reference