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

40169ccdec5c

image-controller

get/api/images

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

imageSubType'IMAGE' | 'SCADA_SYMBOL'

A string value representing resource sub-type.

includeSystemImagesboolean

Use 'true' to include system images. Disabled by default. Ignored for requests by users with system administrator authority.

textSearchstring

The case insensitive 'substring' filter based on the resource title.

sortProperty'createdTime' | 'title' | 'resourceType' | 'tenantId'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

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": "TB_RESOURCE"
      },
      "createdTime": 1609459200000,
      "tenantId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "TENANT"
      },
      "title": "BinaryAppDataContainer id=19 v1.0",
      "resourceType": "LWM2M_MODEL",
      "resourceSubType": "IOT_SVG",
      "resourceKey": "19_1.0",
      "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4",
      "fileName": "19.xml",
      "descriptor": {}
    }
  ]
}