RelynkLearn
Builder APIConcepts

The data model

How Relynk describes a building - resources, type keys, points and relationships - in plain language.

Relynk describes each building as a set of things and how they are connected.

  • A tenant is one organisation in Relynk, such as a property company. Every call reads one tenant (see Choose a tenant).
  • A resource is any thing in a building: the building itself, a level, a room, a piece of equipment, a meter or a sensor. See Resources and points.
  • A type key says what kind of resource it is, such as rec_Room or brick_Air_Handling_Unit. The names come from two open standards for buildings, REC (RealEstateCore) and Brick.
  • A point is a resource that carries readings: a temperature sensor, a setpoint, a meter reading. Points have a time series of values.
  • A relationship connects two resources: a room is part of a level, an air handling unit feeds a room. See Relationships.
  • EOS is Relynk's processed energy, water and waste consumption, kept apart from raw readings. See Energy data.
Building (rec_Building)
└─ Level (rec_Level)
   └─ Room (rec_Room)
      └─ Temperature sensor (brick_Temperature_Sensor)  →  readings over time

Times are always Oslo time (see Time), and long lists come in pages (see Paging and limits).