API Reference

• Query
  • postQuery for point data

API docs by Redocly

Relynk Query API (2.0.0)

Download OpenAPI specification:Download

Query

Query for point data

Query for point data with filters

Authorizations:

NoneNone

Request Body schema: application/json

required	Array of objects (QueryFilter)
group_on	string Enum: "https://w3id.org/rec#Desk" "https://w3id.org/rec#Room" "https://w3id.org/rec#Level" "https://w3id.org/rec#Zone" "https://w3id.org/rec#Building" "https://w3id.org/rec#Facade" "https://brickschema.org/schema/Brick#Point" "None"
to	string <date-time>
from	string <date-time>
resolution required	string Enum: "raw" "30 minute" "1 hour" "1 day" "1 week" "1 month" "1 year"
is_timeseries required	boolean
only_latest_value required	boolean
limit	number
offset	number

Responses

https://api.relynk.io/v2.0.0/query

Request samples

• Payload

Content type

application/json

{

• "filters": [

  • {

    • "filter_on": "point_subtype",
    • "value": [

      • "https://brickschema.org/schema/Brick#Air_Temperature_Sensor"

      ]

    }

  ],
• "group_on": "https://w3id.org/rec#Building",
• "to": "2020-01-01T00:00:00.000Z",
• "from": "2020-01-02T00:00:00.000Z",
• "resolution": "raw",
• "is_timeseries": true,
• "only_latest_value": true,
• "limit": 0,
• "offset": 0

}

Response samples

• 200

Content type

application/json

[

• {

  • "point_subtype": "https://brickschema.org/schema/Brick#Air_Temperature_Sensor",
  • "unit_type": "http://qudt.org/vocab/unit/DEG_C",
  • "group_resource_id": "string",
  • "group_resource_name": "string",
  • "group_resource_type": "https://w3id.org/rec#Building",
  • "group_point_id": "string",
  • "group_point_name": "string",
  • "value": 24.5,
  • "average_value": 22.5,
  • "time_weighted_average_value": 22.7,
  • "count_value": null,
  • "sum_value": null,
  • "min_value": 18.5,
  • "max_value": 24.7,
  • "date_time": "2019-08-24T14:15:22Z"

  }

]