Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

entity-relation-controller

Find related entity infos (findInfoByQuery)

Returns all entity infos that are related to the specific entity. The entity id, relation type, entity types, depth of the search, and other query parameters defined using complex 'EntityRelationsQuery' object. See 'Model' tab of the Parameters for more info. Relation Info is an extension of the default Relation object that contains information about the 'from' and 'to' entity names.

post/api/relations/info

Request body

Example request

{
  "parameters": {
    "rootId": "784f394c-42b6-435a-983c-b7beff2784f9"
  },
  "filters": [
    {
      "relationType": "Contains"
    }
  ]
}

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
fromNamestring

Name of the entity for [from] direction.

toNamestring

Name of the entity for [to] direction.

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

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