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-relation-controller API

Entity Relation

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

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

10 operations 4 paths 7 schemas 3 DELETE3 GET4 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-relation-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 10

Across 4 paths, the API surfaces 10 operations — 3 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

entity-relation-controller 10

Entity Relation

POST
/api/v2/relation
Create Relation (saveRelationV2)
saveRelationV2 body → 200
DELETE
/api/v2/relation
Delete Relation (deleteRelationV2)
deleteRelationV2 6 params → 200
GET
/api/relations
Get List of Relations (findByFrom)
findByTo 6 params → 200
POST
/api/relations
Find Related Entities (findByQuery)
findByQuery body → 200
DELETE
/api/relations
Delete Common Relations (deleteCommonRelations)
deleteRelations 2 params → 200
GET
/api/relations/info
Get List of Relation Infos (findInfoByFrom)
findInfoByTo 5 params → 200
POST
/api/relations/info
Find Related Entity Infos (findInfoByQuery)
findInfoByQuery body → 200
GET
/api/relation
Get Relation (getRelation)
getRelation 6 params → 200
POST
/api/relation
Create Relation (saveRelation)
saveRelation body → 200
DELETE
/api/relation
Delete Relation (deleteRelation)
deleteRelation 6 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are EntityRelationInfo (8 properties), RelationsSearchParameters (6 properties), EntityRelation (6 properties), RelationEntityTypeFilter (3 properties). Each schema is shown below with its type and property counts.

JsonNode
A value representing the any type (object or primitive)
EntityRelationInfo
object
8 properties 4 required
EntityRelationsQuery
object
A JSON value representing the entity relations query object.
2 properties
EntityRelation
object
A JSON value representing the relation.
6 properties 4 required
RelationsSearchParameters
object
6 properties
EntityId
object
2 properties 2 required
RelationEntityTypeFilter
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-entity-relation-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