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
6 changes: 3 additions & 3 deletions pe/docs/AiChatControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body) // crea
void deleteChat(@Nonnull UUID chatId) // deleteChat
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId) // getChatMessages
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType) // listChats
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body, @Nullable String acceptLanguage) // sendChatMessage
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull Object body, @Nullable String acceptLanguage) // sendChatMessage
void updateChat(@Nonnull UUID chatId, @Nonnull Object body) // updateChat
```

Expand Down Expand Up @@ -103,7 +103,7 @@ listChats
## sendChatMessage

```
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body, @Nullable String acceptLanguage)
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull Object body, @Nullable String acceptLanguage)
```

**POST** `/api/ai/chats/{chatId}/messages`
Expand All @@ -117,7 +117,7 @@ sendChatMessage
|------------- | ------------- | ------------- | -------------|
| **chatId** | **UUID** | | |
| **xAuthorization** | **String** | | |
| **body** | **String** | | |
| **body** | **Object** | | |
| **acceptLanguage** | **String** | | [optional] |

### Return type
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/AlarmControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ Alarm saveAlarm(@Nonnull Alarm alarm)

Create or Update Alarm (saveAlarm)

Creates or Updates the Alarm. When creating alarm, platform generates Alarm Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. Referencing non-existing Alarm Id will cause 'Not Found' error. Platform also deduplicate the alarms based on the entity id of originator and alarm 'type'. For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Alarm entity. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
Creates or Updates the Alarm. When creating alarm, platform generates Alarm Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. Referencing non-existing Alarm Id will cause 'Not Found' error. Platform also deduplicate the alarms based on the entity id of originator and alarm 'type'. For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Alarm entity. The alarm originator is an immutable routing key: when updating an existing alarm, the 'originator' in the request body must match the stored alarm's originator. A request that references an existing alarm id but carries a different originator is treated as a lookup miss and causes a 'Not Found' error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).


### Parameters
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/Dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| **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] |
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [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] |
| **resources** | **List\<ResourceExportData\>** | | [optional] |
| **version** | **Long** | | [optional] |

Expand Down
2 changes: 1 addition & 1 deletion pe/docs/DashboardInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| **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] |
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [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] |
| **resources** | **List\<ResourceExportData\>** | | [optional] |
| **version** | **Long** | | [optional] |
| **groups** | **List\<EntityInfo\>** | Groups | [optional] |
Expand Down
8 changes: 4 additions & 4 deletions pe/docs/EntityGroupControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -930,16 +930,16 @@ void shareEntityGroupToChildOwnerUserGroup(@Nonnull String entityGroupId, @Nonnu

Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup)

Share the entity group with specified user group using specified role. 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.
Share the entity group with the specified user group using the specified role. Unlike the 'shareEntityGroup' API method, this method is designed for sharing 'down' the owner hierarchy and does not require 'WRITE' permission for the shared entity group or the target user group. In particular, it allows the current user to re-share an entity group that was shared with them by the parent owner: for example, a customer user may re-share a tenant-owned dashboard group with a user group of their sub-customer. The following security checks are performed: * the target user group must belong to the current user's owner or to one of its sub-customers; * the current user must have the 'SHARE_GROUP' operation granted for the shared entity group: either as a generic permission for the corresponding entity group resource (applies only if the shared entity group belongs to the current user's owner hierarchy), or as a group permission created when the entity group was shared with the current user's user group using a group role that includes the 'SHARE_GROUP' operation; * the specified role must be a group role that is readable by the current user, so it must belong to the current user's owner or to one of its sub-customers; * the operations of the specified role must be a subset of the operations the current user was granted for the shared entity group (always passes if the current user was granted the 'ALL' operation). If the specified role also includes the 'SHARE_GROUP' operation, the members of the target user group will be able to re-share the entity group further down their own owner hierarchy in the same way. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **entityGroupId** | **String** | A string value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **userGroupId** | **String** | A string value representing the Entity(User) Group Id that you would like to share with. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **roleId** | **String** | A string value representing the Role Id that describes set of permissions you would like to share (read, write, etc). For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **entityGroupId** | **String** | ID of the entity group to share | |
| **userGroupId** | **String** | ID of the user group to share the entity group with. The user group must belong to the current user's owner or to one of its sub-customers | |
| **roleId** | **String** | ID of the group role that defines the set of operations to grant to the target user group | |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion pe/docs/HomeDashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| **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] |
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [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] |
| **resources** | **List\<ResourceExportData\>** | | [optional] |
| **version** | **Long** | | [optional] |
| **hideDashboardToolbar** | **Boolean** | Hide dashboard toolbar flag. Useful for rendering dashboards on mobile. | [optional] |
Expand Down
4 changes: 4 additions & 0 deletions pe/docs/Job.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |
| targets | List<UUID> | | [optional] |
| notificationTemplateId | NotificationTemplateId | | [optional] |
| notificationRequests | List<NotificationRequest> | | [optional] |
Expand Down Expand Up @@ -163,7 +164,9 @@
| format | TbReportFormat | | |
| name | String | | |
| userId | UserId | | |
| publicKey | String | | [optional] |
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
| _public | Boolean | | [optional] |

#### NotificationTemplate
| Name | Type | Description | Notes |
Expand Down Expand Up @@ -221,6 +224,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### DeliveryMethodNotificationTemplate
| Name | Type | Description | Notes |
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/JobConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |
| targets | List<UUID> | | [optional] |
| notificationTemplateId | NotificationTemplateId | | [optional] |
| notificationRequests | List<NotificationRequest> | | [optional] |
Expand Down Expand Up @@ -160,6 +161,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### DeliveryMethodNotificationTemplate
| Name | Type | Description | Notes |
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/JobResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ Job execution result
| format | TbReportFormat | | |
| name | String | | |
| userId | UserId | | |
| publicKey | String | | [optional] |
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
| _public | Boolean | | [optional] |

#### TbReportFormat (enum)
`PDF` | `CSV`
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/LoginWhiteLabelingParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ A JSON value representing the login white labeling configuration
|------------ | ------------- | ------------- | -------------|
| **logoImageUrl** | **String** | Logo image URL | [optional] |
| **logoImageHeight** | **Integer** | The height of a logo container. Logo image will be automatically scaled. | [optional] |
| **collapsedLogoImageUrl** | **String** | Logo shown when side menu is collapsed | [optional] |
| **appTitle** | **String** | White-labeled name of the platform | [optional] |
| **favicon** | **Favicon** | JSON object that contains website icon url and type | [optional] |
| **paletteSettings** | **PaletteSettings** | Complex JSON that describes structure of the Angular Material Palette. See [theming](https://material.angular.io/guide/theming) for more details | [optional] |
| **primaryColorPanels** | **Boolean** | Whether primary-color panels (top toolbar, side navigation, dialog and entity-details headers) use the primary palette color as background. When false, they render on a white background | [optional] |
| **helpLinkBaseUrl** | **String** | Base URL for help link | [optional] |
| **uiHelpBaseUrl** | **String** | Base URL for the repository with the UI help components (markdown) | [optional] |
| **enableHelpLinks** | **Boolean** | Enable or Disable help links | [optional] |
Expand Down
1 change: 1 addition & 0 deletions pe/docs/NotificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### EntityType (enum)
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total)
Expand Down
1 change: 1 addition & 0 deletions pe/docs/NotificationRequestInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### EntityType (enum)
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total)
Expand Down
1 change: 1 addition & 0 deletions pe/docs/NotificationTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### DeliveryMethodNotificationTemplate
| Name | Type | Description | Notes |
Expand Down
1 change: 1 addition & 0 deletions pe/docs/NotificationTemplateConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
| **reportTemplateId** | **ReportTemplateId** | | [optional] |
| **userId** | **UserId** | | [optional] |
| **timezone** | **String** | | [optional] |
| **makePublic** | **Boolean** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion pe/docs/PageDataDashboardInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
| 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] |
| _configuration | com.fasterxml.jackson.databind.JsonNode | | [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] |
| resources | List<ResourceExportData> | | [optional] |
| version | Long | | [optional] |
| groups | List<EntityInfo> | Groups | [optional] |
Expand Down
4 changes: 4 additions & 0 deletions pe/docs/PageDataJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |
| targets | List<UUID> | | [optional] |
| notificationTemplateId | NotificationTemplateId | | [optional] |
| notificationRequests | List<NotificationRequest> | | [optional] |
Expand Down Expand Up @@ -171,7 +172,9 @@
| format | TbReportFormat | | |
| name | String | | |
| userId | UserId | | |
| publicKey | String | | [optional] |
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
| _public | Boolean | | [optional] |

#### NotificationTemplate
| Name | Type | Description | Notes |
Expand Down Expand Up @@ -229,6 +232,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### DeliveryMethodNotificationTemplate
| Name | Type | Description | Notes |
Expand Down
1 change: 1 addition & 0 deletions pe/docs/PageDataNotificationRequestInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### EntityType (enum)
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total)
Expand Down
1 change: 1 addition & 0 deletions pe/docs/PageDataNotificationTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
| reportTemplateId | ReportTemplateId | | [optional] |
| userId | UserId | | [optional] |
| timezone | String | | [optional] |
| makePublic | Boolean | | [optional] |

#### DeliveryMethodNotificationTemplate
| Name | Type | Description | Notes |
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/PageDataReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@
| format | TbReportFormat | | |
| name | String | | |
| userId | UserId | | |
| publicKey | String | | [optional] |
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
| _public | Boolean | | [optional] |

#### TbReportFormat (enum)
`PDF` | `CSV`
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/PageDataReportInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@
| format | TbReportFormat | | |
| name | String | | |
| userId | UserId | | |
| publicKey | String | | [optional] |
| templateInfo | EntityInfo | | [optional] |
| customerTitle | String | | [optional] |
| userName | String | | [optional] |
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
| _public | Boolean | | [optional] |

#### TbReportFormat (enum)
`PDF` | `CSV`
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
| **format** | **TbReportFormat** | | |
| **name** | **String** | | |
| **userId** | **UserId** | | |
| **publicKey** | **String** | | [optional] |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |
| **_public** | **Boolean** | | [optional] |



Expand Down
Loading
Loading