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 calculated-field-controller API

Calculated Field

ThingsBoard calculated-field-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 calculated-field-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.

This API exposes 8 operations across 7 paths, and defines 28 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.

8 operations 7 paths 28 schemas 1 DELETE5 GET2 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 calculated-field-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 8

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

calculated-field-controller 8

Calculated Field

POST
/api/calculatedField
Create or Update Calculated Field (saveCalculatedField)
saveCalculatedField body → 200
POST
/api/calculatedField/testScript
Test Script Expression
testScript_1 body → 200
GET
/api/{entityType}/{entityId}/calculatedFields
Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityId)
getCalculatedFieldsByEntityId 8 params → 200
GET
/api/calculatedFields
Get Calculated Fields (getCalculatedFields)
getCalculatedFields 10 params → 200
GET
/api/calculatedFields/names
Get Calculated Field Names (getCalculatedFieldNames)
getCalculatedFieldNames 5 params → 200
GET
/api/calculatedField/{calculatedFieldId}
Get Calculated Field (getCalculatedFieldById)
getCalculatedFieldById 1 param → 200
DELETE
/api/calculatedField/{calculatedFieldId}
Delete Calculated Field (deleteCalculatedField)
deleteCalculatedField 1 param → 200
GET
/api/calculatedField/{calculatedFieldId}/debug
Get Latest Calculated Field Debug Event (getLatestCalculatedFieldDebugEvent)
getLatestCalculatedFieldDebugEvent 1 param → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are CalculatedFieldInfo (12 properties), CalculatedField (11 properties), Argument (6 properties), Output (5 properties). Each schema is shown below with its type and property counts.

PageDataString
object
4 properties
AttributesOutputStrategy
object
1 property 1 required
MultiValueMapStringString
object
1 property
PageDataCalculatedFieldInfo
object
4 properties
SimpleCalculatedFieldConfiguration
object
4 properties 2 required
AttributesOutput
Argument
object
6 properties
TimeSeriesOutputStrategy
object
1 property 1 required
CfArgumentDynamicSourceConfiguration
object
1 property 1 required
RelationPathLevel
object
2 properties 2 required
RelationPathQueryDynamicSourceConfiguration
TimeSeriesRuleChainOutputStrategy
OutputStrategy
TenantId
object
2 properties 2 required
PageDataCalculatedField
object
4 properties
AttributesRuleChainOutputStrategy
TimeSeriesImmediateOutputStrategy
CurrentOwnerDynamicSourceConfiguration
EntityId
object
2 properties 2 required
CalculatedField
object
11 properties 1 required
JsonNode
A value representing the any type (object or primitive)
CalculatedFieldInfo
object
12 properties 1 required
TimeSeriesOutput
AttributesImmediateOutputStrategy
DebugSettings
object
3 properties
Output
object
5 properties 1 required
ReferencedEntityKey
object
3 properties
CalculatedFieldId
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-calculated-field-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 component-descriptor-controller API
ThingsBoard customer-controller API
ThingsBoard dashboard-controller API
Where this information came from

This is an independent, third-party profile of ThingsBoard calculated-field-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.