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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ce/docs/AiModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **AiModelId** | | [optional] |
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
| **tenantId** | **TenantId** | JSON object representing the ID of the tenant associated with this AI model | [readonly] |
| **version** | **Long** | Version of the AI model record; increments automatically whenever the record is changed | [readonly] |
| **name** | **String** | Display name for this AI model configuration; not the technical model identifier | |
| **_configuration** | **AiModelConfig** | Configuration of the AI model | [optional] |
| **id** | **AiModelId** | | [optional] |
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/Alarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
| **type** | **String** | representing type of the Alarm | |
Expand All @@ -25,8 +27,6 @@
| **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] |
| **propagateRelationTypes** | **List\<String\>** | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | [optional] |
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
| **name** | **String** | representing type of the Alarm | [readonly] |
| **status** | **AlarmStatus** | status of the Alarm | [readonly] |

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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **AlarmCommentId** | JSON object with the alarm comment Id. Specify this field to update the alarm comment. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
| **createdTime** | **Long** | Timestamp of the alarm comment creation, in milliseconds | [optional] [readonly] |
| **alarmId** | **AlarmId** | JSON object with Alarm id. | [optional] [readonly] |
| **userId** | **UserId** | JSON object with User id. | [optional] [readonly] |
| **type** | **AlarmCommentType** | Defines origination of comment. System type means comment was created by TB. OTHER type means comment was created by user. | [optional] |
| **comment** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with text of comment. | [optional] |
| **id** | **AlarmCommentId** | JSON object with the alarm comment Id. Specify this field to update the alarm comment. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
| **createdTime** | **Long** | Timestamp of the alarm comment creation, in milliseconds | [optional] [readonly] |
| **name** | **String** | representing comment text | [optional] [readonly] |


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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **key** | **AlarmConditionFilterKey** | JSON object for specifying alarm condition by specific key | [optional] |
| **valueType** | **EntityKeyValueType** | String representation of the type of the value | [optional] |
| **value** | **Object** | | [optional] |
| **key** | **AlarmConditionFilterKey** | JSON object for specifying alarm condition by specific key | [optional] |
| **predicate** | **KeyFilterPredicate** | JSON object representing filter condition | [optional] |
| **value** | **Object** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmConditionValueAlarmRuleSchedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **staticValue** | **AlarmRuleSchedule** | | [optional] |
| **dynamicValueArgument** | **String** | | [optional] |
| **staticValue** | **AlarmRuleSchedule** | | [optional] |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AlarmCountQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ A JSON value representing the alarm count query.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entityFilter** | **EntityFilter** | | [optional] |
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
| **startTs** | **Long** | | [optional] |
| **endTs** | **Long** | | [optional] |
| **timeWindow** | **Long** | | [optional] |
Expand All @@ -17,8 +19,6 @@ A JSON value representing the alarm count query.
| **severityList** | **List\<AlarmSeverity\>** | | [optional] |
| **searchPropagatedAlarms** | **Boolean** | | [optional] |
| **assigneeId** | **UserId** | | [optional] |
| **entityFilter** | **EntityFilter** | | [optional] |
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |



Expand Down
4 changes: 2 additions & 2 deletions ce/docs/AlarmData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entityId** | **EntityId** | | [optional] |
| **latest** | **Map\<String, Map<String, TsValue>\>** | | [optional] |
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
Expand All @@ -33,6 +31,8 @@
| **originatorLabel** | **String** | Alarm originator label | [optional] |
| **originatorDisplayName** | **String** | Originator display name | [optional] |
| **assignee** | **AlarmAssignee** | Alarm assignee | [optional] |
| **entityId** | **EntityId** | | [optional] |
| **latest** | **Map\<String, Map<String, TsValue>\>** | | [optional] |
| **name** | **String** | representing type of the Alarm | [readonly] |
| **status** | **AlarmStatus** | status of the Alarm | [readonly] |

Expand Down
10 changes: 5 additions & 5 deletions ce/docs/AlarmDataPageLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | | [optional] |
| **page** | **Integer** | | [optional] |
| **textSearch** | **String** | | [optional] |
| **sortOrder** | **EntityDataSortOrder** | | [optional] |
| **dynamic** | **Boolean** | | [optional] |
| **startTs** | **Long** | | [optional] |
| **endTs** | **Long** | | [optional] |
| **timeWindow** | **Long** | | [optional] |
Expand All @@ -15,11 +20,6 @@
| **severityList** | **List\<AlarmSeverity\>** | | [optional] |
| **searchPropagatedAlarms** | **Boolean** | | [optional] |
| **assigneeId** | **UserId** | | [optional] |
| **pageSize** | **Integer** | | [optional] |
| **page** | **Integer** | | [optional] |
| **textSearch** | **String** | | [optional] |
| **sortOrder** | **EntityDataSortOrder** | | [optional] |
| **dynamic** | **Boolean** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **condition** | **AlarmCondition** | JSON object representing the alarm rule condition | [optional] |
| **schedule** | **AlarmSchedule** | JSON object representing time interval during which the rule is active | [optional] |
| **alarmDetails** | **String** | String value representing the additional details for an alarm rule | [optional] |
| **dashboardId** | **DashboardId** | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | [optional] |
| **schedule** | **AlarmSchedule** | JSON object representing time interval during which the rule is active | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmRuleConditionFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **argument** | **String** | | |
| **valueType** | **EntityKeyValueType** | | |
| **operation** | **ComplexOperation** | | [optional] |
| **predicates** | **List\<AlarmRuleKeyFilterPredicate\>** | | |
| **valueType** | **EntityKeyValueType** | | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmRuleCustomTimeSchedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **timezone** | **String** | | [optional] |
| **items** | **List\<AlarmRuleCustomTimeScheduleItem\>** | | [optional] |
| **timezone** | **String** | | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **enabled** | **Boolean** | | [optional] |
| **dayOfWeek** | **Integer** | | [optional] |
| **startsOn** | **Long** | | [optional] |
| **enabled** | **Boolean** | | [optional] |
| **endsOn** | **Long** | | [optional] |
| **startsOn** | **Long** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmRuleDefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **condition** | **AlarmRuleCondition** | | |
| **alarmDetails** | **String** | | [optional] |
| **condition** | **AlarmRuleCondition** | | |
| **dashboardId** | **DashboardId** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmRuleNoDataFilterPredicate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **unit** | **TimeUnit** | | |
| **duration** | **AlarmConditionValueLong** | | |
| **unit** | **TimeUnit** | | |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **timezone** | **String** | | [optional] |
| **daysOfWeek** | **Set\<Integer\>** | | [optional] |
| **startsOn** | **Long** | | [optional] |
| **endsOn** | **Long** | | [optional] |
| **startsOn** | **Long** | | [optional] |
| **timezone** | **String** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmRuleStringFilterPredicate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **ignoreCase** | **Boolean** | | [optional] |
| **operation** | **StringOperation** | | |
| **value** | **AlarmConditionValueString** | | |
| **ignoreCase** | **Boolean** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AlarmSchedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Configuration for alarm schedule

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **type** | **AlarmScheduleType** | | [optional] |
| **dynamicValue** | **DynamicValueString** | | [optional] |
| **type** | **AlarmScheduleType** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AliasEntityId.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **aliasEntityType** | **AliasEntityType** | | [optional] |
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |
| **entityType** | **EntityType** | | |
| **id** | **UUID** | ID of the entity, time-based UUID v1 | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AssetProfileInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **EntityId** | JSON object with the entity Id. | [optional] |
| **tenantId** | **TenantId** | Tenant id. | [optional] |
| **name** | **String** | Entity Name | [optional] |
| **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] |
| **defaultDashboardId** | **DashboardId** | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to asset details. | [optional] |
| **tenantId** | **TenantId** | Tenant id. | [optional] |



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

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



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/CalculatedField.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
| **entityId** | **EntityId** | | [optional] |
| **type** | **CalculatedFieldType** | | [optional] |
| **name** | **String** | User defined name of the calculated field. | [optional] |
| **debugMode** | **Boolean** | | [optional] |
| **debugSettings** | **DebugSettings** | Debug settings object. | [optional] |
| **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] |
| **debugMode** | **Boolean** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/CalculatedFieldInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@
| **entityId** | **EntityId** | | [optional] |
| **type** | **CalculatedFieldType** | | [optional] |
| **name** | **String** | User defined name of the calculated field. | [optional] |
| **debugMode** | **Boolean** | | [optional] |
| **debugSettings** | **DebugSettings** | Debug settings object. | [optional] |
| **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] |
| **debugMode** | **Boolean** | | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **enabled** | **Boolean** | | [optional] |
| **dayOfWeek** | **Integer** | | [optional] |
| **startsOn** | **Long** | | [optional] |
| **enabled** | **Boolean** | | [optional] |
| **endsOn** | **Long** | | [optional] |
| **startsOn** | **Long** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/Customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
| **title** | **String** | Title of the customer | |
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
| **version** | **Long** | | [optional] |
| **name** | **String** | Name of the customer. Read-only, duplicated from title for backward compatibility | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the customer. May include: 'description' (string), 'homeDashboardId' (string, UUID of the home dashboard), 'homeDashboardHideToolbar' (boolean, whether to hide the dashboard toolbar), 'isPublic' (boolean, whether this is a public customer). | [optional] |
| **name** | **String** | Name of the customer. Read-only, duplicated from title for backward compatibility | [optional] [readonly] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DeviceProfileInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **EntityId** | JSON object with the entity Id. | [optional] |
| **tenantId** | **TenantId** | Tenant id. | [optional] |
| **name** | **String** | Entity Name | [optional] |
| **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] |
| **defaultDashboardId** | **DashboardId** | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details. | [optional] |
| **type** | **DeviceProfileType** | Type of the profile. Always 'DEFAULT' for now. Reserved for future use. | [optional] |
| **transportType** | **DeviceTransportType** | Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT. | [optional] |
| **tenantId** | **TenantId** | Tenant id. | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DynamicValueBoolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **resolvedValue** | **Boolean** | | [optional] |
| **sourceType** | **DynamicValueSourceType** | | [optional] |
| **sourceAttribute** | **String** | | [optional] |
| **inherit** | **Boolean** | | [optional] |
| **resolvedValue** | **Boolean** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DynamicValueDouble.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **resolvedValue** | **Double** | | [optional] |
| **sourceType** | **DynamicValueSourceType** | | [optional] |
| **sourceAttribute** | **String** | | [optional] |
| **inherit** | **Boolean** | | [optional] |
| **resolvedValue** | **Double** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DynamicValueInteger.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **resolvedValue** | **Integer** | | [optional] |
| **sourceType** | **DynamicValueSourceType** | | [optional] |
| **sourceAttribute** | **String** | | [optional] |
| **inherit** | **Boolean** | | [optional] |
| **resolvedValue** | **Integer** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DynamicValueLong.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **resolvedValue** | **Long** | | [optional] |
| **sourceType** | **DynamicValueSourceType** | | [optional] |
| **sourceAttribute** | **String** | | [optional] |
| **inherit** | **Boolean** | | [optional] |
| **resolvedValue** | **Long** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DynamicValueString.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **resolvedValue** | **String** | | [optional] |
| **sourceType** | **DynamicValueSourceType** | | [optional] |
| **sourceAttribute** | **String** | | [optional] |
| **inherit** | **Boolean** | | [optional] |
| **resolvedValue** | **String** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityExportData.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Base export container for ThingsBoard entities

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entityType** | **EntityType** | | |
| **entity** | **ExportableEntity** | | [optional] |
| **relations** | **List\<EntityRelation\>** | | [optional] |
| **attributes** | **Map\<String, List<AttributeExportData>\>** | Map of attributes where key is the scope of attributes and value is the list of attributes for that scope | [optional] |
| **calculatedFields** | **List\<CalculatedField\>** | | [optional] |
| **entityType** | **EntityType** | | |



Expand Down
Loading
Loading