THthingsboard
entity-relation-controller

Delete Relation (deleteRelationV2)

Deletes a relation between two entities in the platform.

If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer.

delete/api/v2/relation

Request

Query parameters

fromIdstring required

A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

fromTypestring required

A string value representing the entity type. For example, 'DEVICE'

relationTypestring required

A string value representing relation type between entities. For example, 'Contains', 'Manages'. It can be any string value.

relationTypeGroupstring

A string value representing relation type group. For example, 'COMMON'

toIdstring required

A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

toTypestring required

A string value representing the entity type. For example, 'DEVICE'

Response

OK

typestring required

String value of relation type.

typeGroup'COMMON' | 'DASHBOARD' | 'RULE_CHAIN' | 'RULE_NODE' | 'EDGE' | 'EDGE_AUTO_ASSIGN_RULE_CHAIN' required

Represents the type group of the relation.

versioninteger
additionalInfounknown

Example response

{
  "from": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "to": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "type": "Contains",
  "typeGroup": "COMMON",
  "additionalInfo": {}
}

Changes

No recorded changes to this operation across all 2 revisions of this API.