thingsboard · ViacheslavKlimov · Apr 3, 2026
diff --git a/pe/docs/CustomMenuConfig.md b/pe/docs/CustomMenuConfig.md
@@ -3,8 +3,6 @@
 
 `org.thingsboard.client.model.CustomMenuConfig`
 
-A JSON value representing the custom menu configuration
-
 ## Properties
 
 | Name | Type | Description | Notes |

diff --git a/pe/docs/CustomMenuControllerApi.md b/pe/docs/CustomMenuControllerApi.md
@@ -5,7 +5,7 @@
 ```
 CustomMenu createCustomMenu(@Nonnull CustomMenuInfo customMenuInfo, @Nullable List<String> assignToList, @Nullable Boolean force) // Create Custom Menu (createCustomMenu)
 CustomMenuDeleteResult deleteCustomMenu(@Nonnull UUID customMenuId, @Nullable Boolean force) // Delete custom menu (deleteCustomMenu)
-void getCustomMenu(@Nullable String ifNoneMatch) // Get end-user Custom Menu configuration (getCustomMenu)
+CustomMenuConfig getCustomMenu(@Nullable String ifNoneMatch) // Get end-user Custom Menu configuration (getCustomMenu)
 List<EntityInfo> getCustomMenuAssigneeList(@Nonnull UUID customMenuId) // Get Custom Menu assignee list (getCustomMenuAssigneeList)
 CustomMenuConfig getCustomMenuConfig(@Nonnull UUID customMenuId) // Get Custom Menu configuration by id (getCustomMenuConfig)
 CustomMenuInfo getCustomMenuInfoById(@Nonnull UUID customMenuId) // Get Custom Menu Info (getCustomMenuInfoById)
@@ -70,7 +70,7 @@ Deletes the custom menu based on the provided Custom Menu Id. Referencing non-ex
 ## getCustomMenu
 
 ```
-void getCustomMenu(@Nullable String ifNoneMatch)
+CustomMenuConfig getCustomMenu(@Nullable String ifNoneMatch)
 ```
 
 **GET** `/api/customMenu`
@@ -88,7 +88,7 @@ Fetch the Custom Menu configuration object for the authorized user. The custom m
 
 ### Return type
 
-null (empty response body)
+**CustomMenuConfig**
 
 
 ## getCustomMenuAssigneeList

diff --git a/pe/docs/Customer.md b/pe/docs/Customer.md
@@ -17,7 +17,7 @@
 | **address2** | **String** | Address Line 2 | [optional] |
 | **zip** | **String** | Zip code | [optional] |
 | **phone** | **String** | Phone number | [optional] |
-| **email** | **String** | Email | |
+| **email** | **String** | Email | [optional] |
 | **title** | **String** | Title of the customer | |
 | **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
 | **parentCustomerId** | **CustomerId** | JSON object with parent Customer Id | [optional] |

diff --git a/pe/docs/CustomerInfo.md b/pe/docs/CustomerInfo.md
@@ -17,7 +17,7 @@
 | **address2** | **String** | Address Line 2 | [optional] |
 | **zip** | **String** | Zip code | [optional] |
 | **phone** | **String** | Phone number | [optional] |
-| **email** | **String** | Email | |
+| **email** | **String** | Email | [optional] |
 | **title** | **String** | Title of the customer | |
 | **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
 | **parentCustomerId** | **CustomerId** | JSON object with parent Customer Id | [optional] |

diff --git a/pe/docs/DashboardControllerApi.md b/pe/docs/DashboardControllerApi.md
@@ -8,11 +8,11 @@ List<Dashboard> exportGroupDashboards(@Nonnull String entityGroupId, @Nonnull In
 PageDataDashboardInfo getAllDashboards(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable Boolean includeCustomers, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get All Dashboards for current user (getAllDashboards)
 PageDataDashboardInfo getCustomerDashboards(@Nonnull String customerId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable Boolean includeCustomers, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Customer Dashboards (getCustomerDashboards)
 HomeDashboardInfo getCustomerHomeDashboardInfo() // Get Customer Home Dashboard Info (getCustomerHomeDashboardInfo)
-void getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding) // Get Dashboard (getDashboardById)
+Dashboard getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding) // Get Dashboard (getDashboardById)
 DashboardInfo getDashboardInfoById(@Nonnull String dashboardId) // Get Dashboard Info (getDashboardInfoById)
 PageDataDashboardInfo getDashboardsByEntityGroupId(@Nonnull String entityGroupId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get dashboards by Entity Group Id (getDashboardsByEntityGroupId)
 List<DashboardInfo> getDashboardsByIds(@Nonnull List<String> dashboardIds) // Get dashboards by Dashboard Ids (getDashboardsByIds)
-void getHomeDashboard(@Nullable String acceptEncoding) // Get Home Dashboard (getHomeDashboard)
+HomeDashboard getHomeDashboard(@Nullable String acceptEncoding) // Get Home Dashboard (getHomeDashboard)
 HomeDashboardInfo getHomeDashboardInfo() // Get Home Dashboard Info (getHomeDashboardInfo)
 Long getMaxDatapointsLimit() // Get max data points limit (getMaxDatapointsLimit)
 Long getServerTime() // Get server time (getServerTime)
@@ -156,7 +156,7 @@ Returns the home dashboard info object that is configured as 'homeDashboardId' p
 ## getDashboardById
 
 ```
-void getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding)
+Dashboard getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding)
 ```
 
 **GET** `/api/dashboard/{dashboardId}`
@@ -176,7 +176,7 @@ Get the dashboard based on 'dashboardId' parameter. The Dashboard object is a he
 
 ### Return type
 
-null (empty response body)
+**Dashboard**
 
 
 ## getDashboardInfoById
@@ -259,7 +259,7 @@ Returns a list of DashboardInfo objects based on the provided ids. Filters the l
 ## getHomeDashboard
 
 ```
-void getHomeDashboard(@Nullable String acceptEncoding)
+HomeDashboard getHomeDashboard(@Nullable String acceptEncoding)
 ```
 
 **GET** `/api/dashboard/home`
@@ -277,7 +277,7 @@ Returns the home dashboard object that is configured as 'homeDashboardId' parame
 
 ### Return type
 
-null (empty response body)
+**HomeDashboard**
 
 
 ## getHomeDashboardInfo

diff --git a/pe/docs/Device.md b/pe/docs/Device.md
@@ -15,7 +15,7 @@
 | **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
 | **type** | **String** | Device Profile Name | [optional] |
 | **label** | **String** | Label that may be used in widgets | [optional] |
-| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. | |
+| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. If not provided, the default device profile will be used. | [optional] |
 | **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |
 | **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
 | **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |

diff --git a/pe/docs/DeviceInfo.md b/pe/docs/DeviceInfo.md
@@ -15,7 +15,7 @@
 | **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
 | **type** | **String** | Device Profile Name | [optional] |
 | **label** | **String** | Label that may be used in widgets | [optional] |
-| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. | |
+| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. If not provided, the default device profile will be used. | [optional] |
 | **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |
 | **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
 | **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |

diff --git a/pe/docs/DeviceProfileInfo.md b/pe/docs/DeviceProfileInfo.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-| **id** | **EntityId** | JSON object with the entity Id.  | [optional] |
+| **id** | **DeviceProfileId** | JSON object with the Device Profile Id. | [optional] |
 | **name** | **String** | Entity Name | [optional] |
 | **image** | **String** | Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view.  | [optional] |
 | **defaultDashboardId** | **DashboardId** | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details. | [optional] |

diff --git a/pe/docs/EntityGroupInfo.md b/pe/docs/EntityGroupInfo.md
@@ -15,7 +15,7 @@
 | **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity group. May include: 'description' (string), 'isPublic' (boolean, whether this group is shared publicly), 'publicCustomerId' (string, UUID of the public customer associated with this group). | [optional] |
 | **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON with the configuration for UI components: list of columns, settings, actions, etc  | [optional] |
 | **version** | **Long** |  | [optional] |
-| **ownerIds** | **Set\<EntityGroupInfoOwnerIdsInner\>** | List of the entity group owners. | |
+| **ownerIds** | **Set\<EntityId\>** |  | [optional] |
 | **edgeGroupAll** | **Boolean** | Indicates special edge group 'All' that contains all entities and can't be deleted. | [optional] [readonly] |
 | **groupAll** | **Boolean** | Indicates special group 'All' that contains all entities and can't be deleted. | [optional] |
 | **tenantId** | **TenantId** |  | [optional] |

diff --git a/pe/docs/EntityGroupInfoOwnerIdsInner.md b/pe/docs/EntityGroupInfoOwnerIdsInner.md
diff --git a/pe/docs/HomeDashboard.md b/pe/docs/HomeDashboard.md
@@ -0,0 +1,36 @@
+
+# HomeDashboard
+
+`org.thingsboard.client.model.HomeDashboard`
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| **id** | **DashboardId** | JSON object with the dashboard Id. Specify existing dashboard Id to update the dashboard. Referencing non-existing dashboard id will cause error. Omit this field to create new dashboard. | [optional] |
+| **createdTime** | **Long** | Timestamp of the dashboard creation, in milliseconds | [optional] [readonly] |
+| **tenantId** | **TenantId** | JSON object with Tenant Id. Tenant Id of the dashboard can't be changed. | [optional] [readonly] |
+| **customerId** | **CustomerId** | JSON object with Customer Id.  | [optional] |
+| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |
+| **title** | **String** | Title of the dashboard. | [optional] |
+| **name** | **String** | Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard. | [optional] [readonly] |
+| **image** | **String** | Thumbnail picture for rendering of the dashboards in a grid view on mobile devices. | [optional] [readonly] |
+| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
+| **mobileHide** | **Boolean** | Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens. | [optional] [readonly] |
+| **mobileOrder** | **Integer** | Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications | [optional] [readonly] |
+| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** |  | [optional] |
+| **resources** | **List\<ResourceExportData\>** |  | [optional] |
+| **version** | **Long** |  | [optional] |
+| **hideDashboardToolbar** | **Boolean** | Hide dashboard toolbar flag. Useful for rendering dashboards on mobile. | [optional] |
+
+
+
+---
+
+### Conventions
+
+- **Package:** `org.thingsboard.client.model`
+- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
+- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
+- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
+
diff --git a/pe/docs/Role.md b/pe/docs/Role.md
@@ -12,11 +12,12 @@ A JSON value representing the role.
 | **id** | **RoleId** | JSON object with the Role Id. Specify this field to update the Role. Referencing non-existing Role Id will cause error. Omit this field to create new Role. | [optional] |
 | **createdTime** | **Long** | Timestamp of the role creation, in milliseconds | [optional] [readonly] |
 | **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the role. May include: 'description' (string). | [optional] |
-| **tenantId** | **TenantId** | JSON object with Tenant Id. | [readonly] |
+| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
 | **customerId** | **CustomerId** | JSON object with Customer Id.  | [optional] [readonly] |
 | **name** | **String** | Role Name | |
 | **type** | **RoleType** | Type of the role: generic or group | |
-| **permissions** | **com.fasterxml.jackson.databind.JsonNode** |  | [optional] |
+| **permissions** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with the set of permissions. Structure is specific for role type | [optional] [readonly] |
+| **excludedPermissions** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with the set of excluded permissions. Only applicable for generic roles. Structure is the same as permissions | [optional] [readonly] |
 | **version** | **Long** |  | [optional] |
 | **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |
 

diff --git a/pe/docs/RpcV1ControllerApi.md b/pe/docs/RpcV1ControllerApi.md
@@ -26,7 +26,7 @@ Deprecated. See 'Rpc V 2 Controller' instead.  Available for users with 'TENANT_
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the RPC request. | |
 
 ### Return type
 
@@ -51,7 +51,7 @@ Deprecated. See 'Rpc V 2 Controller' instead.  Available for users with 'TENANT_
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the RPC request. | |
 
 ### Return type
 

diff --git a/pe/docs/RpcV2ControllerApi.md b/pe/docs/RpcV2ControllerApi.md
@@ -107,7 +107,7 @@ Sends the one-way remote-procedure call (RPC) request to device. Sends the one-w
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the RPC request. | |
 
 ### Return type
 
@@ -132,7 +132,7 @@ Sends the two-way remote-procedure call (RPC) request to device. Sends the one-w
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the RPC request. | |
 
 ### Return type
 

diff --git a/pe/docs/RuleChainMetaData.md b/pe/docs/RuleChainMetaData.md
@@ -15,6 +15,7 @@ A JSON value representing the rule chain metadata.
 | **nodes** | **List\<RuleNode\>** | List of rule node JSON objects | |
 | **connections** | **List\<NodeConnectionInfo\>** | List of JSON objects that represent connections between rule nodes | |
 | **ruleChainConnections** | **List\<RuleChainConnectionInfo\>** | List of JSON objects that represent connections between rule nodes and other rule chains. | |
+| **notes** | **List\<RuleChainNote\>** | List of sticky notes placed on the rule chain canvas | [optional] |
 
 
 

diff --git a/pe/docs/RuleChainNote.md b/pe/docs/RuleChainNote.md
@@ -0,0 +1,32 @@
+
+# RuleChainNote
+
+`org.thingsboard.client.model.RuleChainNote`
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | Unique identifier of the note on the canvas | [optional] |
+| **x** | **Integer** | Horizontal position of the note on the canvas, in pixels | [optional] |
+| **y** | **Integer** | Vertical position of the note on the canvas, in pixels | [optional] |
+| **width** | **Integer** | Width of the note, in pixels | [optional] |
+| **height** | **Integer** | Height of the note, in pixels | [optional] |
+| **content** | **String** | Markdown or HTML content of the note | [optional] |
+| **backgroundColor** | **String** | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
+| **borderColor** | **String** | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
+| **borderWidth** | **Integer** | Border width of the note in pixels | [optional] |
+| **applyDefaultMarkdownStyle** | **Boolean** | Whether to apply the default markdown stylesheet to the note content | [optional] |
+| **markdownCss** | **String** | Custom CSS styles applied to the note content | [optional] |
+
+
+
+---
+
+### Conventions
+
+- **Package:** `org.thingsboard.client.model`
+- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
+- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
+- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
+
diff --git a/pe/docs/RuleEngineControllerApi.md b/pe/docs/RuleEngineControllerApi.md
@@ -29,7 +29,7 @@ Creates the Message with type 'REST_API_REQUEST' and payload taken from the requ
 |------------- | ------------- | ------------- | -------------|
 | **entityType** | **String** | A string value representing the entity type. For example, 'DEVICE' | |
 | **entityId** | **String** | A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the message. | |
 
 ### Return type
 
@@ -57,7 +57,7 @@ Creates the Message with type 'REST_API_REQUEST' and payload taken from the requ
 | **entityId** | **String** | A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
 | **queueName** | **String** | Queue name to process the request in the rule engine | |
 | **timeout** | **Integer** | Timeout to process the request in milliseconds | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the message. | |
 
 ### Return type
 
@@ -84,7 +84,7 @@ Creates the Message with type 'REST_API_REQUEST' and payload taken from the requ
 | **entityType** | **String** | A string value representing the entity type. For example, 'DEVICE' | |
 | **entityId** | **String** | A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
 | **timeout** | **Integer** | Timeout to process the request in milliseconds | |
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the message. | |
 
 ### Return type
 
@@ -108,7 +108,7 @@ Creates the Message with type 'REST_API_REQUEST' and payload taken from the requ
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **body** | **String** |  | |
+| **body** | **String** | A JSON object representing the message. | |
 
 ### Return type
 

diff --git a/pe/docs/ShortCustomerInfo.md b/pe/docs/ShortCustomerInfo.md
@@ -9,7 +9,7 @@
 |------------ | ------------- | ------------- | -------------|
 | **customerId** | **CustomerId** | JSON object with the customer Id. | [optional] |
 | **title** | **String** | Title of the customer. | [optional] |
-| **isPublic** | **Boolean** | Indicates special 'Public' customer used to embed dashboards on public websites. | [optional] |
+| **_public** | **Boolean** | Indicates special 'Public' customer used to embed dashboards on public websites. | [optional] |