RErelynk
points

get list of points

get list of points. points could be sensors, actuators, parameters, commands, setpoints or alarms

get/points

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

limit the number returned

offsetinteger

offset the returned list

order'asc' | 'desc'

order the returned list

sort'id' | 'name'

sort the returned list

namestring

filter by name

name__containsstring

filter by name contains

idstring uuid

filter by id

fromIntegrationIdstring

filter by from integration id

fromIntegrationNamestring

filter by from integration name

subtypestring

filter by subtype using brickschema/real estate core standard full uri.

hasUnitstring

filter by unit, using qudt/brickschema/real estate core standard full uri.

isPointOfAssetIdstring uuid

filter by is point of asset id

isPointOfAssetNamestring

filter by is point of asset name

isPointOfAssetName__containsstring

filter by is point of asset name contains

isPointOfSpaceIdstring uuid

filter by is point of space id

isPointOfSpaceNamestring

filter by is point of space name

isPointOfSpaceName__containsstring

filter by is point of space name contains

includeOptionalFieldsstring[]

include point fields that are not returned by defafault. these match the returned fields object keys that they will enable.

Response

get list of points available

customerIdstring uuid required

customer id that point belongs to

idstring uuid required

point id

namestring required

point name

fromIntegrationIdstring uuid required

integration id that point belongs to

fromIntegrationNamestring required

integration name that point belongs to

subtypestring required

using brickschema/real estate core standard full uri.

hasUnitstring nullable required

(not returned by default) using qudt/brickschema/real estate core standard full uri.

isPointOfAssetIdsstring[] nullable

(not returned by default) list of asset ids that the point is a point of

isPointOfSpaceIdsstring[] nullable

(not returned by default) list of space ids that the point is a point of

Example response

[
  {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "501 - temp sensor RT601",
    "fromIntegrationId": "123e4567-e89b-12d3-a456-426614174000",
    "fromIntegrationName": "bacnet",
    "subtype": "https://brickschema.org/schema/Brick#Temperature_Sensor",
    "hasUnit": "http://qudt.org/vocab/unit/DEG_C",
    "isPointOfAssetIds": null,
    "isPointOfSpaceIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

Changes

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