RelynkLearn
Builder APIAPI referenceResources

resources.list (version 1)

Resources (buildings, levels, rooms, equipment, points, …) filtered by building, type, name or id. Pages by id: pass nextCursor back until it is null. For the points of equipment or rooms use points.list; for connected resources use resources.related.

POST
/resources.list/v1

Authorization

bearer
headerAuthorizationBearer <JWT>

A signed-in Relynk user's access token: OAuth 2.0 authorization code with PKCE at https://auth.relynk.io/authorize and https://auth.relynk.io/oauth/token, with audience https://ai.relynk.io/builder. The caller sees exactly what that user may see.

Query Parameters

tenantId?string

The tenant to read. May be left out when the caller belongs to exactly one tenant; GET /me lists them.

Formatuuid

Request Body

application/json
  1. body
buildingId?string

A building id (from buildings.list). Matches the building itself and everything that is part of it

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
typeKeys?array<>

Only these types and their subtypes, e.g. ["rec_Room"] (keys from resourceTypes.list)

Items1 <= items <= 100
mainTypes?array<>

Only these main types

Items1 <= items
ids?array<>

Only these resources

Items1 <= items <= 1000
search?string

Only names containing this text, ignoring case

Length1 <= length <= 200
limit?integer
Range1 <= value <= 1000
Default200
cursor?string

nextCursor from the previous page; omit for the first page

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The function output

application/json
  1. response
resources*array<>
Itemsitems <= 1000
nextCursor*|

Pass as cursor for the next page; null on the last

Example Request
curl -X POST 'https://ai.relynk.io/builder/v1/resources.list/v1' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "resources": [    {      "id": "string",      "name": "string",      "typeKey": "string",      "typeName": "string",      "mainType": "string",      "buildingId": "string"    }  ],  "nextCursor": "string"}

resourceTypes.relationships (version 1) POST

How types are connected in one building: which relationships exist between which types, and how often. Use it to plan a walk with resources.related, e.g. brick_Has_Part from the building to levels to rooms, or brick_Feeds from an air handling unit to the rooms it serves.

resources.related (version 1) POST

Resources connected to the given ones by one relationship, following it up to maxDepth steps. One row per (fromId, related resource) at its shortest depth. Common relationships: brick_Has_Part (building → levels → rooms; "in" = Is Part Of), brick_Feeds (air handling unit → terminal units → rooms; "in" = Is Fed By), brick_Has_Sub_Meter, brick_Is_Metered_By, rec_Located_In, relynk_Virtual_Meter_Calculated_From. resourceTypes.relationships shows which ones a building uses. For points use points.list with resourceIds.