THthingsboard
entity-query-controller

Find Available Entity Keys by Query

Returns unique time series and/or attribute key names from entities matching the query.

Executes the Entity Data Query to find up to 100 entities, then fetches and aggregates all distinct key names.

Primarily used for UI features like autocomplete suggestions.

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

post/api/entitiesQuery/find/keys

Request

Query parameters

timeseriesboolean required

When true, includes unique time series key names in the response. When false, the 'timeseries' list will be empty.

attributesboolean required

When true, includes unique attribute key names in the response. When false, the 'attribute' list will be empty. Use 'scope' parameter to filter by attribute scope.

scope'SERVER_SCOPE' | 'SHARED_SCOPE' | 'CLIENT_SCOPE'

Filters attribute keys by scope. Only applies when 'attributes' is true. If not specified, returns attribute keys from all scopes.

Request body

Response

OK

entityTypesstring[] required

Set of entity types found among the matched entities.

timeseriesstring[] required
attributestring[] required

Example response

{
  "entityTypes": [
    "DEVICE",
    "ASSET"
  ],
  "timeseries": [
    "temperature"
  ],
  "attribute": [
    "serialNumber"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.