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

40169ccdec5c

asset-controller

Get Asset Info (getAssetInfoById)

Fetch the Asset Info object based on the provided Asset Id. If the user has the authority of 'Tenant Administrator', the server checks that the asset is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the asset is assigned to the same customer. Asset Info is an extension of the default Asset object that contains information about the assigned customer name.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/asset/info/{assetId}

Path parameters

assetIdstring required

A string value representing the asset id. For example, '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
customerTitlestring

Title of the Customer that owns the asset.

customerIsPublicboolean

Indicates special 'Public' Customer that is auto-generated to use the assets on public dashboards.

assetProfileNamestring

Name of the corresponding Asset Profile.

{"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": {}
}