ThingsboardClient methods:
None client.delete_alarm_comment(alarm_id: str, comment_id: str) # Delete Alarm comment (deleteAlarmComment)
PageDataAlarmCommentInfo client.get_alarm_comments(alarm_id: str, page_size: int, page: int, sort_property: Optional[str] = None, sort_order: Optional[str] = None) # Get Alarm comments (getAlarmComments)
AlarmComment client.save_alarm_comment(alarm_id: str, alarm_comment: AlarmComment) # Create or update Alarm Comment None client.delete_alarm_comment(alarm_id: str, comment_id: str)DELETE /api/alarm/{alarmId}/comment/{commentId}
Delete Alarm comment (deleteAlarmComment)
Deletes the Alarm comment. Referencing non-existing Alarm comment Id will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| alarm_id | str | A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| comment_id | str | A string value representing the alarm comment id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |
None (empty response body)
PageDataAlarmCommentInfo client.get_alarm_comments(alarm_id: str, page_size: int, page: int, sort_property: Optional[str] = None, sort_order: Optional[str] = None)GET /api/alarm/{alarmId}/comment
Get Alarm comments (getAlarmComments)
Returns a page of alarm comments for specified alarm. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| alarm_id | str | A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| page_size | int | Maximum amount of entities in a one page | |
| page | int | Sequence number of page starting from 0 | |
| sort_property | str | Property of entity to sort by | [optional] [enum: createdTime, id] |
| sort_order | str | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
PageDataAlarmCommentInfo
AlarmComment client.save_alarm_comment(alarm_id: str, alarm_comment: AlarmComment)POST /api/alarm/{alarmId}/comment
Create or update Alarm Comment
Creates or Updates the Alarm Comment. When creating comment, platform generates Alarm Comment Id as time-based UUID. The newly created Alarm Comment id will be present in the response. Specify existing Alarm Comment id to update the alarm. Referencing non-existing Alarm Comment Id will cause 'Not Found' error. To create new Alarm comment entity it is enough to specify 'comment' json element with 'text' node, for example: {"comment": { "text": "my comment"}}. If comment type is not specified the default value 'OTHER' will be saved. If 'alarmId' or 'userId' specified in body it will be ignored. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| alarm_id | str | A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| alarm_comment | AlarmComment | A JSON value representing the comment. |
AlarmComment