Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThingsBoard entity-query-controller API

Entity Query

ThingsBoard entity-query-controller API is one of 58 APIs that ThingsBoard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 11 JSON Schema definitions.

Tagged areas include entity-query-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 54 schemas. It is described by OpenAPI 3.1.0, at version 4.3.0.3DEMO.

Requests are made against 2 base URLs: https://demo.thingsboard.io, http://localhost:8080.

7 operations 7 paths 54 schemas 1 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.3.0.3DEMO
Servers
https://demo.thingsboard.io
http://localhost:8080
Authentication
HTTP Loginpassword, API Key
License
Resource Areas
1

Authentication & Security 2

ThingsBoard entity-query-controller API declares 2 security schemes for authenticating requests. It uses HTTP loginpassword authentication (HTTP login form). An API key is passed in the header as X-Authorization (API key form).

  • HTTP login form — Enter Username / Password
  • API key form — Enter the API key value with 'ApiKey' prefix in format: ApiKey Example: ApiKey tb5te51SkLRYpjGrujUGwqkjFvooWBlQpVe2An2Dr3w13wjfxDW NOTE: Use only ONE authentic…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 1 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

entity-query-controller 7

Entity Query

POST
/api/entitiesQuery/find
Find Entity Data by Query
findEntityDataByQuery body → 200
POST
/api/entitiesQuery/find/keys
Find Available Entity Keys by Query
findAvailableEntityKeysByQuery 3 params body → 200
POST
/api/entitiesQuery/count
Count Entities by Query
countEntitiesByQuery body → 200
POST
/api/edqs/system/request
processSystemEdqsRequest body → 200
POST
/api/alarmsQuery/find
Find Alarms by Query
findAlarmDataByQuery body → 200
POST
/api/alarmsQuery/count
Count Alarms by Query (countAlarmsByQuery)
countAlarmsByQuery body → 200
GET
/api/edqs/state
getEdqsState → 200

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are AlarmData (28 properties), AlarmDataPageLink (13 properties), AlarmCountQuery (10 properties), AlarmDataQuery (6 properties). Each schema is shown below with its type and property counts.

NumericFilterPredicate
AlarmCountQuery
object
A JSON value representing the alarm count query.
10 properties
EntityViewTypeFilter
EdqsState
object
3 properties
PageDataAlarmData
object
4 properties
DynamicValueBoolean
object
4 properties
EntityKey
object
2 properties
EntityViewSearchQueryFilter
DeviceTypeFilter
AliasEntityId
object
3 properties 2 required
RelationsQueryFilter
AvailableEntityKeys
object
Contains unique time series and attribute key names discovered from entities matching a query. Used primarily for UI hints such as autocomplete suggestions.
3 properties 3 required
EntityNameFilter
CustomerId
object
2 properties 2 required
EntityId
object
2 properties 2 required
RelationEntityTypeFilter
object
3 properties
EntityTypeFilter
DynamicValueString
object
4 properties
EdgeTypeFilter
ComplexFilterPredicate
SingleEntityFilter
FilterPredicateValueString
object
3 properties
ComparisonTsValue
object
2 properties
AssetSearchQueryFilter
EntityData
object
4 properties
FilterPredicateValueDouble
object
3 properties
DynamicValueDouble
object
4 properties
EdqsSyncRequest
object
1 property
EntityDataQuery
object
Entity data query to find entities. Page size is capped at 100.
5 properties
AlarmDataQuery
object
A JSON value representing the alarm data query. See API call notes above for more details.
6 properties
EntityCountQuery
object
A JSON value representing the entity count query. See API call notes above for more details.
2 properties
EntityDataPageLink
object
5 properties
PageDataEntityData
object
4 properties
DeviceSearchQueryFilter
FilterPredicateValueBoolean
object
3 properties
KeyFilterPredicate
object
1 property 1 required
AlarmData
object
28 properties 7 required
AlarmDataPageLink
object
13 properties
AlarmId
object
2 properties 2 required
AssetTypeFilter
ToCoreEdqsRequest
object
2 properties
JsonNode
A value representing the any type (object or primitive)
ApiUsageStateFilter
StringFilterPredicate
KeyFilter
object
3 properties
EdgeSearchQueryFilter
EntityDataSortOrder
object
2 properties
BooleanFilterPredicate
AlarmAssignee
object
4 properties
EntityListFilter
EntityFilter
object
1 property 1 required
TenantId
object
2 properties 2 required
UserId
object
2 properties 2 required
TsValue
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-entity-query-controller-api-openapi.yml Raw ↑

Other APIs ThingsBoard publishes across the network.

ThingsBoard admin-controller API
ThingsBoard ai-model-controller API
ThingsBoard alarm-comment-controller API
ThingsBoard alarm-controller API
ThingsBoard api-key-controller API
ThingsBoard asset-controller API
ThingsBoard asset-profile-controller API
ThingsBoard audit-log-controller API
ThingsBoard auth-controller API
ThingsBoard calculated-field-controller API
ThingsBoard component-descriptor-controller API
ThingsBoard customer-controller API