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

Entity View

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

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

17 operations 14 paths 14 schemas 3 DELETE9 GET5 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-view-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 17

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

entity-view-controller 17

Entity View

GET
/api/entityViews
Get Entity Views by Ids (getEntityViewsByIds)
getEntityViewsByIds 1 param → 200
POST
/api/entityViews
Find Related Entity Views (findByQuery)
findByQuery_1 body → 200
POST
/api/entityView
Save or Update Entity View (saveEntityView)
saveEntityView 3 params body → 200
POST
/api/edge/{edgeId}/entityView/{entityViewId}
Assign Entity View to Edge (assignEntityViewToEdge)
assignEntityViewToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/entityView/{entityViewId}
Unassign Entity View from Edge (unassignEntityViewFromEdge)
unassignEntityViewFromEdge 2 params → 200
POST
/api/customer/{customerId}/entityView/{entityViewId}
Assign Entity View to Customer (assignEntityViewToCustomer)
assignEntityViewToCustomer 2 params → 200
POST
/api/customer/public/entityView/{entityViewId}
Make Entity View Publicly Available (assignEntityViewToPublicCustomer)
assignEntityViewToPublicCustomer 1 param → 200
GET
/api/tenant/entityViews
Get Entity View by Name (getTenantEntityView)
getTenantEntityViews 7 params → 200
GET
/api/tenant/entityViewInfos
Get Tenant Entity Views (getTenantEntityViews)
getTenantEntityViewInfos 6 params → 200
GET
/api/entityView/{entityViewId}
Get Entity View (getEntityViewById)
getEntityViewById 1 param → 200
DELETE
/api/entityView/{entityViewId}
Delete Entity View (deleteEntityView)
deleteEntityView 1 param → 200
GET
/api/entityView/types
Get Entity View Types (getEntityViewTypes)
getEntityViewTypes → 200
GET
/api/entityView/info/{entityViewId}
Get Entity View Info (getEntityViewInfoById)
getEntityViewInfoById 1 param → 200
GET
/api/edge/{edgeId}/entityViews
getEdgeEntityViews 9 params → 200
GET
/api/customer/{customerId}/entityViews
Get Customer Entity Views (getCustomerEntityViews)
getCustomerEntityViews 7 params → 200
GET
/api/customer/{customerId}/entityViewInfos
Get Customer Entity View Info (getCustomerEntityViewInfos)
getCustomerEntityViewInfos 7 params → 200
DELETE
/api/customer/entityView/{entityViewId}
Unassign Entity View from Customer (unassignEntityViewFromCustomer)
unassignEntityViewFromCustomer 1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EntityViewInfo (14 properties), EntityView (12 properties), RelationsSearchParameters (6 properties), PageDataEntityViewInfo (4 properties). Each schema is shown below with its type and property counts.

EntityViewSearchQuery
object
The entity view search query JSON
3 properties
PageDataEntityViewInfo
object
4 properties
PageDataEntityView
object
4 properties
JsonNode
A value representing the any type (object or primitive)
EntityView
object
A JSON object representing the entity view.
12 properties 3 required
AttributesEntityView
object
3 properties 3 required
RelationsSearchParameters
object
6 properties
EntityViewId
object
2 properties 2 required
EntitySubtype
object
3 properties
TenantId
object
2 properties 2 required
CustomerId
object
2 properties 2 required
EntityViewInfo
object
14 properties 3 required
EntityId
object
2 properties 2 required
TelemetryEntityView
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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