Skip to content

Commit 8bd7782

Browse files
author
TeamCity
committed
Update PE OpenAPI spec
1 parent 6230b1a commit 8bd7782

145 files changed

Lines changed: 16786 additions & 14768 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.

‎pe/docs/AdminControllerApi.md‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
| [**autoCommitSettingsExists**](#autoCommitSettingsExists) | **GET** /api/admin/autoCommitSettings/exists | Check auto commit settings exists (autoCommitSettingsExists) |
66
| [**checkRepositoryAccess**](#checkRepositoryAccess) | **POST** /api/admin/repositorySettings/checkAccess | Check repository access (checkRepositoryAccess) |
77
| [**checkUpdates**](#checkUpdates) | **GET** /api/admin/updates | Check for new Platform Releases (checkUpdates) |
8-
| [**codeProcessingUrl**](#codeProcessingUrl) | **GET** /api/admin/mail/oauth2/code | codeProcessingUrl |
98
| [**deleteAutoCommitSettings**](#deleteAutoCommitSettings) | **DELETE** /api/admin/autoCommitSettings | Delete auto commit settings (deleteAutoCommitSettings) |
109
| [**deleteRepositorySettings**](#deleteRepositorySettings) | **DELETE** /api/admin/repositorySettings | Delete repository settings (deleteRepositorySettings) |
1110
| [**getAdminSettings**](#getAdminSettings) | **GET** /api/admin/settings/{key} | Get the Administration Settings object using key (getAdminSettings) |
12-
| [**getAuthorizationUrl**](#getAuthorizationUrl) | **GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
1311
| [**getAutoCommitSettings**](#getAutoCommitSettings) | **GET** /api/admin/autoCommitSettings | Get auto commit settings (getAutoCommitSettings) |
1412
| [**getFeaturesInfo**](#getFeaturesInfo) | **GET** /api/admin/featuresInfo | Get features info (getFeaturesInfo) |
1513
| [**getJwtSettings**](#getJwtSettings) | **GET** /api/admin/jwtSettings | Get the JWT Settings object (getJwtSettings) |
1614
| [**getLicenseUsageInfo**](#getLicenseUsageInfo) | **GET** /api/admin/licenseUsageInfo | Get license usage info (getLicenseUsageInfo) |
15+
| [**getMailOAuth2AuthorizationUrl**](#getMailOAuth2AuthorizationUrl) | **GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
1716
| [**getMailProcessingUrl**](#getMailProcessingUrl) | **GET** /api/admin/mail/oauth2/loginProcessingUrl | Get OAuth2 log in processing URL (getMailProcessingUrl) |
1817
| [**getRepositorySettings**](#getRepositorySettings) | **GET** /api/admin/repositorySettings | Get repository settings (getRepositorySettings) |
1918
| [**getRepositorySettingsInfo**](#getRepositorySettingsInfo) | **GET** /api/admin/repositorySettings/info | getRepositorySettingsInfo |
2019
| [**getSecuritySettings**](#getSecuritySettings) | **GET** /api/admin/securitySettings | Get the Security Settings object (getSecuritySettings) |
2120
| [**getSystemInfo**](#getSystemInfo) | **GET** /api/admin/systemInfo | Get system info (getSystemInfo) |
21+
| [**handleMailOAuth2Callback**](#handleMailOAuth2Callback) | **GET** /api/admin/mail/oauth2/code | handleMailOAuth2Callback |
2222
| [**repositorySettingsExists**](#repositorySettingsExists) | **GET** /api/admin/repositorySettings/exists | Check repository settings exists (repositorySettingsExists) |
2323
| [**saveAdminSettings**](#saveAdminSettings) | **POST** /api/admin/settings | Creates or Updates the Administration Settings (saveAdminSettings) |
2424
| [**saveAutoCommitSettings**](#saveAutoCommitSettings) | **POST** /api/admin/autoCommitSettings | Creates or Updates the auto commit settings (saveAutoCommitSettings) |
@@ -76,25 +76,6 @@ Check notifications about new platform releases. Available for users with 'SYS
7676
**UpdateMessage**
7777

7878

79-
## codeProcessingUrl
80-
81-
> codeProcessingUrl(code, state)
82-
83-
codeProcessingUrl
84-
85-
86-
### Parameters
87-
88-
| Name | Type | Description | Notes |
89-
|------------- | ------------- | ------------- | -------------|
90-
| **code** | **String** | | |
91-
| **state** | **String** | | |
92-
93-
### Return type
94-
95-
null (empty response body)
96-
97-
9879
## deleteAutoCommitSettings
9980

10081
> deleteAutoCommitSettings()
@@ -142,19 +123,6 @@ Get the Administration Settings object using specified string key. Referencing n
142123
**AdminSettings**
143124

144125

145-
## getAuthorizationUrl
146-
147-
> String getAuthorizationUrl()
148-
149-
Redirect user to mail provider login page.
150-
151-
After user logged in and provided accessprovider sends authorization code to specified redirect uri.)
152-
153-
### Return type
154-
155-
**String**
156-
157-
158126
## getAutoCommitSettings
159127

160128
> Map<String, AutoVersionCreateConfig> getAutoCommitSettings()
@@ -207,6 +175,19 @@ Get license usage info. Available for users with 'SYS_ADMIN' authority.
207175
**LicenseUsageInfo**
208176

209177

178+
## getMailOAuth2AuthorizationUrl
179+
180+
> String getMailOAuth2AuthorizationUrl()
181+
182+
Redirect user to mail provider login page.
183+
184+
After user logged in and provided accessprovider sends authorization code to specified redirect uri.)
185+
186+
### Return type
187+
188+
**String**
189+
190+
210191
## getMailProcessingUrl
211192

212193
> String getMailProcessingUrl()
@@ -270,6 +251,25 @@ Get main information about system. Available for users with 'SYS_ADMIN' author
270251
**SystemInfo**
271252

272253

254+
## handleMailOAuth2Callback
255+
256+
> handleMailOAuth2Callback(code, state)
257+
258+
handleMailOAuth2Callback
259+
260+
261+
### Parameters
262+
263+
| Name | Type | Description | Notes |
264+
|------------- | ------------- | ------------- | -------------|
265+
| **code** | **String** | | |
266+
| **state** | **String** | | |
267+
268+
### Return type
269+
270+
null (empty response body)
271+
272+
273273
## repositorySettingsExists
274274

275275
> Boolean repositorySettingsExists()

pe/docs/GroupEntityExportData.md renamed to pe/docs/AiModelExportData.md

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

2-
# GroupEntityExportData
2+
# AiModelExportData
33

4-
`org.thingsboard.client.model.GroupEntityExportData`
4+
`org.thingsboard.client.model.AiModelExportData`
55

66
**Extends:** **EntityExportData**
77

pe/docs/DefaultNotificationRuleRecipientsConfig.md renamed to pe/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

‎pe/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+

‎pe/docs/AlarmControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
| [**getAlarmById**](#getAlarmById) | **GET** /api/alarm/{alarmId} | Get Alarm (getAlarmById) |
1010
| [**getAlarmInfoById**](#getAlarmInfoById) | **GET** /api/alarm/info/{alarmId} | Get Alarm Info (getAlarmInfoById) |
1111
| [**getAlarmTypes**](#getAlarmTypes) | **GET** /api/alarm/types | Get Alarm Types (getAlarmTypes) |
12-
| [**getAlarms**](#getAlarms) | **GET** /api/alarm/{entityType}/{entityId} | Get Alarms (getAlarms) |
12+
| [**getAlarmsByEntity**](#getAlarmsByEntity) | **GET** /api/alarm/{entityType}/{entityId} | Get Alarms (getAlarmsByEntity) |
1313
| [**getAlarmsV2**](#getAlarmsV2) | **GET** /api/v2/alarm/{entityType}/{entityId} | Get Alarms (getAlarmsV2) |
1414
| [**getAllAlarms**](#getAllAlarms) | **GET** /api/alarms | Get All Alarms (getAllAlarms) |
1515
| [**getAllAlarmsV2**](#getAllAlarmsV2) | **GET** /api/v2/alarms | Get All Alarms (getAllAlarmsV2) |
@@ -163,11 +163,11 @@ Returns a set of unique alarm types based on alarms that are either owned by the
163163
**PageDataEntitySubtype**
164164

165165

166-
## getAlarms
166+
## getAlarmsByEntity
167167

168-
> PageDataAlarmInfo getAlarms(entityType, entityId, pageSize, page, searchStatus, status, assigneeId, textSearch, sortProperty, sortOrder, startTime, endTime, fetchOriginator)
168+
> PageDataAlarmInfo getAlarmsByEntity(entityType, entityId, pageSize, page, searchStatus, status, assigneeId, textSearch, sortProperty, sortOrder, startTime, endTime, fetchOriginator)
169169
170-
Get Alarms (getAlarms)
170+
Get Alarms (getAlarmsByEntity)
171171

172172
Returns a page of alarms for the selected entity. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
173173

‎pe/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+

‎pe/docs/AssetControllerApi.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Method | HTTP request | Description |
44
|------------- | ------------- | -------------|
55
| [**deleteAsset**](#deleteAsset) | **DELETE** /api/asset/{assetId} | Delete asset (deleteAsset) |
6-
| [**findByQuery4**](#findByQuery4) | **POST** /api/assets | Find related assets (findByQuery) |
6+
| [**findAssetsByQuery**](#findAssetsByQuery) | **POST** /api/assets | Find related assets (findAssetsByQuery) |
77
| [**getAllAssetInfos**](#getAllAssetInfos) | **GET** /api/assetInfos/all | Get All Asset Infos for current user (getAllAssetInfos) |
88
| [**getAssetById**](#getAssetById) | **GET** /api/asset/{assetId} | Get Asset (getAssetById) |
99
| [**getAssetInfoById**](#getAssetInfoById) | **GET** /api/asset/info/{assetId} | Get Asset Info (getAssetInfoById) |
@@ -12,7 +12,7 @@
1212
| [**getAssetsByIds**](#getAssetsByIds) | **GET** /api/assets | Get Assets By Ids (getAssetsByIds) |
1313
| [**getCustomerAssetInfos**](#getCustomerAssetInfos) | **GET** /api/customer/{customerId}/assetInfos | Get Customer Asset Infos (getCustomerAssetInfos) |
1414
| [**getCustomerAssets**](#getCustomerAssets) | **GET** /api/customer/{customerId}/assets | Get Customer Assets (getCustomerAssets) |
15-
| [**getTenantAssetByName**](#getTenantAssetByName) | **GET** /api/tenant/asset | Get Tenant Asset (getTenantAsset) |
15+
| [**getTenantAssetByName**](#getTenantAssetByName) | **GET** /api/tenant/asset | Get Tenant Asset (getTenantAssetByName) |
1616
| [**getTenantAssets**](#getTenantAssets) | **GET** /api/tenant/assets | Get Tenant Assets (getTenantAssets) |
1717
| [**getUserAssets**](#getUserAssets) | **GET** /api/user/assets | Get Assets (getUserAssets) |
1818
| [**processAssetBulkImport**](#processAssetBulkImport) | **POST** /api/asset/bulk_import | Import the bulk of assets (processAssetsBulkImport) |
@@ -40,11 +40,11 @@ Deletes the asset and all the relations (from and to the asset). Referencing non
4040
null (empty response body)
4141

4242

43-
## findByQuery4
43+
## findAssetsByQuery
4444

45-
> List<Asset> findByQuery4(assetSearchQuery)
45+
> List<Asset> findAssetsByQuery(assetSearchQuery)
4646
47-
Find related assets (findByQuery)
47+
Find related assets (findAssetsByQuery)
4848

4949
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. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
5050

@@ -241,7 +241,7 @@ Returns a page of assets objects owned by customer. You can specify parameters t
241241

242242
> Asset getTenantAssetByName(assetName)
243243
244-
Get Tenant Asset (getTenantAsset)
244+
Get Tenant Asset (getTenantAssetByName)
245245

246246
Requested asset must be owned by tenant that the user belongs to. Asset name is an unique property of asset. So it can be used to identify the asset. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
247247

‎pe/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+

‎pe/docs/AssetProfileControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| [**getAssetProfileInfos**](#getAssetProfileInfos) | **GET** /api/assetProfileInfos | Get Asset Profile infos (getAssetProfileInfos) |
99
| [**getAssetProfileNames**](#getAssetProfileNames) | **GET** /api/assetProfile/names | Get Asset Profile names (getAssetProfileNames) |
1010
| [**getAssetProfiles**](#getAssetProfiles) | **GET** /api/assetProfiles | Get Asset Profiles (getAssetProfiles) |
11-
| [**getAssetProfilesByIdsV2**](#getAssetProfilesByIdsV2) | **GET** /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIdsV2) |
11+
| [**getAssetProfilesByIds**](#getAssetProfilesByIds) | **GET** /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIds) |
1212
| [**getDefaultAssetProfileInfo**](#getDefaultAssetProfileInfo) | **GET** /api/assetProfileInfo/default | Get Default Asset Profile (getDefaultAssetProfileInfo) |
1313
| [**saveAssetProfile**](#saveAssetProfile) | **POST** /api/assetProfile | Create Or Update Asset Profile (saveAssetProfile) |
1414
| [**setDefaultAssetProfile**](#setDefaultAssetProfile) | **POST** /api/assetProfile/{assetProfileId}/default | Make Asset Profile Default (setDefaultAssetProfile) |
@@ -144,11 +144,11 @@ Returns a page of asset profile objects owned by tenant. You can specify paramet
144144
**PageDataAssetProfile**
145145

146146

147-
## getAssetProfilesByIdsV2
147+
## getAssetProfilesByIds
148148

149-
> List<AssetProfileInfo> getAssetProfilesByIdsV2(assetProfileIds)
149+
> List<AssetProfileInfo> getAssetProfilesByIds(assetProfileIds)
150150
151-
Get Asset Profiles By Ids (getAssetProfilesByIdsV2)
151+
Get Asset Profiles By Ids (getAssetProfilesByIds)
152152

153153
Requested asset profiles must be owned by tenant which is performing the request. Security check is performed to verify that the user has 'READ' permission for the entity (entities).
154154

‎pe/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+

0 commit comments

Comments
 (0)