{ "info": { "_postman_id": "60d1cbe5-37e2-4534-bb63-86e289ee3ebc", "name": "ThingsBoard Admin admin-controller alarm-comment-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-60d1cbe5-37e2-4534-bb63-86e289ee3ebc" }, "item": [ { "name": "api", "item": [ { "name": "alarm", "item": [ { "name": "{alarmId}", "item": [ { "name": "comment", "item": [ { "name": "{commentId}", "item": [ { "name": "Delete Alarm Comment (deleteAlarmComment)", "id": "9a24c2cd-d912-4330-becb-9dc180d81713", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/alarm/:alarmId/comment/:commentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "alarm", ":alarmId", "comment", ":commentId" ], "variable": [ { "id": "eb44d569-5377-4120-ab84-774b9aba2e5b", "key": "alarmId", "value": "", "description": "(Required) A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "5fb7031e-d7b4-4c43-a8bf-81f90a513c9f", "key": "commentId", "value": "", "description": "(Required) A string value representing the alarm comment id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Deletes the Alarm comment. Referencing non-existing Alarm comment Id will cause an error.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "a00ad95e-87aa-4ece-812c-18a178c229d2", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/alarm/:alarmId/comment/:commentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "alarm", ":alarmId", "comment", ":commentId" ], "variable": [ { "key": "alarmId" }, { "key": "commentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-a00ad95e-87aa-4ece-812c-18a178c229d2" } ], "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-9a24c2cd-d912-4330-becb-9dc180d81713" } ], "id": "9e2f83b2-94c3-49c5-bf5d-1b42aa8d2f4b", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-9e2f83b2-94c3-49c5-bf5d-1b42aa8d2f4b" }, { "name": "Get Alarm Comments (getAlarmComments)", "id": "d0554398-029a-40e2-99fe-95fa957b04b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/alarm/:alarmId/comment?pageSize=&page=&sortProperty=createdTime&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "alarm", ":alarmId", "comment" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "createdTime" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "id": "41dcc5eb-f321-4d94-8ded-66bd2ac95e37", "key": "alarmId", "value": "", "description": "(Required) A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "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. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "b7ac0101-c1cc-4d89-afaa-931b14750a1e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/alarm/:alarmId/comment?pageSize=&page=&sortProperty=createdTime&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "alarm", ":alarmId", "comment" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "createdTime" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "key": "alarmId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"alarmId\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"userId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"OTHER\",\n \"comment\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"alarmId\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"userId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"OTHER\",\n \"comment\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"name\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-b7ac0101-c1cc-4d89-afaa-931b14750a1e" } ], "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-d0554398-029a-40e2-99fe-95fa957b04b3" }, { "name": "Create or Update Alarm Comment", "id": "0b43460d-9e92-402a-9514-bd708741de4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"alarmId\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"userId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"SYSTEM\",\n \"comment\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/alarm/:alarmId/comment", "host": [ "{{baseUrl}}" ], "path": [ "api", "alarm", ":alarmId", "comment" ], "variable": [ { "id": "95dfdb65-a391-483f-99e6-d1d032c2541e", "key": "alarmId", "value": "", "description": "(Required) A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Creates or Updates the Alarm Comment. When creating comment, platform generates Alarm Comment Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). 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. \n\n To create new Alarm comment entity it is enough to specify 'comment' json element with 'text' node, for example: {\"comment\": { \"text\": \"my comment\"}}. \n\n If comment type is not specified the default value 'OTHER' will be saved. If 'alarmId' or 'userId' specified in body it will be ignored.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "01640bf2-b424-45d4-8d94-25b004b1870b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"alarmId\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"userId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"SYSTEM\",\n \"comment\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/alarm/:alarmId/comment", "host": [ "{{baseUrl}}" ], "path": [ "api", "alarm", ":alarmId", "comment" ], "variable": [ { "key": "alarmId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"alarmId\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"userId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"SYSTEM\",\n \"comment\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"name\": \"\"\n}", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-01640bf2-b424-45d4-8d94-25b004b1870b" } ], "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-0b43460d-9e92-402a-9514-bd708741de4f" } ], "id": "9131cfb2-bf08-43a7-b79c-78d129e08a51", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-9131cfb2-bf08-43a7-b79c-78d129e08a51" } ], "id": "1ec6efc7-2ea3-4d5b-b822-322a27b4111e", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-1ec6efc7-2ea3-4d5b-b822-322a27b4111e" } ], "id": "a38271d7-6cad-4035-9c0c-96ebd4fe2e28", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-a38271d7-6cad-4035-9c0c-96ebd4fe2e28" } ], "id": "77ffc877-53b4-4818-9257-3903065fd270", "createdAt": "2026-07-28T03:11:56.000Z", "updatedAt": "2026-07-28T03:11:56.000Z", "uid": "35240-77ffc877-53b4-4818-9257-3903065fd270" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }