Relynk API (2.0.0_beta)

Download OpenAPI specification:Download

customers

Customer API

get list of customers that the user has access to

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Value: "name" sort the returned list
name	string filter by name
id	string <uuid> filter by id
name__contains	string filter by name contains

Responses

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]

points

Point API

get list of points

get list of points. points could be sensors, actuators, parameters, commands, setpoints or alarms

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
fromIntegrationId	string filter by from integration id
fromIntegrationName	string filter by from integration name
subtype	string Examples: subtype=https://brickschema.org/schema/Brick#Temperature_Sensor - temperature sensor subtype=https://brickschema.org/schema/Brick#Temperature_Setpoint - temperature setpoint subtype=https://brickschema.org/schema/Brick#Occupancy_Sensor - occupancy sensor subtype=https://brickschema.org/schema/Brick#CO2_Sensor - co2 sensor filter by subtype using brickschema/real estate core standard full uri.
hasUnit	string Examples: hasUnit=http://qudt.org/vocab/unit/DEG_C - degree celsius hasUnit=http://qudt.org/vocab/unit/KiloW-HR - kilo watt hours hasUnit=http://qudt.org/vocab/unit/PERCENT - percent hasUnit=http://qudt.org/vocab/unit/PPM - parts per million filter by unit, using qudt/brickschema/real estate core standard full uri.
isPointOfAssetId	string <uuid> filter by is point of asset id
isPointOfAssetName	string filter by is point of asset name
isPointOfAssetName__contains	string filter by is point of asset name contains
isPointOfSpaceId	string <uuid> filter by is point of space id
isPointOfSpaceName	string filter by is point of space name
isPointOfSpaceName__contains	string filter by is point of space name contains
includeOptionalFields	Array of strings Items Enum: "isPointOfAssetIds" "isPointOfSpaceIds" include point fields that are not returned by defafault. these match the returned fields object keys that they will enable.

Responses

Response samples

Content type

application/json

[{"customerId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "501 - temp sensor RT601",
"fromIntegrationId": "123e4567-e89b-12d3-a456-426614174000",
"fromIntegrationName": "bacnet",
"subtype": "https://brickschema.org/schema/Brick#Temperature_Sensor",
"hasUnit": "http://qudt.org/vocab/unit/DEG_C",
"isPointOfAssetIds": null,
"isPointOfSpaceIds": ["123e4567-e89b-12d3-a456-426614174000"
]
}
]

get list of points timeseries

get list of points timeseries, points could be sensors, actuators, parameters, commands, setpoints or alarms

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
from	string <date-time> from date time, when provided together with parameter "to", the timespan must not exceed 6 months
to	string <date-time> to date time, when provided together with parameter "from", the timespan must not exceed 6 months
limit	integer [ 1 .. 2000 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Value: "timestamp" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
fromIntegrationId	string filter by from integration id
fromIntegrationName	string filter by from integration name
subtype	string Examples: subtype=https://brickschema.org/schema/Brick#Temperature_Sensor - temperature sensor subtype=https://brickschema.org/schema/Brick#Temperature_Setpoint - temperature setpoint subtype=https://brickschema.org/schema/Brick#Occupancy_Sensor - occupancy sensor subtype=https://brickschema.org/schema/Brick#CO2_Sensor - co2 sensor filter by subtype using brickschema/real estate core standard full uri.
hasUnit	string Examples: hasUnit=http://qudt.org/vocab/unit/DEG_C - degree celsius hasUnit=http://qudt.org/vocab/unit/KiloW-HR - kilo watt hours filter by unit
isPointOfAssetId	string <uuid> filter by is point of asset id
isPointOfAssetName	string filter by is point of asset name
isPointOfAssetName__contains	string filter by is point of asset name contains
isPointOfSpaceId	string <uuid> filter by is point of space id
isPointOfSpaceName	string filter by is point of space name
isPointOfSpaceName__contains	string filter by is point of space name contains
includeOptionalFields	Array of strings Items Enum: "hasUnit" "name" "subtype" include point value fields that are not returned by defafault. these match the returned fields object keys that they will enable.

Responses

Response samples

Content type

application/json

[{"customerId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2021-01-01T00:00:00Z",
"name": "501 - temp sensor RT601",
"value": 20,
"hasUnit": "http://qudt.org/vocab/unit/DEG_C",
"subtype": "https://brickschema.org/schema/Brick#Temperature_Sensor"
}
]

get list of points latest values

get list of points latest values, points could be sensors, actuators, parameters, commands, setpoints or alarms

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" "value" "timestamp" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
fromIntegrationId	string filter by from integration id
fromIntegrationName	string filter by from integration name
subtype	string Examples: subtype=https://brickschema.org/schema/Brick#Temperature_Sensor - temperature sensor subtype=https://brickschema.org/schema/Brick#Temperature_Setpoint - temperature setpoint subtype=https://brickschema.org/schema/Brick#Occupancy_Sensor - occupancy sensor subtype=https://brickschema.org/schema/Brick#CO2_Sensor - co2 sensor filter by subtype using brickschema/real estate core standard full uri.
hasUnit	string Examples: hasUnit=http://qudt.org/vocab/unit/DEG_C - degree celsius hasUnit=http://qudt.org/vocab/unit/KiloW-HR - kilo watt hours filter by unit, using qudt/brickschema/real estate core standard full uri.
isPointOfAssetId	string <uuid> filter by is point of asset id
isPointOfAssetName	string filter by is point of asset name
isPointOfAssetName__contains	string filter by is point of asset name contains
isPointOfSpaceId	string <uuid> filter by is point of space id
isPointOfSpaceName	string filter by is point of space name
isPointOfSpaceName__contains	string filter by is point of space name contains
includeOptionalFields	Array of strings Items Enum: "hasUnit" "name" "subtype" include point value fields that are not returned by defafault. these match the returned fields object keys that they will enable.

Responses

Response samples

Content type

application/json

[{"customerId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "501 - temp sensor RT601",
"timestamp": "2021-01-01T00:00:00Z",
"value": 20,
"hasUnit": "http://qudt.org/vocab/unit/DEG_C",
"subtype": "https://brickschema.org/schema/Brick#Temperature_Sensor"
}
]

spaces

Space API

get list of spaces

get list of spaces, these include rooms, floors/levels, buildings, etc.

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
displayName	string filter by display name
displayName__contains	string filter by display name contains
id	string <uuid> filter by id
type	string Examples: type=https://w3id.org/rec#Room - Room type=https://w3id.org/rec#Level - Level / Floor type=https://w3id.org/rec#Building - Building filter by category using brickschema/real estate core standard full uri.
subtype	string Examples: subtype=https://w3id.org/rec#Room - Room subtype=https://w3id.org/rec#MeetingRoom - Meeting Room subtype=https://w3id.org/rec#Office - Office filter by subtype using brickschema/real estate core standard full uri.
levelNumber	integer filter by level number
isPartOfSpaceId	string <uuid> filter by is part of space id
path__contains	string filter by path contains space ids . seperated
includeOptionalFields	Array of strings Items Enum: "hasPartSpaceIds" "isLocationOfAssetIds" "isLocationOfBuildingElementIds" "hasGeometryIds" "hasFileIds" "hasPointIds" "isFedByAssetIds" "isOwnedByAgentIds" "includedByCollectionIds" "meteredByAssetIds" include optional fields

Responses

Response samples

Content type

application/json

[{"customerId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Meeting Room 1",
"path": "a646a595-ead8-5380-a2d0-199564e8dba0.123e4567-e89b-12d3-a456-426614174000",
"subtype": "https://w3id.org/rec#MeetingRoom",
"type": "https://w3id.org/rec#Room",
"isPartOfSpaceId": "a646a595-ead8-5380-a2d0-199564e8dba0",
"identifiers": { }
}
]

get latest status of spaces

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
displayName	string filter by display name
displayName__contains	string filter by display name contains
id	string <uuid> filter by id
type	string Examples: type=https://w3id.org/rec#Room - Room type=https://w3id.org/rec#Level - Level / Floor filter by type using brickschema/real estate core standard full uri.
subtype	string Examples: subtype=https://w3id.org/rec#Room - Room subtype=https://w3id.org/rec#MeetingRoom - Meeting Room subtype=https://w3id.org/rec#Office - Office filter by subtype using brickschema/real estate core standard full uri.
levelNumber	integer filter by level number
isPartOfSpaceId	string <uuid> filter by is part of space id
path__contains	string filter by path contains
includeOptionalFields	Array of strings Items Enum: "name" "displayName" "occupancy" "occupancyCount" "temperature" "humidity" "co2" "todaysBookingEvents" include status fields

Responses

Response samples

Content type

application/json

[{"customerId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Meeting Room 1",
"occupancy": 1,
"occupancyUnit": "http://qudt.org/vocab/unit/UNITLESS",
"occupancyCount": 10,
"occupancyCountUnit": "http://qudt.org/vocab/unit/UNITLESS",
"temperature": 20,
"temperatureUnit": "http://qudt.org/vocab/unit/DEG_C",
"co2": 400,
"co2Unit": "http://qudt.org/vocab/unit/PPM"
}
]

assets

Asset API

Get all assets

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

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
type	string Examples: type=https://brickschema.org/schema/Brick#Equipment - Equipment type=https://brickschema.org/schema/Brick#Furniture - Furniture filter by category using brickschema/real estate core standard full uri.
subtype	string Examples: subtype=https://brickschema.org/schema/Brick#Air_Handling_Unit - Air Handling Unit subtype=https://brickschema.org/schema/Brick#Damper - Damper filter by subtype using brickschema/real estate core standard full uri.
path__contains	string filter by path contains space or asset id
includedByCollectionName	string filter by included by collection name
includedByCollectionName__contains	string filter by included by collection name contains
includeOptionalFields	Array of strings Items Enum: "locatedInSpaces" "hasAssetParts" "isPartOfAssets" "hasPointIntegrationDataSources" "hasPointIds" "feedsAssets" "feedsSpaces" "fedByAssets" "ownedByAgents" "includedByCollections" "isSubMeterOfAssets" "isMeterOfAssets" "metersAssets" "meteredByAssets" "metersSpaces" "metersAgents" "metersCollections" include optional fields that are not included in response by default, these match the keys in response object

Responses

Response samples

Content type

application/json

[{"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"subtype": "string",
"type": "string",
"path": "string",
"mountedOn": "6e8be901-98bd-4913-80ea-e466ac959c9b",
"operationalStageCount": "string",
"assetTag": "string",
"commissioningDate": "2019-08-24T14:15:22Z",
"identifiers": { },
"initialCost": "string",
"installationDate": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"macAddress": "string",
"maintenanceInterval": "string",
"modelNumber": "string",
"serialNumber": "string",
"turnoverDate": "2019-08-24T14:15:22Z",
"weight": "string",
"isVirtualMeter": true,
"meterType": "string",
"meteringMethod": "string",
"meterSourceType": "string",
"meterUsageType": "string",
"meteringDerivedFromPointId": "8243f474-583d-4c7a-bd79-77a4929dfdf2",
"locatedInSpaces": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"hasAssetParts": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isPartOfAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"hasPointIntegrationDataSources": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"hasPointIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"feedsAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"feedsSpaces": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"fedByAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"ownedByAgents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"includedByCollections": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isSubMeterOfAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isMeterOfAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metersAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"meteredByAssets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metersSpaces": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metersAgents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metersCollections": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]

collections

Collection API

get list of collections

get list of collections, these can include collections of assets, spaces, building elements, etc.

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> customer id context, id can be fetched from /customers endpoint
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
subtype	string filter by subtype
includeOptionalFields	Array of strings Items Enum: "includesAssetIds" "includesSpaceIds" "includesBuildingElementIds" "isOwnedByAgentIds" "isMeteredByAssetIds" include optional fields

Responses

Response samples

Content type

application/json

[{"customerId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Building 1 Assets",
"subtype": "AssetCollection",
"identifiers": { },
"totalGrossArea": 1000.5,
"totalNetArea": 800.3,
"totalRentableArea": 900.1
}
]