device-controller
Get Tenant Device (getTenantDevice)
Requested device must be owned by tenant that the user belongs to. Device name is an unique property of device. So it can be used to identify the device.
Available for users with 'TENANT_ADMIN' authority.
get/api/tenant/devices
Query parameters
pageSizeinteger required
Maximum amount of entities in a one page
pageinteger required
Sequence number of page starting from 0
typestring
Device type as the name of the device profile
textSearchstring
The case insensitive 'substring' filter based on the device name.
sortProperty'createdTime' | 'name' | 'deviceProfileName' | 'label' | 'customerTitle'
Property of entity to sort by
sortOrder'ASC' | 'DESC'
Sort order. ASC (ASCENDING) or DESC (DESCENDING)
deviceNamestring required
A string value representing the Device name.
Response
OK
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": {}
}