{ "info": { "_postman_id": "30380a33-a2a3-4289-af8c-22b37f0f0fb6", "name": "ThingsBoard Admin admin-controller telemetry-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:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-30380a33-a2a3-4289-af8c-22b37f0f0fb6" }, "item": [ { "name": "api", "item": [ { "name": "plugins", "item": [ { "name": "telemetry", "item": [ { "name": "{entityType}", "item": [ { "name": "{entityId}", "item": [ { "name": "{scope}", "item": [ { "name": "Save Entity Attributes (saveEntityAttributesV1)", "id": "3a1cb08a-4137-4a42-acfb-83fe1c89571a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "variable": [ { "id": "bd36f317-8531-4194-8709-5e8cadcff97e", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "1b7bb3dc-c3bb-4a03-b59a-a4cfa51f9994", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "4656fb7b-ce03-44b5-a767-fbb877c70dc5", "key": "scope", "value": "SERVER_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Creates or updates the entity attributes based on Entity Id and the specified attribute scope. List of possible attribute scopes depends on the entity type: \n\n * SERVER_SCOPE - supported for all entity types;\n * SHARED_SCOPE - supported for devices.\n\nThe request payload is a JSON object with key-value format of attributes to create or update. For example:\n\n```json\n{\n \"stringKey\":\"value1\", \n \"booleanKey\":true, \n \"doubleKey\":42.0, \n \"longKey\":73, \n \"jsonKey\": {\n \"someNumber\": 42,\n \"someArray\": [1,2,3],\n \"someNestedObject\": {\"key\": \"value\"}\n }\n}\n```\nReferencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "2e10663e-7a39-4df9-823b-479c57c0e7fc", "name": "Attribute from the request was created or updated. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED', and also sends event msg to the rule engine with msg type 'ATTRIBUTES_UPDATED'.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-2e10663e-7a39-4df9-823b-479c57c0e7fc" }, { "id": "18f77e0a-dd0f-44b7-9e6c-cb00323215b8", "name": "Invalid structure of the request or invalid attributes scope provided.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-18f77e0a-dd0f-44b7-9e6c-cb00323215b8" }, { "id": "88694bb2-83a1-437c-8605-96917f49329a", "name": "User is not authorized to save entity attributes for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-88694bb2-83a1-437c-8605-96917f49329a" }, { "id": "dc8e20e0-09c9-4253-ac42-4e379b3bc721", "name": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-dc8e20e0-09c9-4253-ac42-4e379b3bc721" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-3a1cb08a-4137-4a42-acfb-83fe1c89571a" }, { "name": "Delete Entity Attributes (deleteEntityAttributes)", "id": "a845b1f1-cbe8-4cb3-b361-be65d9366391", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "id": "1045fd53-8d69-45aa-bb02-669b8bf032b6", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "d4f03a13-316f-489a-8aa1-cc038f3e71c3", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "5db3b008-4ab9-4c04-ba9c-94fffbb7d085", "key": "scope", "value": "SHARED_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Delete entity attributes using provided Entity Id, scope and a list of keys. Referencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "8f6ed955-a176-42be-9504-0c4357fdcbd9", "name": "Entity attributes was removed for the selected keys in the request. Platform creates an audit log event about entity attributes removal with action type 'ATTRIBUTES_DELETED'.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-8f6ed955-a176-42be-9504-0c4357fdcbd9" }, { "id": "a174df21-b2fa-4d63-9fd1-de6598ad8212", "name": "Platform returns a bad request in case if keys or scope are not specified.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-a174df21-b2fa-4d63-9fd1-de6598ad8212" }, { "id": "87700d4a-4f5a-41d4-8ce8-db595eb30932", "name": "User is not authorized to delete entity attributes for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-87700d4a-4f5a-41d4-8ce8-db595eb30932" }, { "id": "afbc94fe-e881-4655-9de3-e9dfbd5762ec", "name": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-afbc94fe-e881-4655-9de3-e9dfbd5762ec" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-a845b1f1-cbe8-4cb3-b361-be65d9366391" } ], "id": "addc032e-4e9c-4759-886a-67852fec1192", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-addc032e-4e9c-4759-886a-67852fec1192" }, { "name": "timeseries", "item": [ { "name": "{scope}", "item": [ { "name": "{ttl}", "item": [ { "name": "Save or Update Time Series Data with TTL (saveEntityTelemetryWithTTL)", "id": "d4d4d452-f5bf-4bc5-b2d9-80f58128c056", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope/:ttl", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope", ":ttl" ], "variable": [ { "id": "7c5cf5ce-f0f6-4daa-bfc5-49371359284a", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "4931aadd-974e-4331-b7ac-a046a66851de", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "beca4d6c-3991-45e8-a19a-3e830a56ea28", "key": "scope", "value": "ANY", "description": "(Required) Value is deprecated, reserved for backward compatibility and not used in the API call implementation. Specify any scope for compatibility" }, { "id": "f1274010-b449-4fe3-aa81-a2166cccf0e6", "key": "ttl", "value": "", "description": "(Required) A long value representing TTL (Time to Live) parameter." } ] }, "description": "Creates or updates the entity time series data based on the Entity Id and request payload.The request payload is a JSON document with three possible formats:\n\nSimple format without timestamp. In such a case, current server time will be used: \n\n```json\n{\"temperature\": 26}\n```\n\n Single JSON object with timestamp: \n\n```json\n{\"ts\":1634712287000,\"values\":{\"temperature\":26, \"humidity\":87}}\n```\n\n JSON array with timestamps: \n\n```json\n[{\"ts\":1634712287000,\"values\":{\"temperature\":26, \"humidity\":87}}, {\"ts\":1634712588000,\"values\":{\"temperature\":25, \"humidity\":88}}]\n```\n\n The scope parameter is not used in the API call implementation but should be specified whatever value because it is used as a path variable. \n\nThe ttl parameter takes affect only in case of Cassandra DB.Referencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "dd69eb2d-7732-4efd-88ad-dcf733d50a2a", "name": "Time series from the request was created or updated. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED'.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope/:ttl", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope", ":ttl" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" }, { "key": "ttl" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-dd69eb2d-7732-4efd-88ad-dcf733d50a2a" }, { "id": "4188ba97-fd7c-4b0c-b849-4c254fa7ec1e", "name": "Invalid structure of the request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope/:ttl", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope", ":ttl" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" }, { "key": "ttl" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-4188ba97-fd7c-4b0c-b849-4c254fa7ec1e" }, { "id": "8796178e-aeba-4fe6-96b3-b3297fba258f", "name": "User is not authorized to save entity time series for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope/:ttl", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope", ":ttl" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" }, { "key": "ttl" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-8796178e-aeba-4fe6-96b3-b3297fba258f" }, { "id": "519355e8-9ef6-46af-a997-6e773f33a1fa", "name": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope/:ttl", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope", ":ttl" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" }, { "key": "ttl" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-519355e8-9ef6-46af-a997-6e773f33a1fa" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-d4d4d452-f5bf-4bc5-b2d9-80f58128c056" } ], "id": "d39df82e-cf4e-4356-814c-1bc2c3e5c658", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-d39df82e-cf4e-4356-814c-1bc2c3e5c658" }, { "name": "Save or Update Time Series Data (saveEntityTelemetry)", "id": "74adbb90-e869-425c-8b1a-73189df76381", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope" ], "variable": [ { "id": "d4df5f3c-004c-4040-8e9f-208547ecbfe8", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "0a6e93f5-afdc-45f0-a10a-00dfa74b984b", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "374d378b-6d0f-4b4e-90e3-3439d6058671", "key": "scope", "value": "ANY", "description": "(Required) Value is deprecated, reserved for backward compatibility and not used in the API call implementation. Specify any scope for compatibility" } ] }, "description": "Creates or updates the entity time series data based on the Entity Id and request payload.The request payload is a JSON document with three possible formats:\n\nSimple format without timestamp. In such a case, current server time will be used: \n\n```json\n{\"temperature\": 26}\n```\n\n Single JSON object with timestamp: \n\n```json\n{\"ts\":1634712287000,\"values\":{\"temperature\":26, \"humidity\":87}}\n```\n\n JSON array with timestamps: \n\n```json\n[{\"ts\":1634712287000,\"values\":{\"temperature\":26, \"humidity\":87}}, {\"ts\":1634712588000,\"values\":{\"temperature\":25, \"humidity\":88}}]\n```\n\n The scope parameter is not used in the API call implementation but should be specified whatever value because it is used as a path variable. Referencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "8c08b767-eaca-4e1a-828c-83fb45cbbc1f", "name": "Time series from the request was created or updated. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED'.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-8c08b767-eaca-4e1a-828c-83fb45cbbc1f" }, { "id": "46b481c9-a17e-4b0e-b62a-170f7d842338", "name": "Invalid structure of the request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-46b481c9-a17e-4b0e-b62a-170f7d842338" }, { "id": "a7239023-2e0a-4a6a-8c00-9446f4787f3d", "name": "User is not authorized to save entity time series for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-a7239023-2e0a-4a6a-8c00-9446f4787f3d" }, { "id": "03a09f6b-746b-4056-aed6-149f8c546e26", "name": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-03a09f6b-746b-4056-aed6-149f8c546e26" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-74adbb90-e869-425c-8b1a-73189df76381" } ], "id": "6864c2c1-4d88-4dee-b8cc-7781a8a16def", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-6864c2c1-4d88-4dee-b8cc-7781a8a16def" }, { "name": "delete", "item": [ { "name": "Delete Entity Time Series Data (deleteEntityTimeseries)", "id": "e1a68f71-b282-4e1d-8c0a-b0ff4faf85c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/delete?keys=&deleteAllDataForKeys=false&startTs=&endTs=&deleteLatest=true&rewriteLatestIfDeleted=false&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", "delete" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "A boolean value to specify if should be deleted all data for selected keys or only data that are in the selected time range.", "key": "deleteAllDataForKeys", "value": "false" }, { "description": "A long value representing the start timestamp of removal time range in milliseconds.", "key": "startTs", "value": "" }, { "description": "A long value representing the end timestamp of removal time range in milliseconds.", "key": "endTs", "value": "" }, { "description": "If the parameter is set to true, the latest telemetry can be removed, otherwise, in case that parameter is set to false the latest value will not removed.", "key": "deleteLatest", "value": "true" }, { "description": "If the parameter is set to true, the latest telemetry will be rewritten in case that current latest value was removed, otherwise, in case that parameter is set to false the new latest value will not set.", "key": "rewriteLatestIfDeleted", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "id": "5aabb5fa-c85d-470b-9585-2e458fae8c47", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "7693055c-d7c1-4951-bd1c-48ad692d8f79", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Delete time series for selected entity based on entity id, entity type and keys. Use 'deleteAllDataForKeys' to delete all time series data. Use 'startTs' and 'endTs' to specify time-range instead. Use 'deleteLatest' to delete latest value (stored in separate table for performance) if the value's timestamp matches the time-range. Use 'rewriteLatestIfDeleted' to rewrite latest value (stored in separate table for performance) if the value's timestamp matches the time-range and 'deleteLatest' param is true. The replacement value will be fetched from the 'time series' table, and its timestamp will be the most recent one before the defined time-range. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "fd07f1f8-4816-4065-8856-b208f6e4ba5c", "name": "Time series for the selected keys in the request was removed. Platform creates an audit log event about entity time series removal with action type 'TIMESERIES_DELETED'.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/delete?keys=&deleteAllDataForKeys=false&startTs=&endTs=&deleteLatest=true&rewriteLatestIfDeleted=false&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", "delete" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "A boolean value to specify if should be deleted all data for selected keys or only data that are in the selected time range.", "key": "deleteAllDataForKeys", "value": "false" }, { "description": "A long value representing the start timestamp of removal time range in milliseconds.", "key": "startTs", "value": "" }, { "description": "A long value representing the end timestamp of removal time range in milliseconds.", "key": "endTs", "value": "" }, { "description": "If the parameter is set to true, the latest telemetry can be removed, otherwise, in case that parameter is set to false the latest value will not removed.", "key": "deleteLatest", "value": "true" }, { "description": "If the parameter is set to true, the latest telemetry will be rewritten in case that current latest value was removed, otherwise, in case that parameter is set to false the new latest value will not set.", "key": "rewriteLatestIfDeleted", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-fd07f1f8-4816-4065-8856-b208f6e4ba5c" }, { "id": "0badd882-aa7b-46a3-b766-cc64f1aaa059", "name": "Platform returns a bad request in case if keys list is empty or start and end timestamp values is empty when deleteAllDataForKeys is set to false.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/delete?keys=&deleteAllDataForKeys=false&startTs=&endTs=&deleteLatest=true&rewriteLatestIfDeleted=false&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", "delete" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "A boolean value to specify if should be deleted all data for selected keys or only data that are in the selected time range.", "key": "deleteAllDataForKeys", "value": "false" }, { "description": "A long value representing the start timestamp of removal time range in milliseconds.", "key": "startTs", "value": "" }, { "description": "A long value representing the end timestamp of removal time range in milliseconds.", "key": "endTs", "value": "" }, { "description": "If the parameter is set to true, the latest telemetry can be removed, otherwise, in case that parameter is set to false the latest value will not removed.", "key": "deleteLatest", "value": "true" }, { "description": "If the parameter is set to true, the latest telemetry will be rewritten in case that current latest value was removed, otherwise, in case that parameter is set to false the new latest value will not set.", "key": "rewriteLatestIfDeleted", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-0badd882-aa7b-46a3-b766-cc64f1aaa059" }, { "id": "afffb1e3-0667-418e-ba2c-7914093f13ba", "name": "User is not authorized to delete entity time series for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/delete?keys=&deleteAllDataForKeys=false&startTs=&endTs=&deleteLatest=true&rewriteLatestIfDeleted=false&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", "delete" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "A boolean value to specify if should be deleted all data for selected keys or only data that are in the selected time range.", "key": "deleteAllDataForKeys", "value": "false" }, { "description": "A long value representing the start timestamp of removal time range in milliseconds.", "key": "startTs", "value": "" }, { "description": "A long value representing the end timestamp of removal time range in milliseconds.", "key": "endTs", "value": "" }, { "description": "If the parameter is set to true, the latest telemetry can be removed, otherwise, in case that parameter is set to false the latest value will not removed.", "key": "deleteLatest", "value": "true" }, { "description": "If the parameter is set to true, the latest telemetry will be rewritten in case that current latest value was removed, otherwise, in case that parameter is set to false the new latest value will not set.", "key": "rewriteLatestIfDeleted", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-afffb1e3-0667-418e-ba2c-7914093f13ba" }, { "id": "4c08cfa1-6080-43aa-b269-e5f240cf2085", "name": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series removal with action type 'TIMESERIES_DELETED' that includes an error stacktrace.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/timeseries/delete?keys=&deleteAllDataForKeys=false&startTs=&endTs=&deleteLatest=true&rewriteLatestIfDeleted=false&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "timeseries", "delete" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "A boolean value to specify if should be deleted all data for selected keys or only data that are in the selected time range.", "key": "deleteAllDataForKeys", "value": "false" }, { "description": "A long value representing the start timestamp of removal time range in milliseconds.", "key": "startTs", "value": "" }, { "description": "A long value representing the end timestamp of removal time range in milliseconds.", "key": "endTs", "value": "" }, { "description": "If the parameter is set to true, the latest telemetry can be removed, otherwise, in case that parameter is set to false the latest value will not removed.", "key": "deleteLatest", "value": "true" }, { "description": "If the parameter is set to true, the latest telemetry will be rewritten in case that current latest value was removed, otherwise, in case that parameter is set to false the new latest value will not set.", "key": "rewriteLatestIfDeleted", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-4c08cfa1-6080-43aa-b269-e5f240cf2085" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-e1a68f71-b282-4e1d-8c0a-b0ff4faf85c4" } ], "id": "71a229c8-91f7-4114-9842-57479545839f", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-71a229c8-91f7-4114-9842-57479545839f" } ], "id": "c93a36eb-6347-41c7-a0b2-99e42774a4f7", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-c93a36eb-6347-41c7-a0b2-99e42774a4f7" }, { "name": "attributes", "item": [ { "name": "{scope}", "item": [ { "name": "Save Entity Attributes (saveEntityAttributesV2)", "id": "2408f569-e168-47ad-8273-88f593ccac28", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "attributes", ":scope" ], "variable": [ { "id": "8384ba1b-f5a5-4c16-b7ec-546e7918fe73", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "11744b43-f8bf-41cd-aecc-d49ae52dc479", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "3b9593bc-18e3-4cde-ac4e-4f77db430fd3", "key": "scope", "value": "SERVER_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Creates or updates the entity attributes based on Entity Id and the specified attribute scope. List of possible attribute scopes depends on the entity type: \n\n * SERVER_SCOPE - supported for all entity types;\n * SHARED_SCOPE - supported for devices.\n\nThe request payload is a JSON object with key-value format of attributes to create or update. For example:\n\n```json\n{\n \"stringKey\":\"value1\", \n \"booleanKey\":true, \n \"doubleKey\":42.0, \n \"longKey\":73, \n \"jsonKey\": {\n \"someNumber\": 42,\n \"someArray\": [1,2,3],\n \"someNestedObject\": {\"key\": \"value\"}\n }\n}\n```\nReferencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "fd3666ce-689a-4b27-a45e-05990bf94a08", "name": "Attribute from the request was created or updated. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED', and also sends event msg to the rule engine with msg type 'ATTRIBUTES_UPDATED'.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "attributes", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-fd3666ce-689a-4b27-a45e-05990bf94a08" }, { "id": "db7f9ca5-09e0-4107-8c2f-7a93b872a59e", "name": "Invalid structure of the request or invalid attributes scope provided.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "attributes", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-db7f9ca5-09e0-4107-8c2f-7a93b872a59e" }, { "id": "b8bf5c29-96e9-4241-9750-b57dc1fe6824", "name": "User is not authorized to save entity attributes for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "attributes", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-b8bf5c29-96e9-4241-9750-b57dc1fe6824" }, { "id": "9c568fcc-ba92-412b-b4a9-6c11bc415e92", "name": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "attributes", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-9c568fcc-ba92-412b-b4a9-6c11bc415e92" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-2408f569-e168-47ad-8273-88f593ccac28" } ], "id": "055919e8-9f1a-4a48-b52a-eb3fdb33c906", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-055919e8-9f1a-4a48-b52a-eb3fdb33c906" } ], "id": "14a96963-c500-481b-80aa-65ef10b90931", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-14a96963-c500-481b-80aa-65ef10b90931" }, { "name": "values", "item": [ { "name": "timeseries", "item": [ { "name": "Get Time Series Data (getTimeseries)", "id": "179670d7-0d27-4807-802e-3ba996399a8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/values/timeseries?keys=&useStrictDataTypes=false&all=[object Object]&dolore7=,&startTs=&endTs=&intervalType=MILLISECONDS&interval=0&timeZone=&limit=&agg=MIN&orderBy=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "values", "timeseries" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "Enables/disables conversion of telemetry values to strings. Conversion is enabled by default. Set parameter to 'true' in order to disable the conversion.", "key": "useStrictDataTypes", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," }, { "description": "(Required) A long value representing the start timestamp of the time range in milliseconds, UTC.", "key": "startTs", "value": "" }, { "description": "(Required) A long value representing the end timestamp of the time range in milliseconds, UTC.", "key": "endTs", "value": "" }, { "description": "A string value representing the type fo the interval.", "key": "intervalType", "value": "MILLISECONDS" }, { "description": "A long value representing the aggregation interval range in milliseconds.", "key": "interval", "value": "0" }, { "description": "A string value representing the timezone that will be used to calculate exact timestamps for 'WEEK', 'WEEK_ISO', 'MONTH' and 'QUARTER' interval types.", "key": "timeZone", "value": "" }, { "description": "An integer value that represents a max number of time series data points to fetch. This parameter is used only in the case if 'agg' parameter is set to 'NONE'.", "key": "limit", "value": "" }, { "description": "A string value representing the aggregation function. If the interval is not specified, 'agg' parameter will use 'NONE' value.", "key": "agg", "value": "MIN" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "orderBy", "value": "DESC" } ], "variable": [ { "id": "8c423914-cc5f-4b80-b7cb-91d6a250256e", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "cf041b20-4006-40e3-8242-acd4f9b14525", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a range of time series values for specified entity. Returns not aggregated data by default. Use aggregation function ('agg') and aggregation interval ('interval') to enable aggregation of the results on the database / server side. The aggregation is generally more efficient then fetching all records. \n\n```json\n{\n \"temperature\": [\n {\n \"value\": 36.7,\n \"ts\": 1609459200000\n },\n {\n \"value\": 36.6,\n \"ts\": 1609459201000\n }\n ]\n}\n```\n\nReferencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "978cc9c3-97a7-478f-adc6-57b276af2537", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/values/timeseries?keys=&useStrictDataTypes=false&all=[object Object]&dolore7=,&startTs=&endTs=&intervalType=MILLISECONDS&interval=0&timeZone=&limit=&agg=MIN&orderBy=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "values", "timeseries" ], "query": [ { "description": "A string value representing the comma-separated list of telemetry keys. If keys are not selected, the result will return all latest time series. For example, 'temperature,humidity'. If telemetry keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "Enables/disables conversion of telemetry values to strings. Conversion is enabled by default. Set parameter to 'true' in order to disable the conversion.", "key": "useStrictDataTypes", "value": "false" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," }, { "description": "(Required) A long value representing the start timestamp of the time range in milliseconds, UTC.", "key": "startTs", "value": "" }, { "description": "(Required) A long value representing the end timestamp of the time range in milliseconds, UTC.", "key": "endTs", "value": "" }, { "description": "A string value representing the type fo the interval.", "key": "intervalType", "value": "MILLISECONDS" }, { "description": "A long value representing the aggregation interval range in milliseconds.", "key": "interval", "value": "0" }, { "description": "A string value representing the timezone that will be used to calculate exact timestamps for 'WEEK', 'WEEK_ISO', 'MONTH' and 'QUARTER' interval types.", "key": "timeZone", "value": "" }, { "description": "An integer value that represents a max number of time series data points to fetch. This parameter is used only in the case if 'agg' parameter is set to 'NONE'.", "key": "limit", "value": "" }, { "description": "A string value representing the aggregation function. If the interval is not specified, 'agg' parameter will use 'NONE' value.", "key": "agg", "value": "MIN" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "orderBy", "value": "DESC" } ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-978cc9c3-97a7-478f-adc6-57b276af2537" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-179670d7-0d27-4807-802e-3ba996399a8b" } ], "id": "afc522da-7fae-483c-a53d-6e99444b50fa", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-afc522da-7fae-483c-a53d-6e99444b50fa" }, { "name": "attributes", "item": [ { "name": "{scope}", "item": [ { "name": "Get Attributes by Scope (getAttributesByScope)", "id": "3fbd26ca-3854-4609-b7c8-b6ca990a2c94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/values/attributes/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "values", "attributes", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "id": "e97fe2cd-9eca-4ebf-99a3-419c2139b3a0", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "433b98e4-c997-4741-a230-22e1fc8bf7b1", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "7d8d24e4-e65d-41c6-adb5-3e77f18cd621", "key": "scope", "value": "SHARED_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Returns all attributes of a specified scope that belong to specified entity. List of possible attribute scopes depends on the entity type: \n\n * SERVER_SCOPE - supported for all entity types;\n * SHARED_SCOPE - supported for devices;\n * CLIENT_SCOPE - supported for devices. \n\nUse optional 'keys' parameter to return specific attributes.\n Example of the result: \n\n```json\n[\n {\"key\": \"stringAttributeKey\", \"value\": \"value\", \"lastUpdateTs\": 1609459200000},\n {\"key\": \"booleanAttributeKey\", \"value\": false, \"lastUpdateTs\": 1609459200001},\n {\"key\": \"doubleAttributeKey\", \"value\": 42.2, \"lastUpdateTs\": 1609459200002},\n {\"key\": \"longKeyExample\", \"value\": 73, \"lastUpdateTs\": 1609459200003},\n {\"key\": \"jsonKeyExample\",\n \"value\": {\n \"someNumber\": 42,\n \"someArray\": [1,2,3],\n \"someNestedObject\": {\"key\": \"value\"}\n },\n \"lastUpdateTs\": 1609459200004\n }\n]\n```\n\n Referencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "5352609b-3d4d-4f8b-97c6-edea2795409e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/values/attributes/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "values", "attributes", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-5352609b-3d4d-4f8b-97c6-edea2795409e" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-3fbd26ca-3854-4609-b7c8-b6ca990a2c94" } ], "id": "e2ab654f-ecda-4ca8-ae38-ccf3c255c16a", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-e2ab654f-ecda-4ca8-ae38-ccf3c255c16a" }, { "name": "Get Attributes (getAttributes)", "id": "fa608948-410d-4d0a-9648-8ab659b6fc80", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/values/attributes?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "values", "attributes" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "id": "05d63489-27d6-4111-94b0-799af9d74e2a", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "7c5df2f0-8bf7-4b38-ba37-32eb0f7880e9", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns all attributes that belong to specified entity. Use optional 'keys' parameter to return specific attributes.\n Example of the result: \n\n```json\n[\n {\"key\": \"stringAttributeKey\", \"value\": \"value\", \"lastUpdateTs\": 1609459200000},\n {\"key\": \"booleanAttributeKey\", \"value\": false, \"lastUpdateTs\": 1609459200001},\n {\"key\": \"doubleAttributeKey\", \"value\": 42.2, \"lastUpdateTs\": 1609459200002},\n {\"key\": \"longKeyExample\", \"value\": 73, \"lastUpdateTs\": 1609459200003},\n {\"key\": \"jsonKeyExample\",\n \"value\": {\n \"someNumber\": 42,\n \"someArray\": [1,2,3],\n \"someNestedObject\": {\"key\": \"value\"}\n },\n \"lastUpdateTs\": 1609459200004\n }\n]\n```\n\n Referencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "171bb750-6c03-492d-a860-574f2cd966e1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/values/attributes?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "values", "attributes" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-171bb750-6c03-492d-a860-574f2cd966e1" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-fa608948-410d-4d0a-9648-8ab659b6fc80" } ], "id": "49004beb-ec77-4b83-8550-7f217460d569", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-49004beb-ec77-4b83-8550-7f217460d569" } ], "id": "309ed77e-70eb-4867-aba4-955ce4a887b1", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-309ed77e-70eb-4867-aba4-955ce4a887b1" }, { "name": "keys", "item": [ { "name": "timeseries", "item": [ { "name": "Get Time Series Keys (getTimeseriesKeys)", "id": "d478605a-8f5d-47a0-8a69-a059fee9a159", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/keys/timeseries", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "keys", "timeseries" ], "variable": [ { "id": "c1ba329d-a89a-4ada-9b38-3b7d5dfc6b90", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "0ef25e9f-a14b-42e9-8a20-f627c7cef7a7", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a set of unique time series key names for the selected entity. \n\nReferencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "874ab28c-019a-4249-9266-302a50e7e7a5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/keys/timeseries", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "keys", "timeseries" ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-874ab28c-019a-4249-9266-302a50e7e7a5" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-d478605a-8f5d-47a0-8a69-a059fee9a159" } ], "id": "a343c717-b2f8-4520-980d-f6f1617258a8", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-a343c717-b2f8-4520-980d-f6f1617258a8" }, { "name": "attributes", "item": [ { "name": "{scope}", "item": [ { "name": "Get All Attribute Keys by Scope (getAttributeKeysByScope)", "id": "50c5e47b-181a-4169-98fb-e297e59f173a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/keys/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "keys", "attributes", ":scope" ], "variable": [ { "id": "a5a5b1e7-06a6-403e-a298-3270a4fe9fe5", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "890a35e4-e378-4c01-b10b-16ae54d69f28", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "1a37d191-c7ca-42e6-8e37-d4fbc2251c62", "key": "scope", "value": "SHARED_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Returns a set of unique attribute key names for the selected entity and attributes scope: \n\n * SERVER_SCOPE - supported for all entity types;\n * CLIENT_SCOPE - supported for devices;\n * SHARED_SCOPE - supported for devices. \n\nReferencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "71c5994b-4a8a-472e-af04-e87904d8aa47", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/keys/attributes/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "keys", "attributes", ":scope" ], "variable": [ { "key": "entityType" }, { "key": "entityId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-71c5994b-4a8a-472e-af04-e87904d8aa47" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-50c5e47b-181a-4169-98fb-e297e59f173a" } ], "id": "77a38766-3587-4b2f-aa8f-3a969d897dc3", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-77a38766-3587-4b2f-aa8f-3a969d897dc3" }, { "name": "Get All Attribute Keys (getAttributeKeys)", "id": "bbe050cc-c73b-42cf-b324-6826cfe3a808", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/keys/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "keys", "attributes" ], "variable": [ { "id": "d7ba88e1-ecb1-4a87-b083-7ce601349a06", "key": "entityType", "value": "", "description": "(Required) A string value representing the entity type. For example, 'DEVICE'" }, { "id": "b9d9e0d3-12dd-4d6a-834a-3b5c60976ffa", "key": "entityId", "value": "", "description": "(Required) A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a set of unique attribute key names for the selected entity. The response will include merged key names set for all attribute scopes:\n\n * SERVER_SCOPE - supported for all entity types;\n * CLIENT_SCOPE - supported for devices;\n * SHARED_SCOPE - supported for devices. \n\nReferencing a non-existing entity Id or invalid entity type will cause an error. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "dd7b9afb-bf21-448f-aa14-05e18811c5da", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:entityType/:entityId/keys/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":entityType", ":entityId", "keys", "attributes" ], "variable": [ { "key": "entityType" }, { "key": "entityId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-dd7b9afb-bf21-448f-aa14-05e18811c5da" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-bbe050cc-c73b-42cf-b324-6826cfe3a808" } ], "id": "75247300-d5af-4c4f-b24b-63315347f678", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-75247300-d5af-4c4f-b24b-63315347f678" } ], "id": "065f1a00-c472-4a16-9c38-d7963aa1aea1", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-065f1a00-c472-4a16-9c38-d7963aa1aea1" } ], "id": "32b86541-5ffe-461e-ac0d-080a42d7678b", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-32b86541-5ffe-461e-ac0d-080a42d7678b" } ], "id": "2c9dfdea-c1ee-4318-b790-1d55ed391f0e", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-2c9dfdea-c1ee-4318-b790-1d55ed391f0e" }, { "name": "{deviceId}", "item": [ { "name": "{scope}", "item": [ { "name": "Save Device Attributes (saveDeviceAttributes)", "id": "8c068a2a-fe87-4750-b5ac-7970a93b5383", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "variable": [ { "id": "a9b9e636-35f2-4e2b-b062-bca71bcef05e", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "9779753c-01af-40bb-971e-f611d52fc5c4", "key": "scope", "value": "SERVER_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Creates or updates the device attributes based on device id and specified attribute scope. The request payload is a JSON object with key-value format of attributes to create or update. For example:\n\n```json\n{\n \"stringKey\":\"value1\", \n \"booleanKey\":true, \n \"doubleKey\":42.0, \n \"longKey\":73, \n \"jsonKey\": {\n \"someNumber\": 42,\n \"someArray\": [1,2,3],\n \"someNestedObject\": {\"key\": \"value\"}\n }\n}\n```\n\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "4f92f830-df4c-4b08-9d26-4f26b792f133", "name": "Attribute from the request was created or updated. Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED', and also sends event msg to the rule engine with msg type 'ATTRIBUTES_UPDATED'.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-4f92f830-df4c-4b08-9d26-4f26b792f133" }, { "id": "bf5528b9-3385-421d-bebd-7306bb24f74a", "name": "Invalid structure of the request or invalid attributes scope provided.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-bf5528b9-3385-421d-bebd-7306bb24f74a" }, { "id": "29352ea2-c2c0-49f0-95ba-9852e6a2bd3b", "name": "User is not authorized to save device attributes for selected device. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-29352ea2-c2c0-49f0-95ba-9852e6a2bd3b" }, { "id": "b1d8d27e-fbcf-4186-8d89-00fe15db39b4", "name": "The exception was thrown during processing the request. Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-b1d8d27e-fbcf-4186-8d89-00fe15db39b4" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-8c068a2a-fe87-4750-b5ac-7970a93b5383" }, { "name": "Delete Device Attributes (deleteDeviceAttributes)", "id": "5ed78d54-29e9-4b40-b52a-1f3c04ce70c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "id": "9cf5198f-a165-43ae-91b3-6127e1bf66fc", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "743745d6-0c82-40c6-9fc4-681fea2dfb69", "key": "scope", "value": "SHARED_SCOPE", "description": "(Required) A string value representing the attributes scope. For example, 'SERVER_SCOPE'." } ] }, "description": "Delete device attributes using provided Device Id, scope and a list of keys. Referencing a non-existing Device Id will cause an error\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "3c0a4e9c-74af-479b-81ee-dfaaffb734c9", "name": "Device attributes was removed for the selected keys in the request. Platform creates an audit log event about device attributes removal with action type 'ATTRIBUTES_DELETED'.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-3c0a4e9c-74af-479b-81ee-dfaaffb734c9" }, { "id": "c0dacd43-e307-47e4-99d3-8ef48f738ccc", "name": "Platform returns a bad request in case if keys or scope are not specified.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-c0dacd43-e307-47e4-99d3-8ef48f738ccc" }, { "id": "9a3655e5-0e36-4fad-9a0d-02a824532237", "name": "User is not authorized to delete device attributes for selected entity. Most likely, User belongs to different Customer or Tenant.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-9a3655e5-0e36-4fad-9a0d-02a824532237" }, { "id": "bcdf5043-6302-46a5-8ef0-67848b481253", "name": "The exception was thrown during processing the request. Platform creates an audit log event about device attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/plugins/telemetry/:deviceId/:scope?keys=&all=[object Object]&dolore7=,", "host": [ "{{baseUrl}}" ], "path": [ "api", "plugins", "telemetry", ":deviceId", ":scope" ], "query": [ { "description": "A string value representing the comma-separated list of attributes keys. For example, 'active,inactivityAlarmTime'. If attribute keys contain comma, duplicate 'key' parameter for each key, for example '?key=my,key&key=my,second,key", "key": "keys", "value": "" }, { "description": "(Required) ", "key": "all", "value": "[object Object]" }, { "description": "(Required) ", "key": "dolore7", "value": "," } ], "variable": [ { "key": "deviceId" }, { "key": "scope" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-bcdf5043-6302-46a5-8ef0-67848b481253" } ], "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-5ed78d54-29e9-4b40-b52a-1f3c04ce70c8" } ], "id": "90d9e21d-3b6a-4f4d-8fc3-6039f6115b28", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-90d9e21d-3b6a-4f4d-8fc3-6039f6115b28" } ], "id": "431787cb-f411-4886-b9f2-cd2f6c564b18", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-431787cb-f411-4886-b9f2-cd2f6c564b18" } ], "id": "b9e298ed-a698-4851-a1d9-0904ee283221", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-b9e298ed-a698-4851-a1d9-0904ee283221" } ], "id": "002c1db8-6080-48cd-9432-c38429a890ce", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-002c1db8-6080-48cd-9432-c38429a890ce" } ], "id": "db354681-ab9b-425e-9ee8-d97de13d10a1", "createdAt": "2026-07-28T03:13:14.000Z", "updatedAt": "2026-07-28T03:13:14.000Z", "uid": "35240-db354681-ab9b-425e-9ee8-d97de13d10a1" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }