ThingsBoard · Schema
ThingsBoard EntityRelation
A JSON value representing the relation.
IoTInternet of ThingsDevice ManagementTelemetryOpen SourceApache 2.0MQTTLwM2MCoAPRule EngineDashboardsEdgeMulti-tenantJavaSpring
Properties
| Name | Type | Description |
|---|---|---|
| from | object | JSON object with [from] Entity Id. |
| to | object | JSON object with [to] Entity Id. |
| type | string | String value of relation type. |
| typeGroup | string | Represents the type group of the relation. |
| version | integer | |
| additionalInfo | object | Additional parameters of the relation |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-entityrelation-schema.json",
"title": "ThingsBoard EntityRelation",
"description": "A JSON value representing the relation.",
"type": "object",
"properties": {
"from": {
"$ref": "#/components/schemas/EntityId",
"description": "JSON object with [from] Entity Id."
},
"to": {
"$ref": "#/components/schemas/EntityId",
"description": "JSON object with [to] Entity Id."
},
"type": {
"type": "string",
"description": "String value of relation type.",
"example": "Contains",
"minLength": 1
},
"typeGroup": {
"type": "string",
"description": "Represents the type group of the relation.",
"enum": [
"COMMON",
"DASHBOARD",
"RULE_CHAIN",
"RULE_NODE",
"EDGE",
"EDGE_AUTO_ASSIGN_RULE_CHAIN"
],
"example": "COMMON"
},
"version": {
"type": "integer",
"format": "int64"
},
"additionalInfo": {
"$ref": "#/components/schemas/JsonNode",
"description": "Additional parameters of the relation"
}
},
"required": [
"from",
"to",
"type",
"typeGroup"
]
}