Skip to content

Commit 1b383aa

Browse files
Update PE OpenAPI spec in master (from master)
1 parent 2bdea18 commit 1b383aa

74 files changed

Lines changed: 362 additions & 188 deletions

File tree

Some content is hidden

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

‎pe/docs/Alarm.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
1111
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
13-
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
13+
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
1414
| **type** | **String** | representing type of the Alarm | |
1515
| **originator** | **EntityId** | JSON object with alarm originator id | |
1616
| **severity** | **AlarmSeverity** | Alarm severity | |

‎pe/docs/AlarmData.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
1111
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
13-
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
13+
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
1414
| **type** | **String** | representing type of the Alarm | |
1515
| **originator** | **EntityId** | JSON object with alarm originator id | |
1616
| **severity** | **AlarmSeverity** | Alarm severity | |

‎pe/docs/AlarmInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
1111
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
13-
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
13+
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
1414
| **type** | **String** | representing type of the Alarm | |
1515
| **originator** | **EntityId** | JSON object with alarm originator id | |
1616
| **severity** | **AlarmSeverity** | Alarm severity | |

‎pe/docs/Asset.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| **createdTime** | **Long** | Timestamp of the asset creation, in milliseconds | [optional] [readonly] |
1212
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
14-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
1515
| **name** | **String** | Unique Asset Name in scope of Tenant | |
1616
| **type** | **String** | Asset type | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |

‎pe/docs/AssetInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| **createdTime** | **Long** | Timestamp of the asset creation, in milliseconds | [optional] [readonly] |
1212
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
14-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
1515
| **name** | **String** | Unique Asset Name in scope of Tenant | |
1616
| **type** | **String** | Asset type | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |

‎pe/docs/AvailableEntityKeys.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat
1010
| Name | Type | Description | Notes |
1111
|------------ | ------------- | ------------- | -------------|
1212
| **entityTypes** | **Set\<EntityType\>** | Set of entity types found among the matched entities. | |
13-
| **timeseries** | **Set\<String\>** | | |
14-
| **attribute** | **Set\<String\>** | | |
13+
| **timeseries** | **Set\<String\>** | List of unique time series key names available on the matched entities. | |
14+
| **attribute** | **Set\<String\>** | List of unique attribute key names available on the matched entities. | |
1515

1616

1717

‎pe/docs/AvailableEntityKeysV2.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Contains unique time series and attribute key names discovered from entities mat
1111
|------------ | ------------- | ------------- | -------------|
1212
| **totalEntities** | **Integer** | Total number of entities that matched the query filter. | |
1313
| **entityTypes** | **Set\<EntityType\>** | Set of entity types found among the matched entities. | |
14-
| **timeseries** | **List\<KeyInfo\>** | | [optional] |
14+
| **timeseries** | **List\<KeyInfo\>** | List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. | [optional] |
1515
| **attributes** | **Map\<String, List<KeyInfo>\>** | Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types. | [optional] |
1616

1717

‎pe/docs/Device.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| **createdTime** | **Long** | Timestamp of the device creation, in milliseconds | [optional] [readonly] |
1212
| **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] |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
14-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignDeviceToCustomer' to change the Customer Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Device. | [optional] |
1515
| **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
1616
| **type** | **String** | Device Profile Name | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |

‎pe/docs/DeviceInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| **createdTime** | **Long** | Timestamp of the device creation, in milliseconds | [optional] [readonly] |
1212
| **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] |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
14-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignDeviceToCustomer' to change the Customer Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Device. | [optional] |
1515
| **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
1616
| **type** | **String** | Device Profile Name | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |

‎pe/docs/Edge.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ A JSON value representing the edge.
1212
| **id** | **EdgeId** | JSON object with the Edge Id. Specify this field to update the Edge. Referencing non-existing Edge Id will cause error. Omit this field to create new Edge. | [optional] |
1313
| **createdTime** | **Long** | Timestamp of the edge creation, in milliseconds | [optional] [readonly] |
1414
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the edge. May include: 'description' (string). | [optional] |
15-
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id. | [optional] [readonly] |
16-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignEdgeToCustomer' to change the Customer Id. | [optional] [readonly] |
15+
| **tenantId** | **TenantId** | JSON object with Tenant Id. Always set to the tenant of the current user on save; cannot be changed after creation. | [optional] [readonly] |
16+
| **customerId** | **CustomerId** | JSON object with Customer Id. | [optional] |
1717
| **rootRuleChainId** | **RuleChainId** | JSON object with Root Rule Chain Id. Use 'setEdgeRootRuleChain' to change the Root Rule Chain Id. | [optional] [readonly] |
1818
| **name** | **String** | Unique Edge Name in scope of Tenant | |
1919
| **type** | **String** | Edge type | |

0 commit comments

Comments
 (0)