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 ce/docs/Asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| **label** | **String** | Label that may be used in widgets | [optional] |
| **assetProfileId** | **AssetProfileId** | JSON object with Asset Profile Id. | [optional] |
| **version** | **Long** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AssetInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| **customerTitle** | **String** | Title of the Customer that owns the asset. | [optional] [readonly] |
| **customerIsPublic** | **Boolean** | Indicates special 'Public' Customer that is auto-generated to use the assets on public dashboards. | [optional] [readonly] |
| **assetProfileName** | **String** | Name of the corresponding Asset Profile. | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **assetType** | **String** | | [optional] |
| **assetTypes** | **List\<String\>** | | [optional] |
| **assetNameFilter** | **String** | | [optional] |
| **assetType** | **String** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/CalculatedFieldDebugEventFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **server** | **String** | String value representing the server name, identifier or ip address where the platform is running | [optional] |
| **isError** | **Boolean** | | [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] |


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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **path** | **String** | Path to custom page | [optional] |
| **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
2 changes: 1 addition & 1 deletion ce/docs/Customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
| **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 device | [optional] |
| **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] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **DashboardId** | JSON object with the dashboard Id. Specify existing dashboard Id to update the dashboard. Referencing non-existing dashboard id will cause error. Omit this field to create new dashboard. | [optional] |
| **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. | |
| **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] |
| **_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] |
| **id** | **DashboardId** | JSON object with the dashboard Id. Specify existing dashboard Id to update the dashboard. Referencing non-existing dashboard id will cause error. Omit this field to create new dashboard. | [optional] |
| **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] |
| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
| **version** | **Long** | | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **dashboardId** | **String** | Dashboard id | [optional] |
| **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
2 changes: 1 addition & 1 deletion ce/docs/DefaultMobilePage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **DefaultPageId** | Identifier for default page | [optional] |
| **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
2 changes: 1 addition & 1 deletion ce/docs/Device.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
| **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
| **version** | **Long** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device | [optional] |
| **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] |
| **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion ce/docs/DeviceInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| **customerIsPublic** | **Boolean** | Indicates special 'Public' Customer that is auto-generated to use the devices on public dashboards. | [optional] [readonly] |
| **deviceProfileName** | **String** | Name of the corresponding Device Profile. | [optional] [readonly] |
| **active** | **Boolean** | Device active flag. | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device | [optional] |
| **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] |
| **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |


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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **deviceType** | **String** | | [optional] |
| **deviceTypes** | **List\<String\>** | | [optional] |
| **deviceNameFilter** | **String** | | [optional] |
| **deviceType** | **String** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/Edge.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A JSON value representing the edge.
| **routingKey** | **String** | Edge routing key ('username') to authorize on cloud | |
| **secret** | **String** | Edge secret ('password') to authorize on cloud | |
| **version** | **Long** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the edge. May include: 'description' (string). | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EdgeInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| **version** | **Long** | | [optional] |
| **customerTitle** | **String** | | [optional] |
| **customerIsPublic** | **Boolean** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the edge. May include: 'description' (string). | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **edgeType** | **String** | | [optional] |
| **edgeTypes** | **List\<String\>** | | [optional] |
| **edgeNameFilter** | **String** | | [optional] |
| **edgeType** | **String** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityRelation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A JSON value representing the relation.
| **type** | **String** | String value of relation type. | |
| **typeGroup** | **RelationTypeGroup** | Represents the type group of the relation. | |
| **version** | **Long** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the relation | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the relation. | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityRelationInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| **version** | **Long** | | [optional] |
| **fromName** | **String** | Name of the entity for [from] direction. | [optional] [readonly] |
| **toName** | **String** | Name of the entity for [to] direction. | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the relation | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the relation. | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityView.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A JSON object representing the entity view.
| **version** | **Long** | | [optional] |
| **id** | **EntityViewId** | JSON object with the Entity View Id. Specify this field to update the Entity View. Referencing non-existing Entity View Id will cause error. Omit this field to create new Entity View. | [optional] |
| **createdTime** | **Long** | Timestamp of the Entity View creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity view. May include: 'description' (string). | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityViewInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| **version** | **Long** | | [optional] |
| **customerTitle** | **String** | Title of the Customer that owns the entity view. | [optional] [readonly] |
| **customerIsPublic** | **Boolean** | Indicates special 'Public' Customer that is auto-generated to use the entity view on public dashboards. | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity view. May include: 'description' (string). | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entityViewType** | **String** | | [optional] |
| **entityViewTypes** | **List\<String\>** | | [optional] |
| **entityViewNameFilter** | **String** | | [optional] |
| **entityViewType** | **String** | | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **twoFaEnabled** | **Boolean** | | [optional] |
| **emailEnabled** | **Boolean** | | [optional] |
| **smsEnabled** | **Boolean** | | [optional] |
| **oauthEnabled** | **Boolean** | | [optional] |
| **notificationEnabled** | **Boolean** | | [optional] |
| **twoFaEnabled** | **Boolean** | | [optional] |
| **emailEnabled** | **Boolean** | | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entityType** | **EntityType** | | |
| **entity** | **ExportableEntity** | | [optional] |
| **entityType** | **EntityType** | | |
| **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] |
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/RuleChainDebugEventFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **server** | **String** | String value representing the server name, identifier or ip address where the platform is running | [optional] |
| **isError** | **Boolean** | | [optional] |
| **errorStr** | **String** | The case insensitive 'contains' filter based on error message | [optional] |
| **message** | **String** | String value representing the message | [optional] |
| **isError** | **Boolean** | | [optional] |
| **error** | **Boolean** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion ce/docs/RuleNode.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| **configurationVersion** | **Integer** | Version of rule node configuration. | [optional] |
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON with the rule node configuration. Structure depends on the rule node implementation. | [optional] |
| **externalId** | **RuleNodeId** | | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the rule node. Contains 'layoutX' and 'layoutY' properties for visualization. | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the rule node. May include: 'layoutX' (number, X coordinate for visualization), 'layoutY' (number, Y coordinate for visualization), 'description' (string). | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/RuleNodeDebugEventFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **server** | **String** | String value representing the server name, identifier or ip address where the platform is running | [optional] |
| **isError** | **Boolean** | | [optional] |
| **errorStr** | **String** | The case insensitive 'contains' filter based on error message | [optional] |
| **msgDirectionType** | **MsgDirectionTypeEnum** | String value representing msg direction type (incoming to entity or outcoming from entity) | [optional] |
| **entityId** | **String** | String value representing the entity id in the event body (originator of the message) | [optional] |
Expand All @@ -20,6 +19,7 @@
| **relationType** | **String** | String value representing the type of message routing | [optional] |
| **dataSearch** | **String** | The case insensitive 'contains' filter based on data (key and value) for the message. | [optional] |
| **metadataSearch** | **String** | The case insensitive 'contains' filter based on metadata (key and value) for the message. | [optional] |
| **isError** | **Boolean** | | [optional] |
| **error** | **Boolean** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion ce/docs/TelemetryControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ String deleteEntityAttributes(@Nonnull String entityType, @Nonnull String entity

Delete entity attributes (deleteEntityAttributes)

Delete entity attributes using provided Entity Id, scope and a list of keys. Referencing a non-existing entity Id or invalid entity type will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
Delete entity attributes using provided Entity Id, scope and a list of keys. This operation is idempotent: keys that do not exist are silently ignored and the response is still 200 OK. Referencing a non-existing entity Id or invalid entity type will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.


### Parameters
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/Tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A JSON value representing the tenant.
| **tenantProfileId** | **TenantProfileId** | JSON object with Tenant Profile Id | [optional] |
| **version** | **Long** | | [optional] |
| **name** | **String** | Name of the tenant. Read-only, duplicated from title for backward compatibility | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the tenant. May include: 'description' (string), 'homeDashboardId' (string, UUID of the home dashboard), 'homeDashboardHideToolbar' (boolean, whether to hide the dashboard toolbar). | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/TenantInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
| **version** | **Long** | | [optional] |
| **tenantProfileName** | **String** | Tenant Profile name | [optional] |
| **name** | **String** | Name of the tenant. Read-only, duplicated from title for backward compatibility | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the device | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the tenant. May include: 'description' (string), 'homeDashboardId' (string, UUID of the home dashboard), 'homeDashboardHideToolbar' (boolean, whether to hide the dashboard toolbar). | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/User.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A JSON value representing the User.
| **phone** | **String** | Phone number of the user | [optional] |
| **version** | **Long** | | [optional] |
| **name** | **String** | Duplicates the email of the user, readonly | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the user | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the user. May include: 'defaultDashboardId' (string, UUID of the default dashboard), 'defaultDashboardFullscreen' (boolean), 'homeDashboardId' (string, UUID of the home dashboard), 'homeDashboardHideToolbar' (boolean), 'lang' (string, user locale, e.g. 'en_US'), 'authProviderName' (string, name of the authentication provider). | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **url** | **String** | Url | [optional] |
| **label** | **String** | Page label | [optional] |
| **visible** | **Boolean** | Indicates if page is visible | |
| **icon** | **String** | URL of the page icon | [optional] |
| **url** | **String** | Url | [optional] |



Expand Down
Loading