Skip to content

Commit e332075

Browse files
author
TeamCity
committed
Update CE OpenAPI spec (from master)
1 parent d9b1560 commit e332075

24 files changed

+1536
-163
lines changed

ce/docs/AssetProfileInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
| **id** | **EntityId** | JSON object with the entity Id. | [optional] |
10+
| **id** | **AssetProfileId** | JSON object with the Asset Profile Id. | [optional] |
1111
| **name** | **String** | Entity Name | [optional] |
1212
| **image** | **String** | Either URL or Base64 data of the icon. Used in the mobile application to visualize set of asset profiles in the grid view. | [optional] |
1313
| **defaultDashboardId** | **DashboardId** | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to asset details. | [optional] |

ce/docs/Customer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
| **address2** | **String** | Address Line 2 | [optional] |
1717
| **zip** | **String** | Zip code | [optional] |
1818
| **phone** | **String** | Phone number | [optional] |
19-
| **email** | **String** | Email | |
19+
| **email** | **String** | Email | [optional] |
2020
| **title** | **String** | Title of the customer | |
2121
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
2222
| **version** | **Long** | | [optional] |

ce/docs/DashboardControllerApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Dashboard assignDashboardToEdge(@Nonnull String edgeId, @Nonnull String dashboar
99
Dashboard assignDashboardToPublicCustomer(@Nonnull String dashboardId) // Assign the Dashboard to Public Customer (assignDashboardToPublicCustomer)
1010
void deleteDashboard(@Nonnull String dashboardId) // Delete the Dashboard (deleteDashboard)
1111
PageDataDashboardInfo getCustomerDashboards(@Nonnull String customerId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable Boolean mobile, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Customer Dashboards (getCustomerDashboards)
12-
void getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding) // Get Dashboard (getDashboardById)
12+
Dashboard getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding) // Get Dashboard (getDashboardById)
1313
DashboardInfo getDashboardInfoById(@Nonnull String dashboardId) // Get Dashboard Info (getDashboardInfoById)
1414
List<DashboardInfo> getDashboardsByIds(@Nonnull List<String> dashboardIds) // Get dashboards by Dashboard Ids (getDashboardsByIds)
1515
PageDataDashboardInfo getEdgeDashboards(@Nonnull String edgeId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Edge Dashboards (getEdgeDashboards)
16-
void getHomeDashboard(@Nullable String acceptEncoding) // Get Home Dashboard (getHomeDashboard)
16+
HomeDashboard getHomeDashboard(@Nullable String acceptEncoding) // Get Home Dashboard (getHomeDashboard)
1717
HomeDashboardInfo getHomeDashboardInfo() // Get Home Dashboard Info (getHomeDashboardInfo)
1818
Long getMaxDatapointsLimit() // Get max data points limit (getMaxDatapointsLimit)
1919
Long getServerTime() // Get server time (getServerTime)
@@ -186,7 +186,7 @@ Returns a page of dashboard info objects owned by the specified customer. The Da
186186
## getDashboardById
187187

188188
```
189-
void getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding)
189+
Dashboard getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding)
190190
```
191191

192192
**GET** `/api/dashboard/{dashboardId}`
@@ -206,7 +206,7 @@ Get the dashboard based on 'dashboardId' parameter. The Dashboard object is a he
206206

207207
### Return type
208208

209-
null (empty response body)
209+
**Dashboard**
210210

211211

212212
## getDashboardInfoById
@@ -289,7 +289,7 @@ Returns a page of dashboard info objects assigned to the specified edge. The Das
289289
## getHomeDashboard
290290

291291
```
292-
void getHomeDashboard(@Nullable String acceptEncoding)
292+
HomeDashboard getHomeDashboard(@Nullable String acceptEncoding)
293293
```
294294

295295
**GET** `/api/dashboard/home`
@@ -307,7 +307,7 @@ Returns the home dashboard object that is configured as 'homeDashboardId' parame
307307

308308
### Return type
309309

310-
null (empty response body)
310+
**HomeDashboard**
311311

312312

313313
## getHomeDashboardInfo

ce/docs/Device.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| **name** | **String** | Unique Device Name in scope of Tenant | |
1515
| **type** | **String** | Device Profile Name | [optional] |
1616
| **label** | **String** | Label that may be used in widgets | [optional] |
17-
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. | |
17+
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. If not provided, the type will be used to determine the profile. If neither deviceProfileId nor type is specified, the default device profile will be used. | [optional] |
1818
| **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
1919
| **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
2020
| **version** | **Long** | | [optional] |

ce/docs/DeviceInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| **name** | **String** | Unique Device Name in scope of Tenant | |
1515
| **type** | **String** | Device Profile Name | [optional] |
1616
| **label** | **String** | Label that may be used in widgets | [optional] |
17-
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. | |
17+
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. If not provided, the type will be used to determine the profile. If neither deviceProfileId nor type is specified, the default device profile will be used. | [optional] |
1818
| **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
1919
| **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
2020
| **version** | **Long** | | [optional] |

ce/docs/DeviceProfileInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
| **id** | **EntityId** | JSON object with the entity Id. | [optional] |
10+
| **id** | **DeviceProfileId** | JSON object with the Device Profile Id. | [optional] |
1111
| **name** | **String** | Entity Name | [optional] |
1212
| **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] |
1313
| **defaultDashboardId** | **DashboardId** | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details. | [optional] |

ce/docs/HomeDashboard.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
# HomeDashboard
3+
4+
`org.thingsboard.client.model.HomeDashboard`
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
| **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] |
11+
| **createdTime** | **Long** | Timestamp of the dashboard creation, in milliseconds | [optional] [readonly] |
12+
| **tenantId** | **TenantId** | JSON object with Tenant Id. Tenant Id of the dashboard can't be changed. | [optional] [readonly] |
13+
| **title** | **String** | Title of the dashboard. | |
14+
| **name** | **String** | Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard. | [optional] [readonly] |
15+
| **image** | **String** | Thumbnail picture for rendering of the dashboards in a grid view on mobile devices. | [optional] [readonly] |
16+
| **mobileHide** | **Boolean** | Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens. | [optional] [readonly] |
17+
| **mobileOrder** | **Integer** | Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications | [optional] [readonly] |
18+
| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
19+
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with main configuration of the dashboard: layouts, widgets, aliases, etc. The JSON structure of the dashboard configuration is quite complex. The easiest way to learn it is to export existing dashboard to JSON. | [optional] |
20+
| **resources** | **List\<ResourceExportData\>** | | [optional] |
21+
| **version** | **Long** | | [optional] |
22+
| **hideDashboardToolbar** | **Boolean** | Hide dashboard toolbar flag. Useful for rendering dashboards on mobile. | [optional] |
23+
24+
25+
26+
---
27+
28+
### Conventions
29+
30+
- **Package:** `org.thingsboard.client.model`
31+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
32+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
33+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
34+

ce/docs/RpcV1ControllerApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Deprecated. See 'Rpc V 2 Controller' instead. Available for users with 'TENANT_
2626
| Name | Type | Description | Notes |
2727
|------------- | ------------- | ------------- | -------------|
2828
| **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
29-
| **body** | **String** | | |
29+
| **body** | **String** | A JSON object representing the RPC request. | |
3030

3131
### Return type
3232

@@ -51,7 +51,7 @@ Deprecated. See 'Rpc V 2 Controller' instead. Available for users with 'TENANT_
5151
| Name | Type | Description | Notes |
5252
|------------- | ------------- | ------------- | -------------|
5353
| **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
54-
| **body** | **String** | | |
54+
| **body** | **String** | A JSON object representing the RPC request. | |
5555

5656
### Return type
5757

ce/docs/RpcV2ControllerApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Sends the one-way remote-procedure call (RPC) request to device. Sends the one-w
107107
| Name | Type | Description | Notes |
108108
|------------- | ------------- | ------------- | -------------|
109109
| **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
110-
| **body** | **String** | | |
110+
| **body** | **String** | A JSON object representing the RPC request. | |
111111

112112
### Return type
113113

@@ -132,7 +132,7 @@ Sends the two-way remote-procedure call (RPC) request to device. Sends the one-w
132132
| Name | Type | Description | Notes |
133133
|------------- | ------------- | ------------- | -------------|
134134
| **deviceId** | **String** | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
135-
| **body** | **String** | | |
135+
| **body** | **String** | A JSON object representing the RPC request. | |
136136

137137
### Return type
138138

ce/docs/RuleChainMetaData.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A JSON value representing the rule chain metadata.
1515
| **nodes** | **List\<RuleNode\>** | List of rule node JSON objects | |
1616
| **connections** | **List\<NodeConnectionInfo\>** | List of JSON objects that represent connections between rule nodes | |
1717
| **ruleChainConnections** | **List\<RuleChainConnectionInfo\>** | List of JSON objects that represent connections between rule nodes and other rule chains. | |
18+
| **notes** | **List\<RuleChainNote\>** | List of sticky notes placed on the rule chain canvas | [optional] |
1819

1920

2021

0 commit comments

Comments
 (0)