ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Relation → By To

AI-generated

Summary

Retrieves a list of relation objects where the specified entity is the target (to) of the relation.

Inputs

  • authentication — Method of authentication (API Key or Username/Password).
  • toId (required) — A string value representing the entity ID to find relations for. For example, '784f394c-42b6-435a-983c-b7beff2784f9'.
  • toType (required) — A string value representing the entity type of the target entity. For example, 'DEVICE'.
  • relationType — A string value representing the relation type to filter by. Required for 'By To (with Relation Type)'.

Output shape

a list of relation objects

Returns relations based on the 'COMMON' relation type group. Filtering by 'relationType' is optional.

Examples

Example 1: Fetch all relations pointing to a specific device.

Resource: Relation, Operation: By To; toId: 'device-id-123', toType: 'DEVICE'

Example 2: Fetch relations pointing to a customer with a specific relation type.

Resource: Relation, Operation: By To; toId: 'customer-id-456', toType: 'CUSTOMER', relationType: 'DEFAULT'

Links

Discussion