RErelynk
assets

Get all assets

Get all assets, these are the physical assets in the customer's environment like air handling units, chillers, radiators, dampers, etc.

get/assets

Request

  • Base URL
    https://api.relynk.io/v2.0.0
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Query parameters

customerIdstring uuid required

customer id context, id can be fetched from /customers endpoint

limitinteger

limit the number returned

offsetinteger

offset the returned list

order'asc' | 'desc'

order the returned list

sort'id' | 'name'

sort the returned list

namestring

filter by name

name__containsstring

filter by name contains

idstring uuid

filter by id

typestring

filter by category using brickschema/real estate core standard full uri.

subtypestring

filter by subtype using brickschema/real estate core standard full uri.

path__containsstring

filter by path contains space or asset id

includedByCollectionNamestring

filter by included by collection name

includedByCollectionName__containsstring

filter by included by collection name contains

includeOptionalFieldsstring[]

include optional fields that are not included in response by default, these match the keys in response object

Response

OK

customerIdstring uuid required

customer id

idstring uuid required

asset id

namestring required

asset name

descriptionstring nullable

asset description

subtypestring required

asset subtype using brickschema/real estate core standard full uri.

typestring required

asset subtype category using brickschema/real estate core standard full uri.

pathstring required

path to the asset using space and asset ids . seperated

mountedOnstring uuid nullable

asset mounted on

operationalStageCountstring nullable

operational stage count

assetTagstring nullable

asset tag

commissioningDatestring date-time nullable

commissioning date

identifiersobject nullable

asset identifiers

initialCoststring nullable
installationDatestring date-time nullable
ipAddressstring nullable

ip address

macAddressstring nullable

mac address

maintenanceIntervalstring nullable

maintenance interval

modelNumberstring nullable

model number

serialNumberstring nullable

serial number

turnoverDatestring date-time nullable

turnover date

weightstring nullable

weight

isVirtualMeterboolean nullable

is virtual meter

meterTypestring nullable

meter type

meteringMethodstring nullable

metering method, cummulative or instantaneous

meterSourceTypestring nullable

meter source type, i.e. solar, grid, etc.

meterUsageTypestring nullable

meter usage type, i.e. heating, fan, lighting, etc.

meteringDerivedFromPointIdstring uuid nullable

metering derived from point id

locatedInSpacesstring[] nullable

spaces the asset is located in

hasAssetPartsstring[] nullable

parts of the asset

isPartOfAssetsstring[] nullable

assets the asset is part of

hasPointIntegrationDataSourcesstring[]

point integration data sources

hasPointIdsstring[] nullable

point ids that measure the asset

feedsAssetsstring[] nullable

assets the asset feeds

feedsSpacesstring[] nullable

spaces the asset feeds

fedByAssetsstring[] nullable

assets that feed the asset

ownedByAgentsstring[] nullable

agents that own the asset

includedByCollectionsstring[] nullable

collections the asset is included in

isSubMeterOfAssetsstring[] nullable

assets the asset is a sub meter of

isMeterOfAssetsstring[] nullable

assets the asset is a meter of

metersAssetsstring[] nullable

assets the asset is metereing

meteredByAssetsstring[] nullable

assets the asset is metered by

metersSpacesstring[] nullable

spaces the asset is metering

metersAgentsstring[] nullable

agents the asset is metering

metersCollectionsstring[] nullable

collections the asset is metering

Changes

No recorded changes to this operation across all 1 revision of this API.