Reference

• Asset
  • getGet all assets
  • getGet all asset roots
  • getGet asset by id
  • patchUpdate asset
  • delDelete asset
  • postCreate asset
  • postAdd drawing image to asset
• Asset Param
  • getGet All asset params
• Measurement Type
  • getGet all measurement types
• Webhooks
  • getGet all webhook congigurations
  • postCreate a webhook configuration
  • patchEdit a webhook configuration
  • delDelete a webhook configuration
• Unit Type
  • getGet all unit types
• Query
  • postQuery for sensor data

API docs by Redocly

Relynk API (1.0)

Download OpenAPI specification:Download

Relynk API

Asset

Get all assets

Get all assets like rooms, floors, buildings etc.

Authorizations:

api_keybearer

query Parameters

asNestedObject	boolean Default: true
assetType	string Enum: "Building" "Floor" "Area" "Room" "Desk" "Facade"

Responses

https://docs.relynk.io/asset/list

Response samples

• 200

Content type

application/json

[

• {

  • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  • "name": "sample_building_1",
  • "number": null,
  • "type": "Building",
  • "children": [ ],
  • "parent": { },
  • "asset_params": [ ],
  • "drawing_layers": [ ],
  • "drawing_image": { },
  • "sensors": [

    • {

      • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      • "external_id": "3f4e13d4-ede6-gde8-12d0-k1lde23v35p6",
      • "name": "sample_sensor_1",
      • "description": null,
      • "is_setpoint": true,
      • "linked_assets": [ ],
      • "integration": { }

      }

    ]

  }

]

Get all asset roots

Get all assets roots (i.e. the top level assets, usually buildings)

Authorizations:

api_keybearer

Responses

https://docs.relynk.io/asset/roots

Response samples

• 200

Content type

application/json

[

• {

  • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  • "name": "sample_building_1",
  • "number": null,
  • "type": "Building",
  • "children": [ ],
  • "parent": { },
  • "asset_params": [ ],
  • "drawing_layers": [ ],
  • "drawing_image": { },
  • "sensors": [

    • {

      • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      • "external_id": "3f4e13d4-ede6-gde8-12d0-k1lde23v35p6",
      • "name": "sample_sensor_1",
      • "description": null,
      • "is_setpoint": true,
      • "linked_assets": [ ],
      • "integration": { }

      }

    ]

  }

]

Get asset by id

Get assed by id

Authorizations:

api_keybearer

path Parameters

assetId required

string

query Parameters

include	Array of strings Items Enum: "direct_children" "all_children" "sensor" "drawing_image" "drawing_elements" "drawing_layers" "parameters"
childrenAssetType	string Enum: "Building" "Floor" "Area" "Room" "Desk" "Facade"
childrenAsNestedObject	boolean

Responses

https://docs.relynk.io/asset/{assetId}

Response samples

• 200

Content type

application/json

{

• "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
• "name": "sample_building_1",
• "number": null,
• "type": "Building",
• "children": [ ],
• "parent": { },
• "asset_params": [ ],
• "drawing_layers": [ ],
• "drawing_image": { },
• "sensors": [

  • {

    • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    • "external_id": "3f4e13d4-ede6-gde8-12d0-k1lde23v35p6",
    • "name": "sample_sensor_1",
    • "description": null,
    • "is_setpoint": true,
    • "linked_assets": [ ],
    • "integration": { }

    }

  ]

}

Update asset

Update asset based on asset id

Authorizations:

api_keybearer

path Parameters

assetId required

string

Request Body schema: application/json

name	string
number	string or null
type	string Enum: "Building" "Floor" "Area" "Room" "Desk" "Facade"
	Array of objects (AssetParam)

Responses

https://docs.relynk.io/asset/{assetId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "number": "string",
• "type": "Building",
• "asset_params": [

  • {

    • "name": "string",
    • "value": "string"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
• "name": "sample_building_1",
• "number": null,
• "type": "Building",
• "children": [ ],
• "parent": { },
• "asset_params": [ ],
• "drawing_layers": [ ],
• "drawing_image": { },
• "sensors": [

  • {

    • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    • "external_id": "3f4e13d4-ede6-gde8-12d0-k1lde23v35p6",
    • "name": "sample_sensor_1",
    • "description": null,
    • "is_setpoint": true,
    • "linked_assets": [ ],
    • "integration": { }

    }

  ]

}

Delete asset

Delete asset based on asset id

Authorizations:

api_keybearer

path Parameters

assetId required

string

Responses

https://docs.relynk.io/asset/{assetId}

Create asset

Create asset

Authorizations:

api_keybearer

Request Body schema: application/json

parent_id	string
name required	string
number	string or null
type required	string Enum: "Building" "Floor" "Area" "Room" "Desk" "Facade"
	Array of objects (AssetParam)

Responses

https://docs.relynk.io/asset

Request samples

• Payload

Content type

application/json

{

• "parent_id": "string",
• "name": "string",
• "number": "string",
• "type": "Building",
• "asset_params": [

  • {

    • "name": "string",
    • "value": "string"

    }

  ]

}

Response samples

• 201

Content type

application/json

{

• "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
• "name": "sample_building_1",
• "number": null,
• "type": "Building",
• "children": [ ],
• "parent": { },
• "asset_params": [ ],
• "drawing_layers": [ ],
• "drawing_image": { },
• "sensors": [

  • {

    • "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    • "external_id": "3f4e13d4-ede6-gde8-12d0-k1lde23v35p6",
    • "name": "sample_sensor_1",
    • "description": null,
    • "is_setpoint": true,
    • "linked_assets": [ ],
    • "integration": { }

    }

  ]

}

Add drawing image to asset

Add drawing image to asset based on asset id (this will override any existing drawing image). You still need to upload the image to AWS separately.

Authorizations:

api_keybearer

path Parameters

assetId required

string

Request Body schema: application/json

name required	string
type required	string Value: "Image"
key required	string

Responses

https://docs.relynk.io/asset/{assetId}/drawing-image

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "Image",
• "key": "string"

}

Response samples

• 201

Content type

application/json

{

• "id": "string",
• "name": "string",
• "type": "Image",
• "key": "string"

}

Asset Param

Get All asset params

Get All assets parameters

Authorizations:

api_keybearer

query Parameters

asset_id	string
name	string
value	string

Responses

https://docs.relynk.io/asset-param/list

Response samples

• 200

Content type

application/json

[

• {

  • "name": "string",
  • "value": "string"

  }

]

Measurement Type

Get all measurement types

Get all measurement types

Authorizations:

api_keybearer

Responses

https://docs.relynk.io/measurement-type/list

Response samples

• 200

Content type

application/json

{

• "measurement_types": [

  • "Temperature",
  • "RelativeHumidity",
  • "AirQuality",
  • "SoundLevel",
  • "Presence",
  • "PeopleCount",
  • "Booked",
  • "BatteryLevel",
  • "Light",
  • "SunScreenDown",
  • "AirFlow",
  • "AirPressure",
  • "FluidFlow",
  • "FluidPressure",
  • "WindDirection",
  • "WindSpeed",
  • "WindGustSpeed",
  • "PrecipitationRate",
  • "Power",
  • "Energy",
  • "EnergyReactive",
  • "Voltage",
  • "Current",
  • "Frequency",
  • "Efficiency",
  • "PowerFactor",
  • "Gain",
  • "Ratio",
  • "Weight",
  • "Waste_MixedPlastic",
  • "Waste_Cardboard",
  • "Waste_Unsorted",
  • "Waste_MixedWasteForSorting",
  • "Waste_Organic",
  • "Waste_ExpandedAndExtrudedPlastic",
  • "Waste_GlassAndMetal",
  • "Waste_EWaste",
  • "Waste_OfficePaper",
  • "CO2",
  • "WIFI_Connected_Clients"

  ]

}

Webhooks

Get all webhook congigurations

Get all webhook congigurations

Authorizations:

api_keybearer

Responses

https://docs.relynk.io/webhooks/list

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "endpoint": "string",
  • "method": [

    • "GET",
    • "POST",
    • "PUT",
    • "DELETE",
    • "PATCH",
    • "ALL",
    • "OPTIONS",
    • "HEAD",
    • 0,
    • 1,
    • 2,
    • 3,
    • 4,
    • 5,
    • 6,
    • 7

    ],
  • "headers": [

    • {

      • "id": 0,
      • "name": "string",
      • "value": "string"

      }

    ],
  • "customerId": "string",
  • "time": "2019-08-24T14:15:22Z"

  }

]

Create a webhook configuration

Create a webhook configuration

Authorizations:

api_keybearer

Request Body schema: application/json

id	string
name	string
endpoint required	string
method required	number Enum: 0 1 2 3 4 5 6 7
required	Array of objects (RequestHeader)
customerId	string
time	string <date-time>

Responses

https://docs.relynk.io/webhooks

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "name": "string",
• "endpoint": "string",
• "method": [

  • "GET",
  • "POST",
  • "PUT",
  • "DELETE",
  • "PATCH",
  • "ALL",
  • "OPTIONS",
  • "HEAD",
  • 0,
  • 1,
  • 2,
  • 3,
  • 4,
  • 5,
  • 6,
  • 7

  ],
• "headers": [

  • {

    • "id": 0,
    • "name": "string",
    • "value": "string"

    }

  ],
• "customerId": "string",
• "time": "2019-08-24T14:15:22Z"

}

Response samples

• 201

Content type

application/json

{

• "id": "string",
• "name": "string",
• "endpoint": "string",
• "method": [

  • "GET",
  • "POST",
  • "PUT",
  • "DELETE",
  • "PATCH",
  • "ALL",
  • "OPTIONS",
  • "HEAD",
  • 0,
  • 1,
  • 2,
  • 3,
  • 4,
  • 5,
  • 6,
  • 7

  ],
• "headers": [

  • {

    • "id": 0,
    • "name": "string",
    • "value": "string"

    }

  ],
• "customerId": "string",
• "time": "2019-08-24T14:15:22Z"

}

Edit a webhook configuration

Edit a webhook configuration

Authorizations:

api_keybearer

Request Body schema: application/json

id required	string
name	string
endpoint required	string
method required	number Enum: 0 1 2 3 4 5 6 7
required	Array of objects (RequestHeader)
customerId required	string
time	string <date-time>

Responses

https://docs.relynk.io/webhooks

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "name": "string",
• "endpoint": "string",
• "method": [

  • "GET",
  • "POST",
  • "PUT",
  • "DELETE",
  • "PATCH",
  • "ALL",
  • "OPTIONS",
  • "HEAD",
  • 0,
  • 1,
  • 2,
  • 3,
  • 4,
  • 5,
  • 6,
  • 7

  ],
• "headers": [

  • {

    • "id": 0,
    • "name": "string",
    • "value": "string"

    }

  ],
• "customerId": "string",
• "time": "2019-08-24T14:15:22Z"

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "endpoint": "string",
• "method": [

  • "GET",
  • "POST",
  • "PUT",
  • "DELETE",
  • "PATCH",
  • "ALL",
  • "OPTIONS",
  • "HEAD",
  • 0,
  • 1,
  • 2,
  • 3,
  • 4,
  • 5,
  • 6,
  • 7

  ],
• "headers": [

  • {

    • "id": 0,
    • "name": "string",
    • "value": "string"

    }

  ],
• "customerId": "string",
• "time": "2019-08-24T14:15:22Z"

}

Delete a webhook configuration

Delete a webhook configuration

Authorizations:

api_keybearer

path Parameters

webhookConfigId required

string

Responses

https://docs.relynk.io/webhooks/{webhookConfigId}

Response samples

• 200

Content type

application/json

true

Unit Type

Get all unit types

Get all unit types

Authorizations:

api_keybearer

Responses

https://docs.relynk.io/unit-type/list

Response samples

• 200

Content type

application/json

{

• "unit_types": [

  • "kilogram",
  • "dB",
  • "Percent",
  • "TVOC",
  • "Yes / No",
  • "Number",
  • "Celcius",
  • "Farenheit",
  • "Kelvin",
  • "Volt",
  • "Lux",
  • "PPM",
  • "PPB",
  • "m3",
  • "m3/s",
  • "m3/min",
  • "m3/h",
  • "m3/day",
  • "Degrees Angular",
  • "Farad",
  • "Herzt",
  • "Horsepower",
  • "Joul",
  • "MilliJoul",
  • "KiloJoul",
  • "Watt",
  • "MilliWatt",
  • "KiloWatt",
  • "MegaWatt",
  • "kWh",
  • "kWh_Reactive",
  • "Wh",
  • "Wh_Reactive",
  • "MWh",
  • "MWh_Reactive",
  • "Liter",
  • "l/s",
  • "l/min",
  • "l/h",
  • "Lumen",
  • "m/s",
  • "m/min",
  • "m/h",
  • "m/s2",
  • "MilliAmpere",
  • "Ampere",
  • "MilliVolt",
  • "Newton",
  • "NewtonMeter",
  • "NewtonSecond",
  • "Ohm",
  • "MilliOhm",
  • "KiloOhm",
  • "MegaOhm",
  • "Pa",
  • "%/s",
  • "pH",
  • "PowerFactor",
  • "Radian",
  • "Radian/s",
  • "RPM",
  • "Siemens",
  • "SquareMeter",
  • "m2/Newton",
  • "Tesla",
  • "Tonn",
  • "VoltAmpere",
  • "VoltAmpere_Reactive",
  • "VoltAmpereHour",
  • "VoltAmpereHour_Reactive"

  ]

}

Query

Query for sensor data

Query for sensor data with filters

Authorizations:

api_keybearer

Request Body schema: application/json

required	Array of objects (QueryFilter)
group_on	string Enum: "Desk" "Room" "Floor" "Area" "Building" "Facade" "Sensor" "None"
to	string <date-time>
from	string <date-time>
resolution required	string Enum: "raw" "30 minute" "1 hour" "1 day" "1 week" "1 month" "1 year"
is_timeseries required	boolean
only_latest_value required	boolean
limit	number
offset	number

Responses

https://docs.relynk.io/query

Request samples

• Payload

Content type

application/json

{

• "filters": [

  • {

    • "filter_on": "measurement",
    • "value": [

      • "Temperature"

      ]

    }

  ],
• "group_on": "Building",
• "to": "2020-01-01T00:00:00.000Z",
• "from": "2020-01-02T00:00:00.000Z",
• "resolution": "raw",
• "is_timeseries": true,
• "only_latest_value": true,
• "limit": 0,
• "offset": 0

}

Response samples

• 201

Content type

application/json

[

• {

  • "measurement_type": "Temperature",
  • "unit": "Celcius",
  • "group_asset_id": "",
  • "group_asset_name": "",
  • "group_asset_type": "Building",
  • "group_sensor_id": "",
  • "group_sensor_name": "",
  • "value": 24.5,
  • "average_value": 22.5,
  • "count_value": null,
  • "sum_value": null,
  • "min_value": 18.5,
  • "max_value": 24.7,
  • "date_time": "2019-08-24T14:15:22Z"

  }

]