Skip to content

Update PE OpenAPI spec in master (from master) #66

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 1 commit into from
Jun 29, 2026
Merged

Update PE OpenAPI spec in master (from master) #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions pe/docs/AssetControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Returns a page of asset info objects owned by the tenant or the customer of a cu
|------------- | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **assetProfileId** | **String** | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the asset name. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
Expand Down Expand Up @@ -237,7 +237,7 @@ Returns a page of asset info objects owned by the specified customer. Asset Info
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **assetProfileId** | **String** | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the asset name. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
Expand Down
15 changes: 13 additions & 2 deletions pe/docs/CsvReportTemplateConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,8 +751,8 @@
| decimals | Integer | | [optional] |
| interval | Double | | [optional] |
| splitNumber | Integer | | [optional] |
| min | Double | | [optional] |
| max | Double | | [optional] |
| min | SimpleValueSourceConfig | | [optional] |
| max | SimpleValueSourceConfig | | [optional] |

#### TimeSeriesChartXAxisSettings
| Name | Type | Description | Notes |
Expand Down Expand Up @@ -934,6 +934,17 @@
#### AxisPosition (enum)
`LEFT` | `RIGHT` | `TOP` | `BOTTOM`

#### SimpleValueSourceConfig
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| type | ValueSourceType | | [optional] |
| value | Double | | [optional] |
| latestKeyType | String | | [optional] |
| latestKey | String | | [optional] |
| entityKeyType | String | | [optional] |
| entityAlias | String | | [optional] |
| entityKey | String | | [optional] |

#### TimeSeriesChartNoAggregationBarWidthStrategy (enum)
`GROUP` | `SEPARATE`

Expand Down
4 changes: 2 additions & 2 deletions pe/docs/CustomerControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Returns a page of customer info objects owned by the tenant or the customer of a
|------------- | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the customer title. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title, email, country, city] |
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
Expand Down Expand Up @@ -116,7 +116,7 @@ Returns a page of customer info objects owned by the specified customer. You can
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the customer title. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title, email, country, city] |
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/DashboardControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Returns a page of dashboard info objects owned by the tenant or the customer of
|------------- | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the dashboard title. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title] |
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
Expand Down Expand Up @@ -126,7 +126,7 @@ Returns a page of dashboard info objects owned by the specified customer. The Da
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the dashboard title. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, title] |
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/DeviceControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Returns a page of device info objects owned by the tenant or the customer of a c
|------------- | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **deviceProfileId** | **String** | A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
| **active** | **Boolean** | A boolean value representing the device active flag. | [optional] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the device name. | [optional] |
Expand Down Expand Up @@ -230,7 +230,7 @@ Returns a page of device info objects owned by the specified customer. Device In
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **deviceProfileId** | **String** | A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
| **active** | **Boolean** | A boolean value representing the device active flag. | [optional] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the device name. | [optional] |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/EdgeControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Returns a page of edge info objects owned by the tenant or the customer of a cur
|------------- | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **type** | **String** | A string value representing the edge type. For example, 'default' | [optional] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the edge name. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
Expand Down Expand Up @@ -202,7 +202,7 @@ Returns a page of edge info objects owned by the specified customer. You can spe
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **type** | **String** | A string value representing the edge type. For example, 'default' | [optional] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the edge name. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/EntityViewControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Returns a page of entity view info objects owned by the tenant or the customer o
|------------- | ------------- | ------------- | -------------|
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **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] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the entity view name. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type] |
Expand Down Expand Up @@ -118,7 +118,7 @@ Returns a page of entity view info objects owned by the specified customer. Enti
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
| **page** | **Integer** | Sequence number of page starting from 0 | |
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
| **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] |
| **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] |
| **textSearch** | **String** | The case insensitive 'substring' filter based on the entity view name. | [optional] |
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type] |
Expand Down
15 changes: 13 additions & 2 deletions pe/docs/HeaderFooter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,8 +484,8 @@
| decimals | Integer | | [optional] |
| interval | Double | | [optional] |
| splitNumber | Integer | | [optional] |
| min | Double | | [optional] |
| max | Double | | [optional] |
| min | SimpleValueSourceConfig | | [optional] |
| max | SimpleValueSourceConfig | | [optional] |

#### TimeSeriesChartXAxisSettings
| Name | Type | Description | Notes |
Expand Down Expand Up @@ -631,6 +631,17 @@
#### AxisPosition (enum)
`LEFT` | `RIGHT` | `TOP` | `BOTTOM`

#### SimpleValueSourceConfig
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| type | ValueSourceType | | [optional] |
| value | Double | | [optional] |
| latestKeyType | String | | [optional] |
| latestKey | String | | [optional] |
| entityKeyType | String | | [optional] |
| entityAlias | String | | [optional] |
| entityKey | String | | [optional] |

#### TimeSeriesChartNoAggregationBarWidthStrategy (enum)
`GROUP` | `SEPARATE`

Expand Down
25 changes: 25 additions & 0 deletions pe/docs/IntegrationControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
Integration assignIntegrationToEdge(@Nonnull String edgeId, @Nonnull String integrationId) // Assign integration to edge (assignIntegrationToEdge)
void checkIntegrationConnection(@Nonnull Integration integration) // Check integration connectivity (checkIntegrationConnection)
void deleteIntegration(@Nonnull String integrationId) // Delete integration (deleteIntegration)
byte[] exportIntegrationPackage(@Nonnull String integrationId) // Export integration as IoT Hub package
String findAllRelatedEdgesMissingAttributes(@Nonnull String integrationId) // Find missing attributes for all related edges (findAllRelatedEdgesMissingAttributes)
String findEdgeMissingAttributes(@Nonnull String edgeId, @Nonnull List<String> integrationIds) // Find edge missing attributes for assigned integrations (findEdgeMissingAttributes)
PageDataIntegrationInfo getEdgeIntegrationInfos(@Nonnull String edgeId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Edge Integrations (getEdgeIntegrationInfos)
Expand Down Expand Up @@ -94,6 +95,30 @@ Deletes the integration and all the relations (from and to the integration). Ref
null (empty response body)


## exportIntegrationPackage

```
byte[] exportIntegrationPackage(@Nonnull String integrationId)
```

**GET** `/api/integration/{integrationId}/export-package`

Export integration as IoT Hub package

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.


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **integrationId** | **String** | | |

### Return type

**byte[]**


## findAllRelatedEdgesMissingAttributes

```
Expand Down
2 changes: 2 additions & 0 deletions pe/docs/Job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@
| **id** | **JobId** | | [optional] |
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
| **tenantId** | **TenantId** | | |
| **customerId** | **CustomerId** | | [optional] |
| **type** | **JobType** | | |
| **key** | **String** | | |
| **entityId** | **EntityId** | | |
| **entityName** | **String** | | [optional] |
| **status** | **JobStatus** | | |
| **_configuration** | **JobConfiguration** | | |
| **result** | **JobResult** | | |
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |



Expand Down
Loading
Loading