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

40169ccdec5c

device-controller

Find related devices (findByQuery)

Returns all devices that are related to the specific entity. The entity id, relation type, device types, depth of the search, and other query parameters defined using complex 'DeviceSearchQuery' object. See 'Model' tab of the Parameters for more info.

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

post/api/devices

Request body

relationTypestring

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

deviceTypesstring[]

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

Example request

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

Response

OK

createdTimeinteger

Timestamp of the device creation, in milliseconds

namestring required

Unique Device Name in scope of Tenant

typestring

Device Profile Name

labelstring

Label that may be used in widgets

versioninteger
{"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": "DEVICE"
    },
    "createdTime": 1609459200000,
    "tenantId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "TENANT"
    },
    "customerId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "CUSTOMER"
    },
    "name": "A4B72CCDFF33",
    "type": "Temperature Sensor",
    "label": "Room 234 Sensor",
    "deviceProfileId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "DEVICE_PROFILE"
    },
    "firmwareId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "OTA_PACKAGE"
    },
    "softwareId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "OTA_PACKAGE"
    },
    "additionalInfo": {}
  }
]