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

40169ccdec5c

entity-view-controller

Get Entity View info (getEntityViewInfoById)

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.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/entityView/info/{entityViewId}

Path parameters

entityViewIdstring required

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

Response

OK

createdTimeinteger

Timestamp of the Entity View creation, in milliseconds

namestring required

Entity View name

typestring required

Device Profile Name

startTimeMsinteger

Represents the start time of the interval that is used to limit access to target device telemetry. Customer will not be able to see entity telemetry that is outside the specified interval;

endTimeMsinteger

Represents the end time of the interval that is used to limit access to target device telemetry. Customer will not be able to see entity telemetry that is outside the specified interval;

versioninteger
customerTitlestring

Title of the Customer that owns the entity view.

customerIsPublicboolean

Indicates special 'Public' Customer that is auto-generated to use the entity view on public dashboards.

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "ENTITY_VIEW"
  },
  "createdTime": 1609459200000,
  "entityId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "name": "A4B72CCDFF33",
  "type": "Temperature Sensor",
  "keys": {
    "timeseries": [
      "temperature",
      "humidity"
    ],
    "attributes": {
      "cs": [
        "currentConfiguration"
      ],
      "ss": [
        "model"
      ],
      "sh": [
        "targetConfiguration"
      ]
    }
  },
  "additionalInfo": {}
}