Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
68 changes: 34 additions & 34 deletions ce/docs/AdminControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
| [**autoCommitSettingsExists**](#autoCommitSettingsExists) | **GET** /api/admin/autoCommitSettings/exists | Check auto commit settings exists (autoCommitSettingsExists) |
| [**checkRepositoryAccess**](#checkRepositoryAccess) | **POST** /api/admin/repositorySettings/checkAccess | Check repository access (checkRepositoryAccess) |
| [**checkUpdates**](#checkUpdates) | **GET** /api/admin/updates | Check for new Platform Releases (checkUpdates) |
| [**codeProcessingUrl**](#codeProcessingUrl) | **GET** /api/admin/mail/oauth2/code | codeProcessingUrl |
| [**deleteAutoCommitSettings**](#deleteAutoCommitSettings) | **DELETE** /api/admin/autoCommitSettings | Delete auto commit settings (deleteAutoCommitSettings) |
| [**deleteRepositorySettings**](#deleteRepositorySettings) | **DELETE** /api/admin/repositorySettings | Delete repository settings (deleteRepositorySettings) |
| [**getAdminSettings**](#getAdminSettings) | **GET** /api/admin/settings/{key} | Get the Administration Settings object using key (getAdminSettings) |
| [**getAuthorizationUrl**](#getAuthorizationUrl) | **GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
| [**getAutoCommitSettings**](#getAutoCommitSettings) | **GET** /api/admin/autoCommitSettings | Get auto commit settings (getAutoCommitSettings) |
| [**getFeaturesInfo**](#getFeaturesInfo) | **GET** /api/admin/featuresInfo | Get features info (getFeaturesInfo) |
| [**getJwtSettings**](#getJwtSettings) | **GET** /api/admin/jwtSettings | Get the JWT Settings object (getJwtSettings) |
| [**getMailOAuth2AuthorizationUrl**](#getMailOAuth2AuthorizationUrl) | **GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
| [**getMailProcessingUrl**](#getMailProcessingUrl) | **GET** /api/admin/mail/oauth2/loginProcessingUrl | Get OAuth2 log in processing URL (getMailProcessingUrl) |
| [**getRepositorySettings**](#getRepositorySettings) | **GET** /api/admin/repositorySettings | Get repository settings (getRepositorySettings) |
| [**getRepositorySettingsInfo**](#getRepositorySettingsInfo) | **GET** /api/admin/repositorySettings/info | getRepositorySettingsInfo |
| [**getSecuritySettings**](#getSecuritySettings) | **GET** /api/admin/securitySettings | Get the Security Settings object (getSecuritySettings) |
| [**getSystemInfo**](#getSystemInfo) | **GET** /api/admin/systemInfo | Get system info (getSystemInfo) |
| [**handleMailOAuth2Callback**](#handleMailOAuth2Callback) | **GET** /api/admin/mail/oauth2/code | handleMailOAuth2Callback |
| [**repositorySettingsExists**](#repositorySettingsExists) | **GET** /api/admin/repositorySettings/exists | Check repository settings exists (repositorySettingsExists) |
| [**saveAdminSettings**](#saveAdminSettings) | **POST** /api/admin/settings | Creates or Updates the Administration Settings (saveAdminSettings) |
| [**saveAutoCommitSettings**](#saveAutoCommitSettings) | **POST** /api/admin/autoCommitSettings | Creates or Updates the auto commit settings (saveAutoCommitSettings) |
Expand Down Expand Up @@ -75,25 +75,6 @@ Check notifications about new platform releases. Available for users with 'SYS
**UpdateMessage**


## codeProcessingUrl

> codeProcessingUrl(code, state)

codeProcessingUrl


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **code** | **String** | | |
| **state** | **String** | | |

### Return type

null (empty response body)


## deleteAutoCommitSettings

> deleteAutoCommitSettings()
Expand Down Expand Up @@ -140,19 +121,6 @@ Get the Administration Settings object using specified string key. Referencing n
**AdminSettings**


## getAuthorizationUrl

> String getAuthorizationUrl()

Redirect user to mail provider login page.

After user logged in and provided accessprovider sends authorization code to specified redirect uri.)

### Return type

**String**


## getAutoCommitSettings

> Map<String, AutoVersionCreateConfig> getAutoCommitSettings()
Expand Down Expand Up @@ -192,6 +160,19 @@ Get the JWT Settings object that contains JWT token policy, etc. Available for
**JwtSettings**


## getMailOAuth2AuthorizationUrl

> String getMailOAuth2AuthorizationUrl()

Redirect user to mail provider login page.

After user logged in and provided accessprovider sends authorization code to specified redirect uri.)

### Return type

**String**


## getMailProcessingUrl

> String getMailProcessingUrl()
Expand Down Expand Up @@ -255,6 +236,25 @@ Get main information about system. Available for users with 'SYS_ADMIN' author
**SystemInfo**


## handleMailOAuth2Callback

> handleMailOAuth2Callback(code, state)

handleMailOAuth2Callback


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **code** | **String** | | |
| **state** | **String** | | |

### Return type

null (empty response body)


## repositorySettingsExists

> Boolean repositorySettingsExists()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# GroupEntityExportData
# AiModelExportData

`org.thingsboard.client.model.GroupEntityExportData`
`org.thingsboard.client.model.AiModelExportData`

**Extends:** **EntityExportData**

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@

# DefaultNotificationRuleRecipientsConfig
# AlarmAssignmentRecipientsConfig

`org.thingsboard.client.model.DefaultNotificationRuleRecipientsConfig`

Default notification rule recipients configuration
`org.thingsboard.client.model.AlarmAssignmentRecipientsConfig`

**Extends:** **NotificationRuleRecipientsConfig**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **triggerType** | **NotificationRuleTriggerType** | | |
| **targets** | **List\<UUID\>** | | |


Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@

# DefaultNotificationRuleRecipientsConfig
# AlarmCommentRecipientsConfig

`org.thingsboard.client.model.DefaultNotificationRuleRecipientsConfig`

Default notification rule recipients configuration
`org.thingsboard.client.model.AlarmCommentRecipientsConfig`

**Extends:** **NotificationRuleRecipientsConfig**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **triggerType** | **NotificationRuleTriggerType** | | |
| **targets** | **List\<UUID\>** | | |


Expand Down
8 changes: 4 additions & 4 deletions ce/docs/AlarmControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| [**getAlarmById**](#getAlarmById) | **GET** /api/alarm/{alarmId} | Get Alarm (getAlarmById) |
| [**getAlarmInfoById**](#getAlarmInfoById) | **GET** /api/alarm/info/{alarmId} | Get Alarm Info (getAlarmInfoById) |
| [**getAlarmTypes**](#getAlarmTypes) | **GET** /api/alarm/types | Get Alarm Types (getAlarmTypes) |
| [**getAlarms**](#getAlarms) | **GET** /api/alarm/{entityType}/{entityId} | Get Alarms (getAlarms) |
| [**getAlarmsByEntity**](#getAlarmsByEntity) | **GET** /api/alarm/{entityType}/{entityId} | Get Alarms (getAlarmsByEntity) |
| [**getAlarmsV2**](#getAlarmsV2) | **GET** /api/v2/alarm/{entityType}/{entityId} | Get Alarms (getAlarmsV2) |
| [**getAllAlarms**](#getAllAlarms) | **GET** /api/alarms | Get All Alarms (getAllAlarms) |
| [**getAllAlarmsV2**](#getAllAlarmsV2) | **GET** /api/v2/alarms | Get All Alarms (getAllAlarmsV2) |
Expand Down Expand Up @@ -163,11 +163,11 @@ Returns a set of unique alarm types based on alarms that are either owned by the
**PageDataEntitySubtype**


## getAlarms
## getAlarmsByEntity

> PageDataAlarmInfo getAlarms(entityType, entityId, pageSize, page, searchStatus, status, assigneeId, textSearch, sortProperty, sortOrder, startTime, endTime, fetchOriginator)
> PageDataAlarmInfo getAlarmsByEntity(entityType, entityId, pageSize, page, searchStatus, status, assigneeId, textSearch, sortProperty, sortOrder, startTime, endTime, fetchOriginator)

Get Alarms (getAlarms)
Get Alarms (getAlarmsByEntity)

Returns a page of alarms for the selected entity. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. 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' or 'CUSTOMER_USER' authority.

Expand Down
24 changes: 24 additions & 0 deletions ce/docs/ApiUsageLimitRecipientsConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

# ApiUsageLimitRecipientsConfig

`org.thingsboard.client.model.ApiUsageLimitRecipientsConfig`

**Extends:** **NotificationRuleRecipientsConfig**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **targets** | **List\<UUID\>** | | |



---

### 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

8 changes: 4 additions & 4 deletions ce/docs/AssetControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| [**assignAssetToEdge**](#assignAssetToEdge) | **POST** /api/edge/{edgeId}/asset/{assetId} | Assign asset to edge (assignAssetToEdge) |
| [**assignAssetToPublicCustomer**](#assignAssetToPublicCustomer) | **POST** /api/customer/public/asset/{assetId} | Make asset publicly available (assignAssetToPublicCustomer) |
| [**deleteAsset**](#deleteAsset) | **DELETE** /api/asset/{assetId} | Delete asset (deleteAsset) |
| [**findByQuery4**](#findByQuery4) | **POST** /api/assets | Find related assets (findByQuery) |
| [**findAssetsByQuery**](#findAssetsByQuery) | **POST** /api/assets | Find related assets (findAssetsByQuery) |
| [**getAssetById**](#getAssetById) | **GET** /api/asset/{assetId} | Get Asset (getAssetById) |
| [**getAssetInfoById**](#getAssetInfoById) | **GET** /api/asset/info/{assetId} | Get Asset Info (getAssetInfoById) |
| [**getAssetTypes**](#getAssetTypes) | **GET** /api/asset/types | Get Asset Types (getAssetTypes) |
Expand Down Expand Up @@ -106,11 +106,11 @@ Deletes the asset and all the relations (from and to the asset). Referencing non
null (empty response body)


## findByQuery4
## findAssetsByQuery

> List<Asset> findByQuery4(assetSearchQuery)
> List<Asset> findAssetsByQuery(assetSearchQuery)

Find related assets (findByQuery)
Find related assets (findAssetsByQuery)

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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# GroupEntityExportData
# AssetExportData

`org.thingsboard.client.model.GroupEntityExportData`
`org.thingsboard.client.model.AssetExportData`

**Extends:** **EntityExportData**

Expand Down
8 changes: 4 additions & 4 deletions ce/docs/AssetProfileControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| [**getAssetProfileInfos**](#getAssetProfileInfos) | **GET** /api/assetProfileInfos | Get Asset Profile infos (getAssetProfileInfos) |
| [**getAssetProfileNames**](#getAssetProfileNames) | **GET** /api/assetProfile/names | Get Asset Profile names (getAssetProfileNames) |
| [**getAssetProfiles**](#getAssetProfiles) | **GET** /api/assetProfiles | Get Asset Profiles (getAssetProfiles) |
| [**getAssetProfilesByIdsV2**](#getAssetProfilesByIdsV2) | **GET** /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIdsV2) |
| [**getAssetProfilesByIds**](#getAssetProfilesByIds) | **GET** /api/assetProfileInfos/list | Get Asset Profiles By Ids (getAssetProfilesByIds) |
| [**getDefaultAssetProfileInfo**](#getDefaultAssetProfileInfo) | **GET** /api/assetProfileInfo/default | Get Default Asset Profile (getDefaultAssetProfileInfo) |
| [**saveAssetProfile**](#saveAssetProfile) | **POST** /api/assetProfile | Create Or Update Asset Profile (saveAssetProfile) |
| [**setDefaultAssetProfile**](#setDefaultAssetProfile) | **POST** /api/assetProfile/{assetProfileId}/default | Make Asset Profile Default (setDefaultAssetProfile) |
Expand Down Expand Up @@ -144,11 +144,11 @@ Returns a page of asset profile objects owned by tenant. You can specify paramet
**PageDataAssetProfile**


## getAssetProfilesByIdsV2
## getAssetProfilesByIds

> List<AssetProfileInfo> getAssetProfilesByIdsV2(assetProfileIds)
> List<AssetProfileInfo> getAssetProfilesByIds(assetProfileIds)

Get Asset Profiles By Ids (getAssetProfilesByIdsV2)
Get Asset Profiles By Ids (getAssetProfilesByIds)

Requested asset profiles must be owned by tenant which is performing the request.

Expand Down
23 changes: 23 additions & 0 deletions ce/docs/AssetProfileExportData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

# AssetProfileExportData

`org.thingsboard.client.model.AssetProfileExportData`

**Extends:** **EntityExportData**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|



---

### 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

6 changes: 3 additions & 3 deletions ce/docs/BulkImportResultAsset.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **created** | **Object** | | [optional] |
| **updated** | **Object** | | [optional] |
| **errors** | **Object** | | [optional] |
| **created** | **Integer** | | [optional] |
| **updated** | **Integer** | | [optional] |
| **errors** | **Integer** | | [optional] |
| **errorsList** | **List\<String\>** | | [optional] |


Expand Down
6 changes: 3 additions & 3 deletions ce/docs/BulkImportResultDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **created** | **Object** | | [optional] |
| **updated** | **Object** | | [optional] |
| **errors** | **Object** | | [optional] |
| **created** | **Integer** | | [optional] |
| **updated** | **Integer** | | [optional] |
| **errors** | **Integer** | | [optional] |
| **errorsList** | **List\<String\>** | | [optional] |


Expand Down
6 changes: 3 additions & 3 deletions ce/docs/BulkImportResultEdge.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **created** | **Object** | | [optional] |
| **updated** | **Object** | | [optional] |
| **errors** | **Object** | | [optional] |
| **created** | **Integer** | | [optional] |
| **updated** | **Integer** | | [optional] |
| **errors** | **Integer** | | [optional] |
| **errorsList** | **List\<String\>** | | [optional] |


Expand Down
14 changes: 7 additions & 7 deletions ce/docs/CalculatedFieldControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
| [**getCalculatedFieldById**](#getCalculatedFieldById) | **GET** /api/calculatedField/{calculatedFieldId} | Get Calculated Field (getCalculatedFieldById) |
| [**getCalculatedFieldNames**](#getCalculatedFieldNames) | **GET** /api/calculatedFields/names | Get calculated field names (getCalculatedFieldNames) |
| [**getCalculatedFields**](#getCalculatedFields) | **GET** /api/calculatedFields | Get calculated fields (getCalculatedFields) |
| [**getCalculatedFieldsByEntityIdV2**](#getCalculatedFieldsByEntityIdV2) | **GET** /api/calculatedField/{entityType}/{entityId} | Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityIdV2) |
| [**getCalculatedFieldsByEntityId**](#getCalculatedFieldsByEntityId) | **GET** /api/calculatedField/{entityType}/{entityId} | Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityId) |
| [**getLatestCalculatedFieldDebugEvent**](#getLatestCalculatedFieldDebugEvent) | **GET** /api/calculatedField/{calculatedFieldId}/debug | Get latest calculated field debug event (getLatestCalculatedFieldDebugEvent) |
| [**saveCalculatedField**](#saveCalculatedField) | **POST** /api/calculatedField | Create Or Update Calculated Field (saveCalculatedField) |
| [**testScript1**](#testScript1) | **POST** /api/calculatedField/testScript | Test Script expression |
| [**testCalculatedFieldScript**](#testCalculatedFieldScript) | **POST** /api/calculatedField/testScript | Test Script expression |



Expand Down Expand Up @@ -105,11 +105,11 @@ Fetch tenant calculated fields based on the filter.
**PageDataCalculatedFieldInfo**


## getCalculatedFieldsByEntityIdV2
## getCalculatedFieldsByEntityId

> PageDataCalculatedField getCalculatedFieldsByEntityIdV2(entityType, entityId, pageSize, page, type, textSearch, sortProperty, sortOrder)
> PageDataCalculatedField getCalculatedFieldsByEntityId(entityType, entityId, pageSize, page, type, textSearch, sortProperty, sortOrder)

Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityIdV2)
Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityId)

Fetch the Calculated Fields based on the provided Entity Id.

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


## testScript1
## testCalculatedFieldScript

> com.fasterxml.jackson.databind.JsonNode testScript1(body)
> com.fasterxml.jackson.databind.JsonNode testCalculatedFieldScript(body)

Test Script expression

Expand Down
8 changes: 4 additions & 4 deletions ce/docs/CustomerControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| [**getCustomerById**](#getCustomerById) | **GET** /api/customer/{customerId} | Get Customer (getCustomerById) |
| [**getCustomerTitleById**](#getCustomerTitleById) | **GET** /api/customer/{customerId}/title | Get Customer Title (getCustomerTitleById) |
| [**getCustomers**](#getCustomers) | **GET** /api/customers | Get Tenant Customers (getCustomers) |
| [**getCustomersByIdsV2**](#getCustomersByIdsV2) | **GET** /api/customers/list | Get customers by Customer Ids (getCustomersByIdsV2) |
| [**getCustomersByIds**](#getCustomersByIds) | **GET** /api/customers/list | Get customers by Customer Ids (getCustomersByIds) |
| [**getShortCustomerInfoById**](#getShortCustomerInfoById) | **GET** /api/customer/{customerId}/shortInfo | Get short Customer info (getShortCustomerInfoById) |
| [**getTenantCustomer**](#getTenantCustomer) | **GET** /api/tenant/customers | Get Tenant Customer by Customer title (getTenantCustomer) |
| [**saveCustomer**](#saveCustomer) | **POST** /api/customer | Create or update Customer (saveCustomer) |
Expand Down Expand Up @@ -97,11 +97,11 @@ Returns a page of customers owned by tenant. You can specify parameters to filte
**PageDataCustomer**


## getCustomersByIdsV2
## getCustomersByIds

> List<Customer> getCustomersByIdsV2(customerIds)
> List<Customer> getCustomersByIds(customerIds)

Get customers by Customer Ids (getCustomersByIdsV2)
Get customers by Customer Ids (getCustomersByIds)

Returns a list of Customer objects based on the provided ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

Expand Down
Loading