You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4bbde17
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: paas/docs/Alarm.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
|**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]|
11
11
|**createdTime**|**Long**| Timestamp of the alarm creation, in milliseconds |[optional][readonly]|
12
12
|**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]|
14
14
|**type**|**String**| representing type of the Alarm ||
15
15
|**originator**|**EntityId**| JSON object with alarm originator id ||
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).
373
+
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).
Copy file name to clipboardExpand all lines: paas/docs/AlarmData.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
|**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]|
11
11
|**createdTime**|**Long**| Timestamp of the alarm creation, in milliseconds |[optional][readonly]|
12
12
|**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]|
14
14
|**type**|**String**| representing type of the Alarm ||
15
15
|**originator**|**EntityId**| JSON object with alarm originator id ||
Copy file name to clipboardExpand all lines: paas/docs/AlarmInfo.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
|**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]|
11
11
|**createdTime**|**Long**| Timestamp of the alarm creation, in milliseconds |[optional][readonly]|
12
12
|**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]|
14
14
|**type**|**String**| representing type of the Alarm ||
15
15
|**originator**|**EntityId**| JSON object with alarm originator id ||
Copy file name to clipboardExpand all lines: paas/docs/Asset.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
|**createdTime**|**Long**| Timestamp of the asset creation, in milliseconds |[optional][readonly]|
12
12
|**additionalInfo**|**com.fasterxml.jackson.databind.JsonNode**| Additional parameters of the asset. May include: 'description' (string). |[optional]|
13
13
|**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]|
15
15
|**name**|**String**| Unique Asset Name in scope of Tenant ||
16
16
|**type**|**String**| Asset type |[optional]|
17
17
|**label**|**String**| Label that may be used in widgets |[optional]|
|**pageSize**|**Integer**| Maximum amount of entities in a one page ||
90
90
|**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]|
92
92
|**assetProfileId**|**String**| A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |[optional]|
93
93
|**textSearch**|**String**| The case insensitive 'substring' filter based on the asset name. |[optional]|
94
94
|**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
237
237
|**customerId**|**String**| A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' ||
238
238
|**pageSize**|**Integer**| Maximum amount of entities in a one page ||
239
239
|**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]|
241
241
|**assetProfileId**|**String**| A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |[optional]|
242
242
|**textSearch**|**String**| The case insensitive 'substring' filter based on the asset name. |[optional]|
243
243
|**sortProperty**|**String**| Property of entity to sort by |[optional][enum: createdTime, name, type, label, customerTitle]|
Copy file name to clipboardExpand all lines: paas/docs/AssetInfo.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
|**createdTime**|**Long**| Timestamp of the asset creation, in milliseconds |[optional][readonly]|
12
12
|**additionalInfo**|**com.fasterxml.jackson.databind.JsonNode**| Additional parameters of the asset. May include: 'description' (string). |[optional]|
13
13
|**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]|
15
15
|**name**|**String**| Unique Asset Name in scope of Tenant ||
16
16
|**type**|**String**| Asset type |[optional]|
17
17
|**label**|**String**| Label that may be used in widgets |[optional]|
0 commit comments