resourceTypes.relationships (version 1)
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.
bearerAuthorizationBearer <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.
tenantId?stringThe tenant to read. May be left out when the caller belongs to exactly one tenant; GET /me lists them.
uuidapplication/json- body
buildingId*stringA building id (from buildings.list). Matches the building itself and everything that is part of it
^([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)$uuidThe function output
application/json- response
relationships*array<>curl -X POST 'https://ai.relynk.io/builder/v1/resourceTypes.relationships/v1' \ -H 'Content-Type: application/json' \ -d '{ "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7"}'{ "relationships": [ { "fromTypeKey": "string", "relationship": "string", "name": "string", "inverseName": "string", "toTypeKey": "string", "count": 0 } ]}resourceTypes.list (version 1) POST
The REC/Brick types the tenant actually uses, with how many resources of each type, e.g. to find the type keys of rooms, air handling units or temperature sensors before filtering other functions by them.
resources.list (version 1) POST
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.