How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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.

UserId
object
2 properties 2 required
KeyFilter
object
3 properties
EntityViewTypeFilter
AlarmAssignee
object
4 properties
PageDataAlarmData
object
4 properties
BooleanFilterPredicate
DynamicValueBoolean
object
4 properties
DeviceSearchQueryFilter
EdqsSyncRequest
object
1 property
AlarmData
object
28 properties 7 required
FilterPredicateValueString
object
3 properties
EntityDataSortOrder
object
2 properties
ComplexFilterPredicate
AliasEntityId
object
3 properties 2 required
EntityViewSearchQueryFilter
EntityKey
object
2 properties
EntityListFilter
EntityNameFilter
EntityDataQuery
object
Entity data query to find entities. Page size is capped at 100.
5 properties
EntityData
object
4 properties
AssetSearchQueryFilter
AlarmCountQuery
object
A JSON value representing the alarm count query.
10 properties
RelationsQueryFilter
DynamicValueString
object
4 properties
DynamicValueDouble
object
4 properties
EntityFilter
object
1 property 1 required
TenantId
object
2 properties 2 required
AlarmDataQuery
object
A JSON value representing the alarm data query. See API call notes above for more details.
6 properties
RelationEntityTypeFilter
object
3 properties
SingleEntityFilter
FilterPredicateValueDouble
object
3 properties
TsValue
object
3 properties
CustomerId
object
2 properties 2 required
EntityCountQuery
object
A JSON value representing the entity count query. See API call notes above for more details.
2 properties
EntityTypeFilter
EdqsState
object
3 properties
NumericFilterPredicate
EntityId
object
2 properties 2 required
StringFilterPredicate
AlarmDataPageLink
object
13 properties
ComparisonTsValue
object
2 properties
ToCoreEdqsRequest
object
2 properties
FilterPredicateValueBoolean
object
3 properties
PageDataEntityData
object
4 properties
EntityDataPageLink
object
5 properties
EdgeTypeFilter
JsonNode
A value representing the any type (object or primitive)
ApiUsageStateFilter
EdgeSearchQueryFilter
AssetTypeFilter
AlarmId
object
2 properties 2 required
KeyFilterPredicate
object
1 property 1 required
DeviceTypeFilter
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

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
Where this information came from

This is an independent, third-party profile of ThingsBoard entity-query-controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.