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

40169ccdec5c

device-profile-controller

Get Device Profile (getDeviceProfileById)

Fetch the Device Profile object based on the provided Device Profile Id. The server checks that the device profile is owned by the same tenant.

Available for users with 'TENANT_ADMIN' authority.

get/api/deviceProfile/{deviceProfileId}

Path parameters

deviceProfileIdstring required

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

Query parameters

inlineImagesboolean

Inline images as a data URL (Base64)

Response

OK

createdTimeinteger

Timestamp of the profile creation, in milliseconds

namestring

Unique Device Profile Name in scope of Tenant.

descriptionstring

Device Profile description.

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.

provisionType'DISABLED' | 'ALLOW_CREATE_NEW_DEVICES' | 'CHECK_PRE_PROVISIONED_DEVICES' | 'X509_CERTIFICATE_CHAIN'

Provisioning strategy.

defaultQueueNamestring

Rule engine queue name. If present, the specified queue will be used to store all unprocessed messages related to device, including telemetry, attribute updates, etc. Otherwise, the 'Main' queue will be used to store those messages.

provisionDeviceKeystring

Unique provisioning key used by 'Device Provisioning' feature.

versioninteger
defaultboolean

Used to mark the default profile. Default profile is used when the device profile is not specified during device creation.