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

40169ccdec5c

asset-controller

Find related assets (findByQuery)

Returns all assets that are related to the specific entity. The entity id, relation type, asset types, depth of the search, and other query parameters defined using complex 'AssetSearchQuery' object. See 'Model' tab of the Parameters for more info.

post/api/assets

Request body

relationTypestring

Type of the relation between root entity and asset (e.g. 'Contains' or 'Manages').

assetTypesstring[]

Array of asset types to filter the related entities (e.g. 'Building', 'Vehicle').

Example request

{
  "parameters": {
    "rootId": "784f394c-42b6-435a-983c-b7beff2784f9"
  }
}

Response

OK

createdTimeinteger

Timestamp of the asset creation, in milliseconds

namestring required

Unique Asset Name in scope of Tenant

typestring

Asset type

labelstring

Label that may be used in widgets

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

Example response

[
  {
    "id": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "ASSET"
    },
    "createdTime": 1609459200000,
    "tenantId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "TENANT"
    },
    "customerId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "CUSTOMER"
    },
    "name": "Empire State Building",
    "type": "Building",
    "label": "NY Building",
    "assetProfileId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "ASSET_PROFILE"
    },
    "additionalInfo": {}
  }
]