RErelynk
export

bulk export of tenant relationships

Returns a paginated flat list of relationships for bulk sync or ETL. Only relationships where both source and destination resources are of an included main type (Agent, Space, Asset, Collection, BuildingElement, or Point) are returned. Results are ordered by relationship id. Use limit and offset to page through the full dataset (default page size 50 000, maximum 200 000).

get/export/relationships

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

rdfRelationshipTypestring

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

srcResourceIdstring uuid

filter by source resource id

dstResourceIdstring uuid

filter by destination resource id

srcResourceNamestring

filter by exact source resource name

srcResourceName__containsstring

filter by source resource name contains (case-insensitive)

dstResourceNamestring

filter by exact destination resource name

dstResourceName__containsstring

filter by destination resource name contains (case-insensitive)

Response

paginated bulk export of relationships

customerIdstring uuid required

customer id

srcResourceIdstring uuid required

source resource id

dstResourceIdstring uuid required

destination resource id

rdfRelationshipTypestring required

RDF relationship type URI

updatedAtstring date-time required

last update timestamp

Example response

[
  {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "srcResourceId": "26f748ab-e5cc-4e6a-8d94-75cfd759e1aa",
    "dstResourceId": "0eb8e6e5-9ba4-4a0b-bbb0-41162e01d13b",
    "rdfRelationshipType": "https://brickschema.org/schema/Brick#Has_Point",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
]

Changes

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