Skip to content

Commit 275dee7

Browse files
ViacheslavKlimovViacheslavKlimov
authored
Merge pull request #66 from thingsboard/auto/update-pe-client-master
Update PE OpenAPI spec in master (from master)
2 parents d1a7fef + 95ab155 commit 275dee7

43 files changed

Lines changed: 3952 additions & 6367 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎pe/docs/AssetControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Returns a page of asset info objects owned by the tenant or the customer of a cu
8888
|------------- | ------------- | ------------- | -------------|
8989
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
9090
| **page** | **Integer** | Sequence number of page starting from 0 | |
91-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
91+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
9292
| **assetProfileId** | **String** | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
9393
| **textSearch** | **String** | The case insensitive 'substring' filter based on the asset name. | [optional] |
9494
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
@@ -237,7 +237,7 @@ Returns a page of asset info objects owned by the specified customer. Asset Info
237237
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
238238
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
239239
| **page** | **Integer** | Sequence number of page starting from 0 | |
240-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
240+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
241241
| **assetProfileId** | **String** | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
242242
| **textSearch** | **String** | The case insensitive 'substring' filter based on the asset name. | [optional] |
243243
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |

‎pe/docs/CsvReportTemplateConfig.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -751,8 +751,8 @@
751751
| decimals | Integer | | [optional] |
752752
| interval | Double | | [optional] |
753753
| splitNumber | Integer | | [optional] |
754-
| min | Double | | [optional] |
755-
| max | Double | | [optional] |
754+
| min | SimpleValueSourceConfig | | [optional] |
755+
| max | SimpleValueSourceConfig | | [optional] |
756756

757757
#### TimeSeriesChartXAxisSettings
758758
| Name | Type | Description | Notes |
@@ -934,6 +934,17 @@
934934
#### AxisPosition (enum)
935935
`LEFT` | `RIGHT` | `TOP` | `BOTTOM`
936936

937+
#### SimpleValueSourceConfig
938+
| Name | Type | Description | Notes |
939+
|------|------|-------------|-------|
940+
| type | ValueSourceType | | [optional] |
941+
| value | Double | | [optional] |
942+
| latestKeyType | String | | [optional] |
943+
| latestKey | String | | [optional] |
944+
| entityKeyType | String | | [optional] |
945+
| entityAlias | String | | [optional] |
946+
| entityKey | String | | [optional] |
947+
937948
#### TimeSeriesChartNoAggregationBarWidthStrategy (enum)
938949
`GROUP` | `SEPARATE`
939950

‎pe/docs/CustomerControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Returns a page of customer info objects owned by the tenant or the customer of a
6262
|------------- | ------------- | ------------- | -------------|
6363
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
6464
| **page** | **Integer** | Sequence number of page starting from 0 | |
65-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
65+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
6666
| **textSearch** | **String** | The case insensitive 'substring' filter based on the customer title. | [optional] |
6767
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title, email, country, city] |
6868
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
@@ -116,7 +116,7 @@ Returns a page of customer info objects owned by the specified customer. You can
116116
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
117117
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
118118
| **page** | **Integer** | Sequence number of page starting from 0 | |
119-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
119+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
120120
| **textSearch** | **String** | The case insensitive 'substring' filter based on the customer title. | [optional] |
121121
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title, email, country, city] |
122122
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |

‎pe/docs/DashboardControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Returns a page of dashboard info objects owned by the tenant or the customer of
9696
|------------- | ------------- | ------------- | -------------|
9797
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
9898
| **page** | **Integer** | Sequence number of page starting from 0 | |
99-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
99+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
100100
| **textSearch** | **String** | The case insensitive 'substring' filter based on the dashboard title. | [optional] |
101101
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title] |
102102
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
@@ -126,7 +126,7 @@ Returns a page of dashboard info objects owned by the specified customer. The Da
126126
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
127127
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
128128
| **page** | **Integer** | Sequence number of page starting from 0 | |
129-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
129+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
130130
| **textSearch** | **String** | The case insensitive 'substring' filter based on the dashboard title. | [optional] |
131131
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title] |
132132
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |

‎pe/docs/DeviceControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Returns a page of device info objects owned by the tenant or the customer of a c
198198
|------------- | ------------- | ------------- | -------------|
199199
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
200200
| **page** | **Integer** | Sequence number of page starting from 0 | |
201-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
201+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
202202
| **deviceProfileId** | **String** | A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
203203
| **active** | **Boolean** | A boolean value representing the device active flag. | [optional] |
204204
| **textSearch** | **String** | The case insensitive 'substring' filter based on the device name. | [optional] |
@@ -230,7 +230,7 @@ Returns a page of device info objects owned by the specified customer. Device In
230230
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
231231
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
232232
| **page** | **Integer** | Sequence number of page starting from 0 | |
233-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
233+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
234234
| **deviceProfileId** | **String** | A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
235235
| **active** | **Boolean** | A boolean value representing the device active flag. | [optional] |
236236
| **textSearch** | **String** | The case insensitive 'substring' filter based on the device name. | [optional] |

‎pe/docs/EdgeControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Returns a page of edge info objects owned by the tenant or the customer of a cur
171171
|------------- | ------------- | ------------- | -------------|
172172
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
173173
| **page** | **Integer** | Sequence number of page starting from 0 | |
174-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
174+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
175175
| **type** | **String** | A string value representing the edge type. For example, 'default' | [optional] |
176176
| **textSearch** | **String** | The case insensitive 'substring' filter based on the edge name. | [optional] |
177177
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
@@ -202,7 +202,7 @@ Returns a page of edge info objects owned by the specified customer. You can spe
202202
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
203203
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
204204
| **page** | **Integer** | Sequence number of page starting from 0 | |
205-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
205+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
206206
| **type** | **String** | A string value representing the edge type. For example, 'default' | [optional] |
207207
| **textSearch** | **String** | The case insensitive 'substring' filter based on the edge name. | [optional] |
208208
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |

‎pe/docs/EntityViewControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Returns a page of entity view info objects owned by the tenant or the customer o
8787
|------------- | ------------- | ------------- | -------------|
8888
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
8989
| **page** | **Integer** | Sequence number of page starting from 0 | |
90-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
90+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
9191
| **type** | **String** | ## Entity View Filter Allows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT': ```json { \"type\": \"entityViewType\", \"entityViewType\": \"Concrete Mixer\", \"entityViewNameFilter\": \"CAT\" } ``` | [optional] |
9292
| **textSearch** | **String** | The case insensitive 'substring' filter based on the entity view name. | [optional] |
9393
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type] |
@@ -118,7 +118,7 @@ Returns a page of entity view info objects owned by the specified customer. Enti
118118
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
119119
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
120120
| **page** | **Integer** | Sequence number of page starting from 0 | |
121-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
121+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
122122
| **type** | **String** | ## Entity View Filter Allows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT': ```json { \"type\": \"entityViewType\", \"entityViewType\": \"Concrete Mixer\", \"entityViewNameFilter\": \"CAT\" } ``` | [optional] |
123123
| **textSearch** | **String** | The case insensitive 'substring' filter based on the entity view name. | [optional] |
124124
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type] |

‎pe/docs/HeaderFooter.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -484,8 +484,8 @@
484484
| decimals | Integer | | [optional] |
485485
| interval | Double | | [optional] |
486486
| splitNumber | Integer | | [optional] |
487-
| min | Double | | [optional] |
488-
| max | Double | | [optional] |
487+
| min | SimpleValueSourceConfig | | [optional] |
488+
| max | SimpleValueSourceConfig | | [optional] |
489489

490490
#### TimeSeriesChartXAxisSettings
491491
| Name | Type | Description | Notes |
@@ -631,6 +631,17 @@
631631
#### AxisPosition (enum)
632632
`LEFT` | `RIGHT` | `TOP` | `BOTTOM`
633633

634+
#### SimpleValueSourceConfig
635+
| Name | Type | Description | Notes |
636+
|------|------|-------------|-------|
637+
| type | ValueSourceType | | [optional] |
638+
| value | Double | | [optional] |
639+
| latestKeyType | String | | [optional] |
640+
| latestKey | String | | [optional] |
641+
| entityKeyType | String | | [optional] |
642+
| entityAlias | String | | [optional] |
643+
| entityKey | String | | [optional] |
644+
634645
#### TimeSeriesChartNoAggregationBarWidthStrategy (enum)
635646
`GROUP` | `SEPARATE`
636647

‎pe/docs/IntegrationControllerApi.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
Integration assignIntegrationToEdge(@Nonnull String edgeId, @Nonnull String integrationId) // Assign integration to edge (assignIntegrationToEdge)
77
void checkIntegrationConnection(@Nonnull Integration integration) // Check integration connectivity (checkIntegrationConnection)
88
void deleteIntegration(@Nonnull String integrationId) // Delete integration (deleteIntegration)
9+
byte[] exportIntegrationPackage(@Nonnull String integrationId) // Export integration as IoT Hub package
910
String findAllRelatedEdgesMissingAttributes(@Nonnull String integrationId) // Find missing attributes for all related edges (findAllRelatedEdgesMissingAttributes)
1011
String findEdgeMissingAttributes(@Nonnull String edgeId, @Nonnull List<String> integrationIds) // Find edge missing attributes for assigned integrations (findEdgeMissingAttributes)
1112
PageDataIntegrationInfo getEdgeIntegrationInfos(@Nonnull String edgeId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Edge Integrations (getEdgeIntegrationInfos)
@@ -94,6 +95,30 @@ Deletes the integration and all the relations (from and to the integration). Ref
9495
null (empty response body)
9596

9697

98+
## exportIntegrationPackage
99+
100+
```
101+
byte[] exportIntegrationPackage(@Nonnull String integrationId)
102+
```
103+
104+
**GET** `/api/integration/{integrationId}/export-package`
105+
106+
Export integration as IoT Hub package
107+
108+
Returns a ZIP containing integration.json, uplink.json, optional downlink.json, and form.json. Sensitive fields are tokenized via @TemplateField annotations on the integration's runtime POJO.
109+
110+
111+
### Parameters
112+
113+
| Name | Type | Description | Notes |
114+
|------------- | ------------- | ------------- | -------------|
115+
| **integrationId** | **String** | | |
116+
117+
### Return type
118+
119+
**byte[]**
120+
121+
97122
## findAllRelatedEdgesMissingAttributes
98123

99124
```

‎pe/docs/Job.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@
1010
| **id** | **JobId** | | [optional] |
1111
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | | |
13+
| **customerId** | **CustomerId** | | [optional] |
1314
| **type** | **JobType** | | |
1415
| **key** | **String** | | |
1516
| **entityId** | **EntityId** | | |
1617
| **entityName** | **String** | | [optional] |
1718
| **status** | **JobStatus** | | |
1819
| **_configuration** | **JobConfiguration** | | |
1920
| **result** | **JobResult** | | |
21+
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |
2022

2123

2224

0 commit comments

Comments
 (0)