{ "info": { "_postman_id": "ed77c511-5afb-4e9f-9742-fd5635ed174e", "name": "ThingsBoard Admin admin-controller entity-view-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:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "lastUpdatedBy": "35240", "uid": "35240-ed77c511-5afb-4e9f-9742-fd5635ed174e" }, "item": [ { "name": "api", "item": [ { "name": "entityViews", "item": [ { "name": "Get Entity Views by Ids (getEntityViewsByIds)", "id": "9cf9228b-ea59-4703-940a-affc382958c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityViews?entityViewIds=&entityViewIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityViews" ], "query": [ { "description": "(Required) A list of entity view ids, separated by comma ','", "key": "entityViewIds", "value": "" }, { "description": "(Required) A list of entity view ids, separated by comma ','", "key": "entityViewIds", "value": "" } ] }, "description": "Requested entity views must be owned by tenant or assigned to customer which user is performing the request. " }, "response": [ { "id": "96aa09e4-2ec1-42d5-8609-b842f7cff8ca", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityViews?entityViewIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityViews" ], "query": [ { "description": "(Required) A list of entity view ids, separated by comma ','", "key": "entityViewIds", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"entityId\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"entityId\": {\n \"entityType\": \"EDGE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n]", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-96aa09e4-2ec1-42d5-8609-b842f7cff8ca" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-9cf9228b-ea59-4703-940a-affc382958c1" }, { "name": "Find Related Entity Views (findByQuery)", "id": "3f354a89-5477-49e3-af03-95a33696ccd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"rootId\": \"\",\n \"rootType\": \"API_KEY\",\n \"direction\": \"TO\",\n \"relationTypeGroup\": \"EDGE\",\n \"maxLevel\": \"\",\n \"fetchLastLevelOnly\": \"\"\n },\n \"relationType\": \"\",\n \"entityViewTypes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/entityViews", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityViews" ] }, "description": "Returns all entity views that are related to the specific entity. The entity id, relation type, entity view types, depth of the search, and other query parameters defined using complex 'EntityViewSearchQuery' object. See 'Model' tab of the Parameters for more info.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "e5257718-7c7e-40d1-986f-b77bdce272fc", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"rootId\": \"\",\n \"rootType\": \"API_KEY\",\n \"direction\": \"TO\",\n \"relationTypeGroup\": \"EDGE\",\n \"maxLevel\": \"\",\n \"fetchLastLevelOnly\": \"\"\n },\n \"relationType\": \"\",\n \"entityViewTypes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/entityViews", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityViews" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"entityId\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"entityId\": {\n \"entityType\": \"EDGE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n]", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-e5257718-7c7e-40d1-986f-b77bdce272fc" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-3f354a89-5477-49e3-af03-95a33696ccd7" } ], "id": "43af9bb5-47b4-47d1-8962-f814de28c095", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-43af9bb5-47b4-47d1-8962-f814de28c095" }, { "name": "entityView", "item": [ { "name": "{entityViewId}", "item": [ { "name": "Get Entity View (getEntityViewById)", "id": "85a17a5c-0622-4ade-8a56-f50e9e9e3814", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", ":entityViewId" ], "variable": [ { "id": "566abff6-cce4-4502-9394-84c01ea8189d", "key": "entityViewId", "value": "", "description": "(Required) A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Fetch the EntityView object based on the provided entity view id. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. See the 'Model' tab for more details.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "dbed1baa-eb31-4a34-bec9-1f4182be54c3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", ":entityViewId" ], "variable": [ { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-dbed1baa-eb31-4a34-bec9-1f4182be54c3" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-85a17a5c-0622-4ade-8a56-f50e9e9e3814" }, { "name": "Delete Entity View (deleteEntityView)", "id": "1dd351ca-a75f-4e9e-bdf0-554d66b88319", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", ":entityViewId" ], "variable": [ { "id": "00fa2ae7-60cb-4aaa-b8ab-7d10b819c3a8", "key": "entityViewId", "value": "", "description": "(Required) A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Delete the EntityView object based on the provided entity view id. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "a1ee8c93-f0ac-4512-bd7c-047bc4ebdf80", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", ":entityViewId" ], "variable": [ { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-a1ee8c93-f0ac-4512-bd7c-047bc4ebdf80" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-1dd351ca-a75f-4e9e-bdf0-554d66b88319" } ], "id": "0b406a40-ffda-4bc3-b297-992236b751cf", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-0b406a40-ffda-4bc3-b297-992236b751cf" }, { "name": "types", "item": [ { "name": "Get Entity View Types (getEntityViewTypes)", "id": "5f090e67-2871-45b7-b72d-1181fcfa9d77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityView/types", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", "types" ] }, "description": "Returns a set of unique entity view types based on entity views that are either owned by the tenant or assigned to the customer which user is performing the request.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "50b4c379-ad49-4a60-bc19-0201e88ea778", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityView/types", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", "types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"entityType\": \"WIDGET_TYPE\",\n \"type\": \"\"\n },\n {\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"entityType\": \"RPC\",\n \"type\": \"\"\n }\n]", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-50b4c379-ad49-4a60-bc19-0201e88ea778" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-5f090e67-2871-45b7-b72d-1181fcfa9d77" } ], "id": "df82a1b1-4cc5-458f-9f6f-aa259f53a1f3", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-df82a1b1-4cc5-458f-9f6f-aa259f53a1f3" }, { "name": "info", "item": [ { "name": "{entityViewId}", "item": [ { "name": "Get Entity View Info (getEntityViewInfoById)", "id": "6670d0f7-9038-4c2b-9821-479baf7b38f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityView/info/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", "info", ":entityViewId" ], "variable": [ { "id": "bf8f6157-12b0-4532-b246-a1055dd5e95a", "key": "entityViewId", "value": "", "description": "(Required) A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Fetch the Entity View info object based on the provided Entity View Id. Entity Views Info extends the Entity View with customer title and 'is public' flag. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. See the 'Model' tab for more details.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "b2ce3ee8-86b7-4ef5-969c-4f0ff1086d79", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/entityView/info/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView", "info", ":entityViewId" ], "variable": [ { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-b2ce3ee8-86b7-4ef5-969c-4f0ff1086d79" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-6670d0f7-9038-4c2b-9821-479baf7b38f0" } ], "id": "340d5291-abac-4a45-bfde-ebc2cbf26fc3", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-340d5291-abac-4a45-bfde-ebc2cbf26fc3" } ], "id": "6daedd92-3ac3-459e-8036-215498a9ed71", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-6daedd92-3ac3-459e-8036-215498a9ed71" }, { "name": "Save or Update Entity View (saveEntityView)", "id": "7897ff53-bc52-4f76-9284-2dc796a7f7f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/entityView?nameConflictPolicy=FAIL&uniquifySeparator=_&uniquifyStrategy=RANDOM", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView" ], "query": [ { "description": "Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.", "key": "nameConflictPolicy", "value": "FAIL" }, { "description": "Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.", "key": "uniquifySeparator", "value": "_" }, { "description": "Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.", "key": "uniquifyStrategy", "value": "RANDOM" } ] }, "description": "Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. See the 'Model' tab for more details.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Entity View entity.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "e5e14c80-eb9a-4ab9-bb97-8a136a0315c0", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/entityView?nameConflictPolicy=FAIL&uniquifySeparator=_&uniquifyStrategy=RANDOM", "host": [ "{{baseUrl}}" ], "path": [ "api", "entityView" ], "query": [ { "description": "Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.", "key": "nameConflictPolicy", "value": "FAIL" }, { "description": "Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.", "key": "uniquifySeparator", "value": "_" }, { "description": "Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.", "key": "uniquifyStrategy", "value": "RANDOM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-e5e14c80-eb9a-4ab9-bb97-8a136a0315c0" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-7897ff53-bc52-4f76-9284-2dc796a7f7f7" } ], "id": "5a59912c-6e29-458d-afa3-ddbb4e2aa296", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-5a59912c-6e29-458d-afa3-ddbb4e2aa296" }, { "name": "edge", "item": [ { "name": "{edgeId}", "item": [ { "name": "entityView", "item": [ { "name": "{entityViewId}", "item": [ { "name": "Assign Entity View to Edge (assignEntityViewToEdge)", "id": "fb530097-35ec-4033-aa4b-e8b0d1314059", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "entityView", ":entityViewId" ], "variable": [ { "id": "6f22cf3b-e102-4e91-a7e2-fcfa686887df", "key": "edgeId", "value": "", "description": "(Required) " }, { "id": "adc10418-67cd-47e4-86f8-b2359e2a9394", "key": "entityViewId", "value": "", "description": "(Required) " } ] }, "description": "Creates assignment of an existing entity view to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment entity view (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once entity view will be delivered to edge service, it's going to be available for usage on remote edge instance." }, "response": [ { "id": "ac521d22-93e1-4edf-b5e2-6152c9e3806c", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "entityView", ":entityViewId" ], "variable": [ { "key": "edgeId" }, { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-ac521d22-93e1-4edf-b5e2-6152c9e3806c" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-fb530097-35ec-4033-aa4b-e8b0d1314059" }, { "name": "Unassign Entity View from Edge (unassignEntityViewFromEdge)", "id": "0ba5031e-3cb1-44e6-94a4-60ca591d161d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "entityView", ":entityViewId" ], "variable": [ { "id": "d733437f-be2c-4e18-ac0a-c63156f450fc", "key": "edgeId", "value": "", "description": "(Required) " }, { "id": "89db79dd-8736-4f45-b325-11e585932328", "key": "entityViewId", "value": "", "description": "(Required) " } ] }, "description": "Clears assignment of the entity view to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove entity view (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove entity view locally." }, "response": [ { "id": "832a59f7-7fd4-4a19-91ff-90d443f44ab5", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "entityView", ":entityViewId" ], "variable": [ { "key": "edgeId" }, { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-832a59f7-7fd4-4a19-91ff-90d443f44ab5" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-0ba5031e-3cb1-44e6-94a4-60ca591d161d" } ], "id": "e627c6ec-7486-4a54-9783-470f75458ec8", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-e627c6ec-7486-4a54-9783-470f75458ec8" } ], "id": "a05f0f88-71ce-48eb-8368-5e3c2db0cf0c", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-a05f0f88-71ce-48eb-8368-5e3c2db0cf0c" }, { "name": "entityViews", "item": [ { "name": "get Edge Entity Views", "id": "bbf10946-b55c-4c2b-b127-8eb127c4bf28", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/entityViews?pageSize=&page=&type=&textSearch=&sortProperty=&sortOrder=&startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "entityViews" ], "query": [ { "description": "(Required) ", "key": "pageSize", "value": "" }, { "description": "(Required) ", "key": "page", "value": "" }, { "key": "type", "value": "" }, { "key": "textSearch", "value": "" }, { "key": "sortProperty", "value": "" }, { "key": "sortOrder", "value": "" }, { "key": "startTime", "value": "" }, { "key": "endTime", "value": "" } ], "variable": [ { "id": "4bc07a4c-1085-4b02-8020-09878c64a519", "key": "edgeId", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "f4c42526-6242-43ba-9c05-ac1b0a318bbc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/entityViews?pageSize=&page=&type=&textSearch=&sortProperty=&sortOrder=&startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "entityViews" ], "query": [ { "description": "(Required) ", "key": "pageSize", "value": "" }, { "description": "(Required) ", "key": "page", "value": "" }, { "key": "type", "value": "" }, { "key": "textSearch", "value": "" }, { "key": "sortProperty", "value": "" }, { "key": "sortOrder", "value": "" }, { "key": "startTime", "value": "" }, { "key": "endTime", "value": "" } ], "variable": [ { "key": "edgeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"entityId\": {\n \"entityType\": \"ASSET\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"entityId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-f4c42526-6242-43ba-9c05-ac1b0a318bbc" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-bbf10946-b55c-4c2b-b127-8eb127c4bf28" } ], "id": "c9c95978-68a1-46ab-ba3c-407331d95625", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-c9c95978-68a1-46ab-ba3c-407331d95625" } ], "id": "a80bf285-f789-4876-b463-9b3cd5976ec3", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-a80bf285-f789-4876-b463-9b3cd5976ec3" } ], "id": "e035a6d2-2326-4602-8680-867929090cec", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-e035a6d2-2326-4602-8680-867929090cec" }, { "name": "customer", "item": [ { "name": "{customerId}", "item": [ { "name": "entityView", "item": [ { "name": "{entityViewId}", "item": [ { "name": "Assign Entity View to Customer (assignEntityViewToCustomer)", "id": "a0e1f11a-d183-433c-9404-fcddd8e92157", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "entityView", ":entityViewId" ], "variable": [ { "id": "289aa447-c47b-45b2-bf96-686f524717eb", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "8009a91c-7048-40ca-bdbc-0c314e0f15b8", "key": "entityViewId", "value": "", "description": "(Required) A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Creates assignment of the Entity View to customer. Customer will be able to query Entity View afterwards.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "26f91122-74d8-4214-b0b9-983d04aa3e42", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "entityView", ":entityViewId" ], "variable": [ { "key": "customerId" }, { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-26f91122-74d8-4214-b0b9-983d04aa3e42" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-a0e1f11a-d183-433c-9404-fcddd8e92157" } ], "id": "0cb4a09b-d6f4-40f4-860c-24fc3397e1da", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-0cb4a09b-d6f4-40f4-860c-24fc3397e1da" } ], "id": "2a97b23c-d09d-45cd-9523-eecfdd2d4e1e", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-2a97b23c-d09d-45cd-9523-eecfdd2d4e1e" }, { "name": "entityViews", "item": [ { "name": "Get Customer Entity Views (getCustomerEntityViews)", "id": "434a9c8d-f295-49d7-892b-d98c8bf95ab3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/entityViews?pageSize=&page=&type=&textSearch=&sortProperty=type&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "entityViews" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "type" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "id": "ead2e304-f124-4e87-9a7e-f3d17432040a", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of Entity View objects assigned to customer. 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": "b525dc8c-26e4-40fd-919a-6f599b86ff99", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/entityViews?pageSize=&page=&type=&textSearch=&sortProperty=type&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "entityViews" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "type" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"entityId\": {\n \"entityType\": \"ASSET\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"entityId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-b525dc8c-26e4-40fd-919a-6f599b86ff99" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-434a9c8d-f295-49d7-892b-d98c8bf95ab3" } ], "id": "7171c981-26b5-4900-8b9e-d2054e1fcee8", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-7171c981-26b5-4900-8b9e-d2054e1fcee8" }, { "name": "entityViewInfos", "item": [ { "name": "Get Customer Entity View Info (getCustomerEntityViewInfos)", "id": "74b9df33-c840-4c1e-a488-8c95340e7cb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/entityViewInfos?pageSize=&page=&type=&textSearch=&sortProperty=name&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "entityViewInfos" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "name" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "id": "339fd518-ebf5-48e3-a8fa-90d2c7a69b16", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of Entity View info objects assigned to customer. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. 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": "6ac0f435-7d19-464c-bc6a-526d394d9a3c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/entityViewInfos?pageSize=&page=&type=&textSearch=&sortProperty=name&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "entityViewInfos" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "name" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"entityId\": {\n \"entityType\": \"OAUTH2_CLIENT\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"entityId\": {\n \"entityType\": \"OAUTH2_CLIENT\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-6ac0f435-7d19-464c-bc6a-526d394d9a3c" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-74b9df33-c840-4c1e-a488-8c95340e7cb0" } ], "id": "5da78ee3-dae8-40d1-9fdd-ae484680496a", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-5da78ee3-dae8-40d1-9fdd-ae484680496a" } ], "id": "8a6e7941-5788-4330-b4f0-b29538b8494d", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-8a6e7941-5788-4330-b4f0-b29538b8494d" }, { "name": "public", "item": [ { "name": "entityView", "item": [ { "name": "{entityViewId}", "item": [ { "name": "Make Entity View Publicly Available (assignEntityViewToPublicCustomer)", "id": "24141224-5e30-4ad9-8b82-e5489f9ad995", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "entityView", ":entityViewId" ], "variable": [ { "id": "d93b2211-18d1-40aa-bafa-9dd9dd2874e1", "key": "entityViewId", "value": "", "description": "(Required) A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Entity View will be available for non-authorized (not logged-in) users. This is useful to create dashboards that you plan to share/embed on a publicly available website. However, users that are logged-in and belong to different tenant will not be able to access the entity view.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "921ff7ee-1216-427c-811d-22dfef4f5075", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "entityView", ":entityViewId" ], "variable": [ { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-921ff7ee-1216-427c-811d-22dfef4f5075" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-24141224-5e30-4ad9-8b82-e5489f9ad995" } ], "id": "e8fddcce-0deb-44e7-85a7-73a6c98b9dd7", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-e8fddcce-0deb-44e7-85a7-73a6c98b9dd7" } ], "id": "343a2323-77d3-422b-ab14-976e9fc0d6f4", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-343a2323-77d3-422b-ab14-976e9fc0d6f4" } ], "id": "877af1f3-178a-4147-9f02-871f5db8f9df", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-877af1f3-178a-4147-9f02-871f5db8f9df" }, { "name": "entityView", "item": [ { "name": "{entityViewId}", "item": [ { "name": "Unassign Entity View from Customer (unassignEntityViewFromCustomer)", "id": "a58f5a9f-f021-4dbc-8e9d-cb7ae94b7b26", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "entityView", ":entityViewId" ], "variable": [ { "id": "50502ce8-454a-4615-a1a0-6c12eccabfe6", "key": "entityViewId", "value": "", "description": "(Required) A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Clears assignment of the Entity View to customer. Customer will not be able to query Entity View afterwards.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "2491a6ed-6e18-4eb7-a690-e0bdcff7a3b7", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/entityView/:entityViewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "entityView", ":entityViewId" ], "variable": [ { "key": "entityViewId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-2491a6ed-6e18-4eb7-a690-e0bdcff7a3b7" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-a58f5a9f-f021-4dbc-8e9d-cb7ae94b7b26" } ], "id": "6d06d893-a657-455a-a80c-7fe7793f6050", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-6d06d893-a657-455a-a80c-7fe7793f6050" } ], "id": "1458e55b-ed7e-4cdc-b06a-4477a0130431", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-1458e55b-ed7e-4cdc-b06a-4477a0130431" } ], "id": "e4b9527f-09d4-4e7f-84c2-cd0d90a7e68e", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-e4b9527f-09d4-4e7f-84c2-cd0d90a7e68e" }, { "name": "tenant", "item": [ { "name": "entityViews", "item": [ { "name": "Get Entity View by Name (getTenantEntityView)", "id": "c55ebaf3-1833-4ba0-bc54-456f0054990d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/entityViews?pageSize=&page=&type=&textSearch=&sortProperty=type&sortOrder=ASC&entityViewName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "entityViews" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "type" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" }, { "description": "(Required) Entity View name", "key": "entityViewName", "value": "" } ] }, "description": "Fetch the Entity View object based on the tenant id and entity view name. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "d24c71d7-346d-4d68-9f7f-73ed6ccac691", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/entityViews?pageSize=&page=&type=&textSearch=&sortProperty=type&sortOrder=ASC&entityViewName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "entityViews" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "type" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" }, { "description": "(Required) Entity View name", "key": "entityViewName", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entityId\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-d24c71d7-346d-4d68-9f7f-73ed6ccac691" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-c55ebaf3-1833-4ba0-bc54-456f0054990d" } ], "id": "7433af24-2549-4ecb-a923-48dac064f4c4", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-7433af24-2549-4ecb-a923-48dac064f4c4" }, { "name": "entityViewInfos", "item": [ { "name": "Get Tenant Entity Views (getTenantEntityViews)", "id": "77b1213a-f0e3-471c-8254-88ec549fa48d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/entityViewInfos?pageSize=&page=&type=&textSearch=&sortProperty=name&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "entityViewInfos" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "name" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ] }, "description": "Returns a page of entity views info owned by tenant. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. 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' authority." }, "response": [ { "id": "a591101f-ccc8-44e7-ab91-d5d1f92b6fe0", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/entityViewInfos?pageSize=&page=&type=&textSearch=&sortProperty=name&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "entityViewInfos" ], "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": "\n\n## Entity View Filter\n\nAllows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT':\n\n```json\n{\n \"type\": \"entityViewType\",\n \"entityViewType\": \"Concrete Mixer\",\n \"entityViewNameFilter\": \"CAT\"\n}\n```", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the entity view name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "name" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"entityId\": {\n \"entityType\": \"OAUTH2_CLIENT\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"entityId\": {\n \"entityType\": \"OAUTH2_CLIENT\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"type\": \"\",\n \"id\": {\n \"entityType\": \"ENTITY_VIEW\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"keys\": {\n \"attributes\": {\n \"cs\": [\n \"\",\n \"\"\n ],\n \"sh\": [\n \"\",\n \"\"\n ],\n \"ss\": [\n \"\",\n \"\"\n ]\n },\n \"timeseries\": [\n \"\",\n \"\"\n ]\n },\n \"startTimeMs\": \"\",\n \"endTimeMs\": \"\",\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-a591101f-ccc8-44e7-ab91-d5d1f92b6fe0" } ], "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-77b1213a-f0e3-471c-8254-88ec549fa48d" } ], "id": "435eca29-4682-4ddf-ad09-f0fa58ea9b45", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-435eca29-4682-4ddf-ad09-f0fa58ea9b45" } ], "id": "b296ca21-356f-4e4b-970d-908d4203ba11", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-b296ca21-356f-4e4b-970d-908d4203ba11" } ], "id": "178e1988-416c-4492-9cfe-64cfb7c3e7cb", "createdAt": "2026-07-28T03:12:41.000Z", "updatedAt": "2026-07-28T03:12:41.000Z", "uid": "35240-178e1988-416c-4492-9cfe-64cfb7c3e7cb" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }