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 asset-profile-controller API

Asset Profile

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

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

9 operations 8 paths 10 schemas 1 DELETE6 GET2 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 asset-profile-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 9

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

asset-profile-controller 9

Asset Profile

POST
/api/assetProfile
Create or Update Asset Profile (saveAssetProfile)
saveAssetProfile body → 200
POST
/api/assetProfile/{assetProfileId}/default
Make Asset Profile Default (setDefaultAssetProfile)
setDefaultAssetProfile 1 param → 200
GET
/api/assetProfiles
Get Asset Profiles (getAssetProfiles)
getAssetProfiles 5 params → 200
GET
/api/assetProfileInfos
Get Asset Profiles by Ids (getAssetProfilesByIds)
getAssetProfileInfos 6 params → 200
GET
/api/assetProfileInfo/{assetProfileId}
Get Asset Profile Info (getAssetProfileInfoById)
getAssetProfileInfoById 1 param → 200
GET
/api/assetProfileInfo/default
Get Default Asset Profile (getDefaultAssetProfileInfo)
getDefaultAssetProfileInfo → 200
GET
/api/assetProfile/{assetProfileId}
Get Asset Profile (getAssetProfileById)
getAssetProfileById 2 params → 200
DELETE
/api/assetProfile/{assetProfileId}
Delete Asset Profile (deleteAssetProfile)
deleteAssetProfile 1 param → 200
GET
/api/assetProfile/names
Get Asset Profile Names (getAssetProfileNames)
getAssetProfileNames 1 param → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AssetProfile (12 properties), AssetProfileInfo (5 properties), PageDataAssetProfileInfo (4 properties), PageDataAssetProfile (4 properties). Each schema is shown below with its type and property counts.

AssetProfile
object
A JSON value representing the asset profile.
12 properties
AssetProfileId
object
2 properties 2 required
PageDataAssetProfileInfo
object
4 properties
EntityInfo
object
2 properties
DashboardId
object
2 properties 2 required
PageDataAssetProfile
object
4 properties
RuleChainId
object
2 properties 2 required
TenantId
object
2 properties 2 required
EntityId
object
2 properties 2 required
AssetProfileInfo
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-asset-profile-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 audit-log-controller API
ThingsBoard auth-controller API
ThingsBoard calculated-field-controller API
ThingsBoard component-descriptor-controller API
ThingsBoard customer-controller API
ThingsBoard dashboard-controller API