latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

asset-controller

Get Tenant Asset (getTenantAsset)

Requested asset must be owned by tenant that the user belongs to. Asset name is an unique property of asset. So it can be used to identify the asset.

Available for users with 'TENANT_ADMIN' authority.

get/api/tenant/assets

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

typestring

Asset type

textSearchstring

The case insensitive 'substring' filter based on the asset name.

sortProperty'createdTime' | 'name' | 'type' | 'label' | 'customerTitle'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

assetNamestring required

A string value representing the Asset name.

Response

OK

OR

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