Users interact with GraphQL APIs via queries. The Connect API operates in this way as well. In this section we provide example queries to get you started with an understanding of what data is possible to review via the API. To start, we also offer some pro-tips and things to note before getting too far on your queries.
Graph QL Query Pro-Tips:
Hitting "Tab" autocompletes in the query field
Red Under lining is not spell check, but an identifier you need more detail on that line
Mouse over gives you error details
Command / to comment out a line and save it
If you can click into a field and there are sub-fields, you will need to specify the query to include some aspect of the sub fields
"Point Name" can be CurValue
If there is a null code on the "Code" field then we can assume there might be an issue on the SkySpark side.
Untagged (in SkySpark) points showing up in "For Cx"
Things to note:
How to know when your query is ready to go.
Red underline
You can keep your queries
How to comment out queries
Command (mac) = CTL (W10)
Highlight the query and press CTRL + / to comment out
Example Queries
Example 1:
Return a list of all buildings with their ID and name. If someone asks "What is my building ID (UUID)?" this is query you run.
query{
Buildings{
Id
name
}
}
Example 2:
Using an ID value from Example 1, return the name of the building associated with the ID, the ID of the Connect connector and the ID of the entity in the external system.
query{
building(id: "79fa0e8e-17b6-48b7-87f4-63c893791419"){
name
connectors{
id
xid
}
}
}More example queries that can be used in Altair are here:
Get Portfolio Buildings
{
portfolio(id:"57f5c7e9-07e9-4393-8c37-baacd5339c44") {
id
name
buildings {
id
name
timezone
address{
address
locality
}
}
}
}
Get Building Details: Floor, Name, HVAC Zones
{
building(id: "b119e985-ea4a-4d19-b135-0be70a3ab505") {
name
floors {
name
rooms {
name
hvacZones{
name
}
}
}
}
}
Get Equipment Details
{
building(id:"b119e985-ea4a-4d19-b135-0be70a3ab505"){
equipment{
name
label
floor{
id
name
}
room{
id
name
}
}
}
}
Get VAV Details
{
building(id:"b119e985-ea4a-4d19-b135-0be70a3ab505"){
name
hvacs{
vavs{
name
id
}
}
}
}
Building HVAC Zones and VAVs
{
building(id: "b119e985-ea4a-4d19-b135-0be70a3ab505") {
name
floors {
hvacZones{
id
name
function
rooms {
name
}
equipment {
... on VAV {
id
name
}
}
}
}
}
}
# VAVs in the HVAC system
{
building(id:"8e7d0767-7f3a-4f5a-a8c5-b4591f162015"){
name
hvacs{
vavs{
name
id
}
}
}
}
# VAV Points
{
vav(id: "a0136fe0-da4c-4f18-92ee-7dece185da43") {
name
points{
id
name
curValue
unit
}
}
}
Setpoint Operation
mutation{
haystackSet(input: {
connectorId: "skyspark-nonprod"
pointId: "p:buildingsIot:r:273eed04-49e5a3da"
value: "75"
}){
success
message
}
}
CO2 Measurements over a period
{
environmentSensor(id: "88b55afd-37ac-4ea3-8855-f1dad1f64ffd") {
id
name
label
point( id: "BIoT_test_003:CO2") {
kind
name
unit
measurements(startTimestamp: "2021-02-01T00:00:00-08:00", endTimestamp: "2021-02-10T23:59:59-08:00") {
timezone
timestamp
value
}
}
}
}
Get environmental sensor details, specifically current value data for a date range
environmentSensors {
id
name
points {
curValue
unit
}
}
issues(startTimestamp:"2021-02-05T00:00:00-08:00", endTimestamp: "2021-02-12T23:59:59-08:00") {
id
name
}
}
}
Get the ID, name and functions of IEQ Sensors in your building
# Environment Sensors
{
building(id: "d928512f-40c6-4104-b203-4990a4f6795d"){
name
environmentSensors{
id
name
functions
}
}
}
# IEQ Sensor Data
{
environmentSensor(id: "88b55afd-37ac-4ea3-8855-f1dad1f64ffd") {
name
points {
name
curValue
unit
}
hvacZone{
name
}
}
}
Get various details about HVAC Zones, Equipment
{
building(id: "d928512f-40c6-4104-b203-4990a4f6795d") {
name
floors {
hvacZones{
id
name
function
rooms {
name
}
equipment {
... on VAV {
id
name
points{
curValue
unit
}
}
}
}
}
Sync Ontology Alignment Project Data
mutation{
syncOntologyData
}
Get equipment connector details
{
building(id:"8e7d0767-7f3a-4f5a-a8c5-b4591f162015"){
equipment{
name
connectors{
id
xid
}
points{
name
type
}
}
}
}