RelynkLearn
Builder APIAPI referenceResource types

resourceTypes.list (version 1)

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.

POST
/resourceTypes.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
mainTypes?array<>

Only these main types

Items1 <= items

Response Body

The function output

application/json
  1. response
types*array<>
Example Request
curl -X POST 'https://ai.relynk.io/builder/v1/resourceTypes.list/v1' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "types": [    {      "typeKey": "string",      "name": "string",      "mainType": "string",      "typePath": "string",      "parentTypeKey": "string",      "count": 0    }  ]}