export

bulk export of tenant resources

Returns a paginated flat list of resources for bulk sync or ETL. Only resources whose main type is one of Agent, Space, Asset, Collection, BuildingElement, or Point are included; integration and internal export types are omitted. Results are ordered by resource id. Use limit and offset to page through the full dataset (default page size 50 000, maximum 200 000).

get/export/resources

Request

Base URL
https://api.relynk.io/v2.0.0
Auth
- HTTP bearer
- or API key in header Authorization

Query parameters

customerIdstring uuid required

customer id context, id can be fetched from /customers endpoint

limitinteger

page size for bulk export endpoints

limit the number returned

offsetinteger

offset the returned list

idstring uuid

filter by resource id

namestring

filter by exact resource name

name__containsstring

filter by resource name contains (case-insensitive)

mainTypestring

filter by REC main type category, e.g. Point, Space, Asset, Collection, BuildingElement, Agent

rdfTypestring

filter by RDF type URI, e.g. https://brickschema.org/schema/Brick#Temperature_Sensor

partOfBuildingResourceIdstring uuid

filter by building resource id the resource belongs to

Response

paginated bulk export of resources

customerIdstring uuid required

customer id

idstring uuid required

resource id

namestring required

resource name

mainTypestring required

REC main type category (Agent, Space, Asset, Collection, BuildingElement, Point)

rdfTypestring required

RDF type URI for the resource

rdfUnitTypestring nullable

RDF unit type URI when the resource has a unit

partOfBuildingResourceIdstring uuid nullable

building resource id when applicable

updatedAtstring date-time required

last update timestamp

propsobject required

whitelisted resource properties. May include displayName, description, levelNumber, grossArea, netArea, rentableArea, maxOccupancy, seatingCapacity, identifiers, assetTag, ipAddress

Example response

[
  {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Meeting Room 1",
    "mainType": "Space",
    "rdfType": "https://w3id.org/rec#MeetingRoom",
    "rdfUnitType": null,
    "partOfBuildingResourceId": "a646a595-ead8-5380-a2d0-199564e8dba0",
    "updatedAt": "2024-01-01T00:00:00Z",
    "props": {
      "displayName": "Meeting Room 1",
      "levelNumber": 5
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.