latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

tb-resource-controller

Get Resource Infos by ids (getSystemOrTenantResourcesByIds)

Returns a page of Resource Info objects owned by tenant or sysadmin. 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. Resource Info is a lightweight object that includes main information about the Resource excluding the heavyweight data.

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

get/api/resource

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

resourceType'LWM2M_MODEL' | 'JKS' | 'PKCS_12' | 'JS_MODULE'

A string value representing the resource type.

resourceSubType'EXTENSION' | 'MODULE'

A string value representing the resource sub-type.

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)

resourceIdsstring[] required

A list of resource ids, separated by comma ','

Response

OK

OR

Example response

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