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
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions ce/docs/AdminSettingsId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.AdminSettingsId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AiModelId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.AiModelId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | Entity type of the AI model | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/Alarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| **ackTs** | **Long** | Timestamp of the alarm acknowledgement, in milliseconds | [optional] |
| **clearTs** | **Long** | Timestamp of the alarm clearing, in milliseconds | [optional] |
| **assignTs** | **Long** | Timestamp of the alarm assignment, in milliseconds | [optional] |
| **details** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
| **details** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with alarm details | [optional] |
| **propagate** | **Boolean** | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | [optional] |
| **propagateToOwner** | **Boolean** | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | [optional] |
| **propagateToTenant** | **Boolean** | Propagation flag to specify if alarm should be propagated to the tenant entity | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmData.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
| **ackTs** | **Long** | Timestamp of the alarm acknowledgement, in milliseconds | [optional] |
| **clearTs** | **Long** | Timestamp of the alarm clearing, in milliseconds | [optional] |
| **assignTs** | **Long** | Timestamp of the alarm assignment, in milliseconds | [optional] |
| **details** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with alarm details | [optional] |
| **propagate** | **Boolean** | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | [optional] |
| **propagateToOwner** | **Boolean** | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | [optional] |
| **propagateToTenant** | **Boolean** | Propagation flag to specify if alarm should be propagated to the tenant entity | [optional] |
Expand All @@ -34,7 +35,6 @@
| **assignee** | **AlarmAssignee** | Alarm assignee | [optional] |
| **name** | **String** | representing type of the Alarm | [readonly] |
| **status** | **AlarmStatus** | status of the Alarm | [readonly] |
| **details** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AlarmId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.AlarmId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
| **ackTs** | **Long** | Timestamp of the alarm acknowledgement, in milliseconds | [optional] |
| **clearTs** | **Long** | Timestamp of the alarm clearing, in milliseconds | [optional] |
| **assignTs** | **Long** | Timestamp of the alarm assignment, in milliseconds | [optional] |
| **details** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with alarm details | [optional] |
| **propagate** | **Boolean** | Propagation flag to specify if alarm should be propagated to parent entities of alarm originator | [optional] |
| **propagateToOwner** | **Boolean** | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator | [optional] |
| **propagateToTenant** | **Boolean** | Propagation flag to specify if alarm should be propagated to the tenant entity | [optional] |
Expand All @@ -32,7 +33,6 @@
| **assignee** | **AlarmAssignee** | Alarm assignee | [optional] |
| **name** | **String** | representing type of the Alarm | [readonly] |
| **status** | **AlarmStatus** | status of the Alarm | [readonly] |
| **details** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/ApiKeyControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ ApiKey saveApiKey(@Nonnull ApiKeyInfo apiKeyInfo)

Save API key for user (saveApiKey)

Creates an API key for the given user and returns the token ONCE as 'ApiKey <value>'. Available for any authorized user.
Creates an API key for the given user and returns the token ONCE as 'ApiKey {value}'. Available for any authorized user.


### Parameters
Expand Down
4 changes: 2 additions & 2 deletions ce/docs/ApiKeyId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.ApiKeyId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
14 changes: 4 additions & 10 deletions ce/docs/OtaPackageData.md → ce/docs/ApiUsageStateId.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@

# OtaPackageData
# ApiUsageStateId

`org.thingsboard.client.model.OtaPackageData`
`org.thingsboard.client.model.ApiUsageStateId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **_short** | **Integer** | | [optional] |
| **_char** | **String** | | [optional] |
| **_int** | **Integer** | | [optional] |
| **_long** | **Long** | | [optional] |
| **_float** | **Float** | | [optional] |
| **_double** | **Double** | | [optional] |
| **direct** | **Boolean** | | [optional] |
| **readOnly** | **Boolean** | | [optional] |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AssetId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.AssetId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AssetProfileId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.AssetProfileId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
1 change: 0 additions & 1 deletion ce/docs/AttributesOutput.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **strategy** | **AttributesOutputStrategy** | | [optional] |



Expand Down
1 change: 1 addition & 0 deletions ce/docs/CalculatedField.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
| **configurationVersion** | **Integer** | Version of calculated field configuration. | [optional] |
| **_configuration** | **CalculatedFieldConfiguration** | | |
| **version** | **Long** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the calculated field | [optional] |



Expand Down
11 changes: 9 additions & 2 deletions ce/docs/CalculatedFieldDebugEventFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,22 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **server** | **String** | String value representing the server name, identifier or ip address where the platform is running | [optional] |
| **isError** | **IsErrorEnum** | Boolean value to filter the errors | [optional] |
| **errorStr** | **String** | The case insensitive 'contains' filter based on error message | [optional] |
| **entityId** | **String** | String value representing the entity id in the event body | [optional] |
| **entityType** | **EntityTypeEnum** | String value representing the entity type | [optional] |
| **msgId** | **String** | String value representing the message id in the rule engine | [optional] |
| **msgType** | **String** | String value representing the message type | [optional] |
| **arguments** | **String** | String value representing the arguments that were used in the calculation performed | [optional] |
| **result** | **String** | String value representing the result of a calculation | [optional] |
| **isError** | **Boolean** | | [optional] |
| **error** | **Boolean** | | [optional] |


### Enum: IsErrorEnum

| Name | Value |
|---- | -----|
| FALSE | "false" |
| TRUE | "true" |


### Enum: EntityTypeEnum
Expand Down
4 changes: 2 additions & 2 deletions ce/docs/CalculatedFieldId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.CalculatedFieldId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
1 change: 1 addition & 0 deletions ce/docs/CalculatedFieldInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
| **configurationVersion** | **Integer** | Version of calculated field configuration. | [optional] |
| **_configuration** | **CalculatedFieldConfiguration** | | |
| **version** | **Long** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the calculated field | [optional] |
| **entityName** | **String** | | [optional] |


Expand Down
1 change: 0 additions & 1 deletion ce/docs/CustomMobilePage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **label** | **String** | Page label | [optional] |
| **visible** | **Boolean** | Indicates if page is visible | |
| **icon** | **String** | URL of the page icon | [optional] |
| **path** | **String** | Path to custom page | [optional] |

Expand Down
4 changes: 2 additions & 2 deletions ce/docs/CustomerId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.CustomerId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
8 changes: 4 additions & 4 deletions ce/docs/Dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
| **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] |
| **title** | **String** | Title of the dashboard. | |
| **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] |
| **version** | **Long** | | [optional] |
| **resources** | **List\<ResourceExportData\>** | | [optional] |
| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
| **_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] |
| **name** | **String** | Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard. | [optional] [readonly] |
| **resources** | **List\<ResourceExportData\>** | | [optional] |
| **version** | **Long** | | [optional] |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/DashboardId.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

`org.thingsboard.client.model.DashboardId`

**Extends:** **EntityId**

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | string | |



Expand Down
1 change: 0 additions & 1 deletion ce/docs/DashboardPage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **label** | **String** | Page label | [optional] |
| **visible** | **Boolean** | Indicates if page is visible | |
| **icon** | **String** | URL of the page icon | [optional] |
| **dashboardId** | **String** | Dashboard id | [optional] |

Expand Down
1 change: 0 additions & 1 deletion ce/docs/DefaultMobilePage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **label** | **String** | Page label | [optional] |
| **visible** | **Boolean** | Indicates if page is visible | |
| **icon** | **String** | URL of the page icon | [optional] |
| **id** | **DefaultPageId** | Identifier for default page | [optional] |

Expand Down
Loading
Loading