latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

device-controller

Get Devices By Ids (getDevicesByIds)

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

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

get/api/devices

Query parameters

deviceIdsstring[] required

A list of devices ids, separated by comma ','

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