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

40169ccdec5c

device-profile-controller

Get Device Profile Info (getDeviceProfileInfoById)

Fetch the Device Profile Info object based on the provided Device Profile Id. Device Profile Info is a lightweight object that includes main information about Device Profile excluding the heavyweight configuration object.

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

get/api/deviceProfileInfo/{deviceProfileId}

Path parameters

deviceProfileIdstring required

A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

namestring

Entity Name

imagestring

Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view.

type'DEFAULT'

Type of the profile. Always 'DEFAULT' for now. Reserved for future use.

transportType'DEFAULT' | 'MQTT' | 'COAP' | 'LWM2M' | 'SNMP'

Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT.

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "defaultDashboardId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DASHBOARD"
  }
}