Skip to content

Commit 5401fc0

Browse files
dashevchenkodashevchenko
committed
updated ce client after api methods were unified
1 parent 2e64a72 commit 5401fc0

59 files changed

Lines changed: 3213 additions & 2672 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎ce/docs/AiModelExportData.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# AiModelExportData
3+
4+
`org.thingsboard.client.model.AiModelExportData`
5+
6+
**Extends:** **EntityExportData**
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

ce/docs/DefaultNotificationRuleRecipientsConfig.md renamed to ce/docs/AlarmAssignmentRecipientsConfig.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11

2-
# DefaultNotificationRuleRecipientsConfig
2+
# AlarmAssignmentRecipientsConfig
33

4-
`org.thingsboard.client.model.DefaultNotificationRuleRecipientsConfig`
5-
6-
Default notification rule recipients configuration
4+
`org.thingsboard.client.model.AlarmAssignmentRecipientsConfig`
75

86
**Extends:** **NotificationRuleRecipientsConfig**
97

108
## Properties
119

1210
| Name | Type | Description | Notes |
1311
|------------ | ------------- | ------------- | -------------|
14-
| **triggerType** | **NotificationRuleTriggerType** | | |
1512
| **targets** | **List\<UUID\>** | | |
1613

1714

‎ce/docs/AlarmCommentRecipientsConfig.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
# AlarmCommentRecipientsConfig
3+
4+
`org.thingsboard.client.model.AlarmCommentRecipientsConfig`
5+
6+
**Extends:** **NotificationRuleRecipientsConfig**
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
| **targets** | **List\<UUID\>** | | |
13+
14+
15+
16+
---
17+
18+
### Conventions
19+
20+
- **Package:** `org.thingsboard.client.model`
21+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
22+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
23+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
24+

‎ce/docs/ApiUsageLimitRecipientsConfig.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
# ApiUsageLimitRecipientsConfig
3+
4+
`org.thingsboard.client.model.ApiUsageLimitRecipientsConfig`
5+
6+
**Extends:** **NotificationRuleRecipientsConfig**
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
| **targets** | **List\<UUID\>** | | |
13+
14+
15+
16+
---
17+
18+
### Conventions
19+
20+
- **Package:** `org.thingsboard.client.model`
21+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
22+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
23+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
24+

‎ce/docs/AssetControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| [**assignAssetToEdge**](#assignAssetToEdge) | **POST** /api/edge/{edgeId}/asset/{assetId} | Assign asset to edge (assignAssetToEdge) |
77
| [**assignAssetToPublicCustomer**](#assignAssetToPublicCustomer) | **POST** /api/customer/public/asset/{assetId} | Make asset publicly available (assignAssetToPublicCustomer) |
88
| [**deleteAsset**](#deleteAsset) | **DELETE** /api/asset/{assetId} | Delete asset (deleteAsset) |
9-
| [**findByQuery4**](#findByQuery4) | **POST** /api/assets | Find related assets (findByQuery) |
9+
| [**findAssetsByQuery**](#findAssetsByQuery) | **POST** /api/assets | Find related assets (findAssetsByQuery) |
1010
| [**getAssetById**](#getAssetById) | **GET** /api/asset/{assetId} | Get Asset (getAssetById) |
1111
| [**getAssetInfoById**](#getAssetInfoById) | **GET** /api/asset/info/{assetId} | Get Asset Info (getAssetInfoById) |
1212
| [**getAssetTypes**](#getAssetTypes) | **GET** /api/asset/types | Get Asset Types (getAssetTypes) |
@@ -106,11 +106,11 @@ Deletes the asset and all the relations (from and to the asset). Referencing non
106106
null (empty response body)
107107

108108

109-
## findByQuery4
109+
## findAssetsByQuery
110110

111-
> List<Asset> findByQuery4(assetSearchQuery)
111+
> List<Asset> findAssetsByQuery(assetSearchQuery)
112112
113-
Find related assets (findByQuery)
113+
Find related assets (findAssetsByQuery)
114114

115115
Returns all assets that are related to the specific entity. The entity id, relation type, asset types, depth of the search, and other query parameters defined using complex 'AssetSearchQuery' object. See 'Model' tab of the Parameters for more info.
116116

‎ce/docs/AssetExportData.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# AssetExportData
3+
4+
`org.thingsboard.client.model.AssetExportData`
5+
6+
**Extends:** **EntityExportData**
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

‎ce/docs/AssetProfileExportData.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# AssetProfileExportData
3+
4+
`org.thingsboard.client.model.AssetProfileExportData`
5+
6+
**Extends:** **EntityExportData**
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

‎ce/docs/CalculatedFieldControllerApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
| [**getCalculatedFieldsByEntityIdV2**](#getCalculatedFieldsByEntityIdV2) | **GET** /api/calculatedField/{entityType}/{entityId} | Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityIdV2) |
1010
| [**getLatestCalculatedFieldDebugEvent**](#getLatestCalculatedFieldDebugEvent) | **GET** /api/calculatedField/{calculatedFieldId}/debug | Get latest calculated field debug event (getLatestCalculatedFieldDebugEvent) |
1111
| [**saveCalculatedField**](#saveCalculatedField) | **POST** /api/calculatedField | Create Or Update Calculated Field (saveCalculatedField) |
12-
| [**testScript1**](#testScript1) | **POST** /api/calculatedField/testScript | Test Script expression |
12+
| [**testCalculatedFieldScript**](#testCalculatedFieldScript) | **POST** /api/calculatedField/testScript | Test Script expression |
1313

1414

1515

@@ -172,9 +172,9 @@ Creates or Updates the Calculated Field. When creating calculated field, platfor
172172
**CalculatedField**
173173

174174

175-
## testScript1
175+
## testCalculatedFieldScript
176176

177-
> com.fasterxml.jackson.databind.JsonNode testScript1(body)
177+
> com.fasterxml.jackson.databind.JsonNode testCalculatedFieldScript(body)
178178
179179
Test Script expression
180180

‎ce/docs/CustomerExportData.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# CustomerExportData
3+
4+
`org.thingsboard.client.model.CustomerExportData`
5+
6+
**Extends:** **EntityExportData**
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

‎ce/docs/DashboardControllerApi.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
| [**getHomeDashboardInfo**](#getHomeDashboardInfo) | **GET** /api/dashboard/home/info | Get Home Dashboard Info (getHomeDashboardInfo) |
1717
| [**getMaxDatapointsLimit**](#getMaxDatapointsLimit) | **GET** /api/dashboard/maxDatapointsLimit | Get max data points limit (getMaxDatapointsLimit) |
1818
| [**getServerTime**](#getServerTime) | **GET** /api/dashboard/serverTime | Get server time (getServerTime) |
19-
| [**getTenantDashboards**](#getTenantDashboards) | **GET** /api/tenant/{tenantId}/dashboards | Get Tenant Dashboards by System Administrator (getTenantDashboards) |
20-
| [**getTenantDashboards1**](#getTenantDashboards1) | **GET** /api/tenant/dashboards | Get Tenant Dashboards (getTenantDashboards) |
19+
| [**getTenantDashboards**](#getTenantDashboards) | **GET** /api/tenant/dashboards | Get Tenant Dashboards (getTenantDashboards) |
20+
| [**getTenantDashboardsByTenantId**](#getTenantDashboardsByTenantId) | **GET** /api/tenant/{tenantId}/dashboards | Get Tenant Dashboards by System Administrator (getTenantDashboardsByTenantId) |
2121
| [**getTenantHomeDashboardInfo**](#getTenantHomeDashboardInfo) | **GET** /api/tenant/dashboard/home/info | Get Tenant Home Dashboard Info (getTenantHomeDashboardInfo) |
2222
| [**removeDashboardCustomers**](#removeDashboardCustomers) | **POST** /api/dashboard/{dashboardId}/customers/remove | Remove the Dashboard Customers (removeDashboardCustomers) |
2323
| [**saveDashboard**](#saveDashboard) | **POST** /api/dashboard | Create Or Update Dashboard (saveDashboard) |
@@ -306,20 +306,20 @@ Get the server time (milliseconds since January 1, 1970 UTC). Used to adjust vie
306306

307307
## getTenantDashboards
308308

309-
> PageDataDashboardInfo getTenantDashboards(tenantId, pageSize, page, textSearch, sortProperty, sortOrder)
309+
> PageDataDashboardInfo getTenantDashboards(pageSize, page, mobile, textSearch, sortProperty, sortOrder)
310310
311-
Get Tenant Dashboards by System Administrator (getTenantDashboards)
311+
Get Tenant Dashboards (getTenantDashboards)
312312

313-
Returns a page of dashboard info objects owned by tenant. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'SYS_ADMIN' authority.
313+
Returns a page of dashboard info objects owned by the tenant of a current user. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' authority.
314314

315315

316316
### Parameters
317317

318318
| Name | Type | Description | Notes |
319319
|------------- | ------------- | ------------- | -------------|
320-
| **tenantId** | **String** | A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
321320
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
322321
| **page** | **Integer** | Sequence number of page starting from 0 | |
322+
| **mobile** | **Boolean** | Exclude dashboards that are hidden for mobile | [optional] |
323323
| **textSearch** | **String** | The case insensitive 'substring' filter based on the dashboard title. | [optional] |
324324
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title] |
325325
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
@@ -329,22 +329,22 @@ Returns a page of dashboard info objects owned by tenant. The Dashboard Info obj
329329
**PageDataDashboardInfo**
330330

331331

332-
## getTenantDashboards1
332+
## getTenantDashboardsByTenantId
333333

334-
> PageDataDashboardInfo getTenantDashboards1(pageSize, page, mobile, textSearch, sortProperty, sortOrder)
334+
> PageDataDashboardInfo getTenantDashboardsByTenantId(tenantId, pageSize, page, textSearch, sortProperty, sortOrder)
335335
336-
Get Tenant Dashboards (getTenantDashboards)
336+
Get Tenant Dashboards by System Administrator (getTenantDashboardsByTenantId)
337337

338-
Returns a page of dashboard info objects owned by the tenant of a current user. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' authority.
338+
Returns a page of dashboard info objects owned by tenant. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'SYS_ADMIN' authority.
339339

340340

341341
### Parameters
342342

343343
| Name | Type | Description | Notes |
344344
|------------- | ------------- | ------------- | -------------|
345+
| **tenantId** | **String** | A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
345346
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
346347
| **page** | **Integer** | Sequence number of page starting from 0 | |
347-
| **mobile** | **Boolean** | Exclude dashboards that are hidden for mobile | [optional] |
348348
| **textSearch** | **String** | The case insensitive 'substring' filter based on the dashboard title. | [optional] |
349349
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title] |
350350
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |

0 commit comments

Comments
 (0)