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

40169ccdec5c

device-controller

Get devices assigned to edge (getEdgeDevices)

Returns a page of devices assigned to edge. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

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

get/api/edge/{edgeId}/devices

Path parameters

edgeIdstring required

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

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

deviceProfileIdstring

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

activeboolean

A boolean value representing the device active flag.

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)

startTimeinteger

Timestamp. Devices with creation time before it won't be queried

endTimeinteger

Timestamp. Devices with creation time after it won't be queried

Response

OK

totalPagesinteger

Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria

totalElementsinteger

Total number of elements in all available pages

hasNextboolean

'false' value indicates the end of the result set

Example response

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