Theme Entity Reference

Information that's used to set custom visual theme options for client applications.

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/themes
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/themes(themeid)
See Delete
DeleteRequest or
Delete
PublishTheme PublishTheme Action PublishThemeRequest
Retrieve GET [org URI]/api/data/v9.0/themes(themeid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/themes
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/themes(themeid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Themes
DisplayCollectionName Themes
DisplayName Theme
EntitySetName themes
IsBPFEntity False
LogicalCollectionName themes
LogicalName theme
OwnershipType OrganizationOwned
PrimaryIdAttribute themeid
PrimaryNameAttribute name
SchemaName Theme

Writable attributes

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

AccentColor

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

BackgroundColor

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

ControlBorder

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

ControlShade

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

DefaultCustomEntityColor

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

DefaultEntityColor

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

GlobalLinkColor

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

HeaderColor

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

HoverLinkEffect

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

ImportSequenceNumber

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

IsDefaultTheme

Property Value
Description Default status of theme.
DisplayName Default Theme
IsValidForForm True
IsValidForRead True
LogicalName isdefaulttheme
RequiredLevel SystemRequired
Type Boolean

IsDefaultTheme Options

Value Label
1 Yes
0 No

DefaultValue: False

LogoId

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

LogoToolTip

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

MainColor

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

Name

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

NavBarBackgroundColor

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

NavBarShelfColor

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

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

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

ProcessControlColor

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

SelectedLinkEffect

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

statuscode

Property Value
Description Reason for the status of the Theme
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Options

Value Label State
1 Custom 0
2 System 1

ThemeId

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

TransactionCurrencyId

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

Type

Property Value
Description Define type of theme.
DisplayName Type
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName type
RequiredLevel SystemRequired
Type Boolean

Type Options

Value Label
1 Custom
0 System

DefaultValue: True

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 attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

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 systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

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 systemuser
Type Lookup

CreatedOnBehalfByName

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

ExchangeRate

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

LogoIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName logoidname
MaxLength 400
RequiredLevel None
Type String

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 systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

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 systemuser
Type Lookup

ModifiedOnBehalfByName

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

OrganizationId

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

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

statecode

Property Value
Description Status of the Theme
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode 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

VersionNumber

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.

theme_AsyncOperations

Same as asyncoperation entity theme_AsyncOperations Many-To-One relationship.

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

theme_ProcessSession

Same as processsession entity theme_ProcessSession Many-To-One relationship.

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

theme_BulkDeleteFailures

Same as bulkdeletefailure entity theme_BulkDeleteFailures Many-To-One relationship.

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.

lk_theme_createdby

See systemuser Entity lk_theme_createdby One-To-Many relationship.

lk_theme_createdonbehalfby

See systemuser Entity lk_theme_createdonbehalfby One-To-Many relationship.

lk_theme_modifiedby

See systemuser Entity lk_theme_modifiedby One-To-Many relationship.

lk_theme_modifiedonbehalfby

See systemuser Entity lk_theme_modifiedonbehalfby One-To-Many relationship.

organization_theme

See organization Entity organization_theme One-To-Many relationship.

TransactionCurrency_Theme

See transactioncurrency Entity TransactionCurrency_Theme One-To-Many relationship.

lk_theme_logoid

See webresource Entity lk_theme_logoid One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
theme EntityType