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

40169ccdec5c

entity-view-controller

Find related entity views (findByQuery)

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.

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

post/api/entityViews

Request body

relationTypestring

Type of the relation between root entity and device (e.g. 'Contains' or 'Manages').

entityViewTypesstring[]

Array of entity view types to filter the related entities (e.g. 'Temperature Sensor', 'Smoke Sensor').

Example request

{
  "parameters": {
    "rootId": "784f394c-42b6-435a-983c-b7beff2784f9"
  }
}

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": {}
  }
]