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

40169ccdec5c

entity-view-controller

Assign entity view to edge (assignEntityViewToEdge)

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.

post/api/edge/{edgeId}/entityView/{entityViewId}

Path parameters

edgeIdstring required
entityViewIdstring required

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