theme EntityType
Information that's used to set custom visual theme options for client applications.
- Entity set path:
- [organization URI]/api/data/v9.2/themes
- Base type:
- crmbaseentity
- Display name:
- Theme
- Primary key:
- themeid
- Primary key attribute:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||
|---|---|---|---|---|---|---|---|---|
| accentcolor | Edm.String |
Choose the Unified Interface secondary theme color to be used on the process control Display name: Accent Color |
||||||
| backgroundcolor | Edm.String |
For internal use only. Display name: Background Color |
||||||
| controlborder | Edm.String |
Choose the color that controls will use for borders Display name: Control Hover Border Color |
||||||
| controlshade | Edm.String |
Choose the background color for controls to use to indicate when you hover over items Display name: Control Hover Fill Color |
||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||
| defaultcustomentitycolor | Edm.String |
Choose the default custom entity color if no color is assigned Display name: Default Custom Entity Color |
||||||
| defaultentitycolor | Edm.String |
Choose the default color for system entities if no color is assigned Display name: Default Entity Color |
||||||
| exchangerate | Edm.Decimal |
Exchange rate for the currency associated with the Theme with respect to the base currency. Display name: ExchangeRate Read only
|
||||||
| globallinkcolor | Edm.String |
Choose the color for all links, such as e-mail address and lookup links, and for all buttons that are in focus Display name: Link and Button Text Color |
||||||
| headercolor | Edm.String |
Choose the color for title text, such as form tab labels Display name: Title Text Color |
||||||
| hoverlinkeffect | Edm.String |
Choose the color that commands or lists will use to indicate hovered over items Display name: Hover Link Color |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| isdefaulttheme | Edm.Boolean |
Default status of theme. Display name: Default Theme
Default options
|
||||||
| logotooltip | Edm.String |
Enter text that will be used as the tooltip and alt text for the logo. Display name: Logo Tooltip |
||||||
| maincolor | Edm.String |
Choose the Unified Interface primary theme color to be used on main command bar, buttons and tabs Display name: Main Color |
||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||
| name | Edm.String |
The name of the Theme Entity. Display name: Theme Name |
||||||
| navbarbackgroundcolor | Edm.String |
Choose the primary Navigation Bar background color Display name: Navigation Bar Fill Color |
||||||
| navbarshelfcolor | Edm.String |
Choose the secondary Navigation Bar background color Display name: Navigation Bar Shelf Fill Color |
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||
| pageheaderbackgroundcolor | Edm.String |
Choose the page header background color Display name: Page Header Fill Color |
||||||
| panelheaderbackgroundcolor | Edm.String |
Choose the panel header background color Display name: Panel Header Fill Color |
||||||
| processcontrolcolor | Edm.String |
Choose the primary background color for process controls Display name: Legacy Accent Color |
||||||
| selectedlinkeffect | Edm.String |
Choose the color that commands or lists will use to indicate selected items Display name: Selected Link Color |
||||||
| statecode | Edm.Int32 |
Status of the Theme Display name: Status Read only
Default options
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the Theme Display name: Status Reason
Default options
|
||||||
| themeid | Edm.Guid |
Unique identifier for entity instances Display name: Theme |
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||
| type | Edm.Boolean |
Define type of theme. Display name: Type
Default options
|
||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||
| versionnumber | Edm.Int64 |
Read onlyy
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _logoid_value | logoimage |
Upload a web resource to use as a logo. Recommended dimensions are a height of 50 pixels and a maximum width of 400 pixels. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _organizationid_value | organizationid |
Unique identifier for the organization |
| _transactioncurrencyid_value | transactioncurrencyid |
Exchange rate for the currency associated with the Theme with respect to the base currency. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_theme_createdby |
| createdonbehalfby | systemuser | lk_theme_createdonbehalfby |
| logoimage | webresource | lk_theme_logoid |
| modifiedby | systemuser | lk_theme_modifiedby |
| modifiedonbehalfby | systemuser | lk_theme_modifiedonbehalfby |
| organizationid | organization | organization_theme |
| transactioncurrencyid | transactioncurrency | TransactionCurrency_Theme |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| theme_AsyncOperations | asyncoperation | regardingobjectid_theme |
| theme_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_theme |
| theme_ProcessSession | processsession | regardingobjectid_theme |
Operations
The following operations can be used with the theme entity type.
| Name | Binding |
|---|---|
| PublishTheme | Bound to Entity |