Skip to content

Update PAAS OpenAPI spec #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ViacheslavKlimov merged 2 commits into from
Mar 6, 2026
Merged

Update PAAS OpenAPI spec #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf89037
Update PAAS OpenAPI spec (from develop/4.4)
Mar 6, 2026
b586a62
Merge branch 'master' into auto/update-paas-client
ViacheslavKlimov Mar 6, 2026
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
31 changes: 0 additions & 31 deletions paas/docs/AiAuditLogControllerApi.md
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions paas/docs/AiChatControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
```
com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body) // createChat
void deleteChat(@Nonnull UUID chatId) // deleteChat
byte[] exportChat(@Nonnull UUID chatId, @Nullable Boolean includeAuditLogs) // exportChat
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId) // getChatMessages
com.fasterxml.jackson.databind.JsonNode listChats() // listChats
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body) // sendChatMessage
Expand Down Expand Up @@ -57,29 +56,6 @@ deleteChat
null (empty response body)


## exportChat

```
byte[] exportChat(@Nonnull UUID chatId, @Nullable Boolean includeAuditLogs)
```

**GET** `/api/ai/chats/{chatId}/export`

exportChat


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **chatId** | **UUID** | | |
| **includeAuditLogs** | **Boolean** | | [optional] [default to false] |

### Return type

**byte[]**


## getChatMessages

```
Expand Down
2 changes: 1 addition & 1 deletion paas/docs/Asset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| **assetProfileId** | **AssetProfileId** | JSON object with Asset Profile Id. | [optional] |
| **version** | **Long** | | [optional] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [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 paas/docs/AssetInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| **ownerName** | **String** | Owner name | [optional] [readonly] |
| **groups** | **List\<EntityInfo\>** | Groups | [optional] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [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 paas/docs/AssetTypeFilter.md
View file
Open in desktop
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
25 changes: 0 additions & 25 deletions paas/docs/AuditLogStatusFilter.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion paas/docs/BaseReadTsKvQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **Integer** | | [optional] |
| **key** | **String** | | [optional] |
| **startTs** | **Long** | | [optional] |
| **endTs** | **Long** | | [optional] |
| **aggParameters** | **AggregationParams** | | [optional] |
| **limit** | **Integer** | | [optional] |
| **order** | **String** | | [optional] |
| **id** | **Integer** | | [optional] |
| **interval** | **Long** | | [optional] |
| **aggregation** | **Aggregation** | | [optional] |

Expand Down
1 change: 1 addition & 0 deletions paas/docs/CalculatedFieldConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **aiGenerated** | **Boolean** | | [optional] |
| **output** | **Output** | | [optional] |
| **type** | **String** | | |

Expand Down
2 changes: 1 addition & 1 deletion paas/docs/CalculatedFieldDebugEventFilter.md
View file
Open in desktop
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 paas/docs/CustomMobilePage.md
View file
Open in desktop
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 paas/docs/Customer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| **name** | **String** | Name of the customer. Read-only, duplicated from title for backward compatibility | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with parent Customer Id | [optional] [readonly] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [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
2 changes: 1 addition & 1 deletion paas/docs/CustomerInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| **name** | **String** | Name of the customer. Read-only, duplicated from title for backward compatibility | [optional] [readonly] |
| **customerId** | **CustomerId** | JSON object with parent Customer Id | [optional] [readonly] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [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
14 changes: 7 additions & 7 deletions paas/docs/Dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **title** | **String** | Title of the dashboard. | [optional] |
| **image** | **String** | Thumbnail picture for rendering of the dashboards in a grid view on mobile devices. | [optional] [readonly] |
| **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] |
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [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] |
| **customerId** | **CustomerId** | JSON object with Customer Id. | [optional] |
| **title** | **String** | Title of the dashboard. | [optional] |
| **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** | | [optional] |
| **name** | **String** | Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard. | [optional] [readonly] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |


Expand Down
2 changes: 1 addition & 1 deletion paas/docs/DashboardPage.md
View file
Open in desktop
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 paas/docs/DebugConverterEventFilter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
| 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] |
| **type** | **String** | | [optional] |
| **in** | **String** | | [optional] |
| **out** | **String** | | [optional] |
| **metadata** | **String** | | [optional] |
| **isError** | **Boolean** | | [optional] |
| **error** | **Boolean** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion paas/docs/DebugIntegrationEventFilter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
| 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] |
| **type** | **String** | | [optional] |
| **message** | **String** | | [optional] |
| **statusIntegration** | **String** | | [optional] |
| **isError** | **Boolean** | | [optional] |
| **error** | **Boolean** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion paas/docs/DefaultMobilePage.md
View file
Open in desktop
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 paas/docs/Device.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| **version** | **Long** | | [optional] |
| **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [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] |



Expand Down
2 changes: 1 addition & 1 deletion paas/docs/DeviceInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
| **active** | **Boolean** | Device active flag. | [optional] [readonly] |
| **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [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] |



Expand Down
2 changes: 1 addition & 1 deletion paas/docs/DeviceTypeFilter.md
View file
Open in desktop
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 paas/docs/Edge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A JSON value representing the edge.
| **edgeLicenseType** | **EdgeLicenseType** | | [optional] |
| **version** | **Long** | | [optional] |
| **ownerId** | **EntityId** | | [optional] [readonly] |
| **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 paas/docs/EdgeInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| **ownerName** | **String** | Owner name | [optional] [readonly] |
| **groups** | **List\<EntityInfo\>** | Groups | [optional] |
| **ownerId** | **EntityId** | | [optional] [readonly] |
| **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 paas/docs/EdgeTypeFilter.md
View file
Open in desktop
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 paas/docs/EntityGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A JSON value representing the entity group.
| **type** | **TypeEnum** | | |
| **name** | **String** | Name of the entity group | |
| **ownerId** | **EntityId** | JSON object with the owner of the group - Tenant or Customer Id. | [optional] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Arbitrary JSON with additional information about the group | [optional] |
| **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] |
| **groupAll** | **Boolean** | Indicates special group 'All' that contains all entities and can't be deleted. | [optional] |
Expand Down
4 changes: 2 additions & 2 deletions paas/docs/EntityGroupControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ void addEntitiesToEntityGroup(@Nonnull String entityGroupId, @Nonnull List<Strin

Add entities to the group (addEntitiesToEntityGroup)

Add entities to the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'ADD_TO_GROUP' permission for specified group.
Add entities to the specified entity group. This operation is idempotent: entities that are already members of the group are silently ignored. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'ADD_TO_GROUP' permission for specified group.


### Parameters
Expand Down Expand Up @@ -880,7 +880,7 @@ EntityGroupInfo saveEntityGroup(@Nonnull EntityGroup entityGroup)

Create Or Update Entity Group (saveEntityGroup)

Create or update the Entity Group. When creating Entity Group, platform generates Entity Group Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Entity Group Id will be present in the response. Specify existing Entity Group Id to update the group. Referencing non-existing Entity Group Id will cause 'Not Found' error.Remove 'id', 'tenantId' and optionally 'ownerId' from the request body example (below) to create new Entity Group entity. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group.
Create or update the Entity Group. When creating Entity Group, platform generates Entity Group Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Entity Group Id will be present in the response. Specify existing Entity Group Id to update the group. Referencing non-existing Entity Group Id will cause 'Not Found' error.Remove 'id', 'tenantId' and optionally 'ownerId' from the request body example (below) to create new Entity Group entity. When 'ownerId' is not set (or null), it defaults to the current user's owner (Tenant for tenant admins, Customer for customer users). Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group.


### Parameters
Expand Down
Loading