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

40169ccdec5c

entity-view-controller

Get Entity Views By Ids (getEntityViewsByIds)

Requested entity views must be owned by tenant or assigned to customer which user is performing the request.

get/api/entityViews

Query parameters

entityViewIdsstring[] required

A list of entity view ids, separated by comma ','

Response

OK

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
createdTimeinteger

Timestamp of the Entity View creation, in milliseconds

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

Example response

[
  {
    "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"
        ]
      }
    },
    "id": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "ENTITY_VIEW"
    },
    "createdTime": 1609459200000,
    "additionalInfo": {}
  }
]