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

40169ccdec5c

device-controller

Get Device Info (getDeviceInfoById)

Fetch the Device Info object based on the provided Device Id. If the user has the authority of 'Tenant Administrator', the server checks that the device is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the device is assigned to the same customer. Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name.

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

get/api/device/info/{deviceId}

Path parameters

deviceIdstring required

A string value representing the device id. For example, '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
customerTitlestring

Title of the Customer that owns the device.

customerIsPublicboolean

Indicates special 'Public' Customer that is auto-generated to use the devices on public dashboards.

deviceProfileNamestring

Name of the corresponding Device Profile.

activeboolean

Device active flag.

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