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
2 changes: 1 addition & 1 deletion pe/docs/Alarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| **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] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
| **type** | **String** | representing type of the Alarm | |
| **originator** | **EntityId** | JSON object with alarm originator id | |
| **severity** | **AlarmSeverity** | Alarm severity | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/AlarmData.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| **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] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
| **type** | **String** | representing type of the Alarm | |
| **originator** | **EntityId** | JSON object with alarm originator id | |
| **severity** | **AlarmSeverity** | Alarm severity | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/AlarmInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| **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] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
| **type** | **String** | representing type of the Alarm | |
| **originator** | **EntityId** | JSON object with alarm originator id | |
| **severity** | **AlarmSeverity** | Alarm severity | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/Asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **createdTime** | **Long** | Timestamp of the asset creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
| **name** | **String** | Unique Asset Name in scope of Tenant | |
| **type** | **String** | Asset type | [optional] |
| **label** | **String** | Label that may be used in widgets | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/AssetInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **createdTime** | **Long** | Timestamp of the asset creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
| **name** | **String** | Unique Asset Name in scope of Tenant | |
| **type** | **String** | Asset type | [optional] |
| **label** | **String** | Label that may be used in widgets | [optional] |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/AvailableEntityKeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entityTypes** | **Set\<EntityType\>** | Set of entity types found among the matched entities. | |
| **timeseries** | **Set\<String\>** | | |
| **attribute** | **Set\<String\>** | | |
| **timeseries** | **Set\<String\>** | List of unique time series key names available on the matched entities. | |
| **attribute** | **Set\<String\>** | List of unique attribute key names available on the matched entities. | |



Expand Down
2 changes: 1 addition & 1 deletion pe/docs/AvailableEntityKeysV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Contains unique time series and attribute key names discovered from entities mat
|------------ | ------------- | ------------- | -------------|
| **totalEntities** | **Integer** | Total number of entities that matched the query filter. | |
| **entityTypes** | **Set\<EntityType\>** | Set of entity types found among the matched entities. | |
| **timeseries** | **List\<KeyInfo\>** | | [optional] |
| **timeseries** | **List\<KeyInfo\>** | List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. | [optional] |
| **attributes** | **Map\<String, List<KeyInfo>\>** | Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types. | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion pe/docs/Device.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **createdTime** | **Long** | Timestamp of the device creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device. May include: 'gateway' (boolean, whether the device is a gateway), 'description' (string), 'lastConnectedGateway' (string, UUID of the last gateway that connected this device). | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignDeviceToCustomer' to change the Customer Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Device. | [optional] |
| **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
| **type** | **String** | Device Profile Name | [optional] |
| **label** | **String** | Label that may be used in widgets | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/DeviceInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **createdTime** | **Long** | Timestamp of the device creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device. May include: 'gateway' (boolean, whether the device is a gateway), 'description' (string), 'lastConnectedGateway' (string, UUID of the last gateway that connected this device). | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignDeviceToCustomer' to change the Customer Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Device. | [optional] |
| **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
| **type** | **String** | Device Profile Name | [optional] |
| **label** | **String** | Label that may be used in widgets | [optional] |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/Edge.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ A JSON value representing the edge.
| **id** | **EdgeId** | JSON object with the Edge Id. Specify this field to update the Edge. Referencing non-existing Edge Id will cause error. Omit this field to create new Edge. | [optional] |
| **createdTime** | **Long** | Timestamp of the edge creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the edge. May include: 'description' (string). | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignEdgeToCustomer' to change the Customer Id. | [optional] [readonly] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. Always set to the tenant of the current user on save; cannot be changed after creation. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. | [optional] |
| **rootRuleChainId** | **RuleChainId** | JSON object with Root Rule Chain Id. Use 'setEdgeRootRuleChain' to change the Root Rule Chain Id. | [optional] [readonly] |
| **name** | **String** | Unique Edge Name in scope of Tenant | |
| **type** | **String** | Edge type | |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/EdgeInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
| **id** | **EdgeId** | JSON object with the Edge Id. Specify this field to update the Edge. Referencing non-existing Edge Id will cause error. Omit this field to create new Edge. | [optional] |
| **createdTime** | **Long** | Timestamp of the edge creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the edge. May include: 'description' (string). | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignEdgeToCustomer' to change the Customer Id. | [optional] [readonly] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. Always set to the tenant of the current user on save; cannot be changed after creation. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. | [optional] |
| **rootRuleChainId** | **RuleChainId** | JSON object with Root Rule Chain Id. Use 'setEdgeRootRuleChain' to change the Root Rule Chain Id. | [optional] [readonly] |
| **name** | **String** | Unique Edge Name in scope of Tenant | |
| **type** | **String** | Edge type | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/EntityDataDiff.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
#### WidgetsBundleExportData *(extends EntityExportData, entityType=`WIDGETS_BUNDLE`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| widgets | List<com.fasterxml.jackson.databind.JsonNode> | | [optional] |
| widgets | List<com.fasterxml.jackson.databind.JsonNode> | List of widgets in the bundle | [optional] |
| fqns | List<String> | | [optional] |

#### WidgetTypeExportData *(extends EntityExportData, entityType=`WIDGET_TYPE`)*
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/EntityExportData.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Base export container for ThingsBoard entities
#### WidgetsBundleExportData *(entityType=`WIDGETS_BUNDLE`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| widgets | List<com.fasterxml.jackson.databind.JsonNode> | | [optional] |
| widgets | List<com.fasterxml.jackson.databind.JsonNode> | List of widgets in the bundle | [optional] |
| fqns | List<String> | | [optional] |

#### WidgetTypeExportData *(entityType=`WIDGET_TYPE`)*
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/EntityGroupInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity group. May include: 'description' (string), 'isPublic' (boolean, whether this group is shared publicly), 'publicCustomerId' (string, UUID of the public customer associated with this group). | [optional] |
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON with the configuration for UI components: list of columns, settings, actions, etc | [optional] |
| **version** | **Long** | | [optional] |
| **ownerIds** | **Set\<EntityId\>** | | [optional] |
| **ownerIds** | **Set\<EntityId\>** | List of the entity group owners. | |
| **edgeGroupAll** | **Boolean** | Indicates special edge group 'All' that contains all entities and can't be deleted. | [optional] [readonly] |
| **groupAll** | **Boolean** | Indicates special group 'All' that contains all entities and can't be deleted. | [optional] |
| **tenantId** | **TenantId** | | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/EntityView.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A JSON object representing the entity view.
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity view. May include: 'description' (string). | [optional] |
| **entityId** | **EntityId** | JSON object with the referenced Entity Id (Device or Asset). | |
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignEntityViewToCustomer' to change the Customer Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Entity View. | [optional] |
| **name** | **String** | Entity View name | |
| **type** | **String** | Device Profile Name | |
| **keys** | **TelemetryEntityView** | Set of telemetry and attribute keys to expose via Entity View. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/EntityViewInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity view. May include: 'description' (string). | [optional] |
| **entityId** | **EntityId** | JSON object with the referenced Entity Id (Device or Asset). | |
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignEntityViewToCustomer' to change the Customer Id. | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Entity View. | [optional] |
| **name** | **String** | Entity View name | |
| **type** | **String** | Device Profile Name | |
| **keys** | **TelemetryEntityView** | Set of telemetry and attribute keys to expose via Entity View. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/GroupPermissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
| createdTime | Long | Timestamp of the role creation, in milliseconds | [optional] [readonly] |
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | Additional parameters of the role. May include: 'description' (string). | [optional] |
| tenantId | TenantId | JSON object with Tenant Id. | [optional] [readonly] |
| customerId | CustomerId | JSON object with Customer Id. | [optional] [readonly] |
| customerId | CustomerId | JSON object with Customer Id. Optional: when omitted the Role is owned by the tenant. When the request is made by a Customer user, the value is forced to the user's own Customer Id. | [optional] |
| name | String | Role Name | |
| type | RoleType | Type of the role: generic or group | |
| permissions | com.fasterxml.jackson.databind.JsonNode | Set of permissions granted by this role. The JSON shape depends on the role 'type': * GENERIC — JSON object mapping `Resource` enum names to arrays of `Operation` enum names allowed on that resource. The wildcard entry `{\"ALL\":[\"ALL\"]}` grants every operation on every resource. * GROUP — JSON array of `Operation` enum names that apply to the entity group this role is bound to via `GroupPermission.entityGroupId`. Only operations with `allowedForGroupRole=true` may appear (see `Operation` enum). The wildcard entry `[\"ALL\"]` grants every supported operation on the bound entity group. | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/PageDataAlarmData.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| 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] |
| customerId | CustomerId | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
| type | String | representing type of the Alarm | |
| originator | EntityId | JSON object with alarm originator id | |
| severity | AlarmSeverity | Alarm severity | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/PageDataAlarmInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| 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] |
| customerId | CustomerId | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
| type | String | representing type of the Alarm | |
| originator | EntityId | JSON object with alarm originator id | |
| severity | AlarmSeverity | Alarm severity | |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/PageDataAsset.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| createdTime | Long | Timestamp of the asset creation, in milliseconds | [optional] [readonly] |
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | Additional parameters of the asset. May include: 'description' (string). | [optional] |
| tenantId | TenantId | JSON object with Tenant Id. | [optional] [readonly] |
| customerId | CustomerId | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
| customerId | CustomerId | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
| name | String | Unique Asset Name in scope of Tenant | |
| type | String | Asset type | [optional] |
| label | String | Label that may be used in widgets | [optional] |
Expand Down
Loading
Loading