Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

alarm-comment-controller

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.

get/api/alarm/{alarmId}/comment

Path parameters

alarmIdstring required

A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

sortProperty'createdTime' | 'id'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

Response

OK

totalPagesinteger

Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria

totalElementsinteger

Total number of elements in all available pages

hasNextboolean

'false' value indicates the end of the result set

Example response

{
  "data": [
    {
      "id": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9"
      },
      "createdTime": 1634058704567,
      "alarmId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "ALARM"
      },
      "userId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "USER"
      },
      "type": "SYSTEM/OTHER",
      "comment": {},
      "firstName": "John",
      "lastName": "Brown",
      "email": "johnBrown@gmail.com",
      "name": "Please take a look"
    }
  ]
}