Example Query: Ceiling Height
The Insights™ Query Builder is an interactive tool set for creating and executing textual queries that helps you become familiar with the syntax of the Quantum API. The following query explains how to use the Query Builder by providing a sample query you can try.
What is the ceiling height of the zones in My First Project?
Buildings typically have default ceiling height values during creation, which you can edit. You can view that data in Insights.
The following procedure shows how to build a sample query for viewing that information using the visual interface of the Query Builder. For brevity, this procedure assumes you are familiar with the features shown in the previous sample query, using an example site named My First Project which you may have by default in some new accounts.
To query the ceiling height of the zones in My First Project:
-
In the Query Builder, create this query:
Use the following actions to do so. Make sure to scroll through the whole table:From domain Drag To this tray Site Site object From Building Building object To Site Site object > Name attribute Where
From
select Equal.
Type My First Project.
Click chain to add a query chain.
Building Floor object To Building Floor object > Name attribute Where Click chain to add a query chain.
Building Zone object To Building Zone object > Name attribute Where Click chain to add a query chain.
Property Property object To Property
Property object > Name attribute Where
From
select Equal.
Type ceilingHeight.
(Field is case sensitive.)
- Click Run Query
to see the ceilingHeight attribute for the zones in My First Project.
The Query Builder generates the text of the query string for you. You can copy or edit it in the first field of the GraphiQL Query panel, and it is saved in your query History.
query{
sites(where:{name:{contains:"My First Project"}},){
name
buildings{
ID
floors{
ID
name
zones{
ID
name
properties(where:{name:{contains:"ceilingHeight"}},){
ID
name
description
notes
locked
currentValue
isError
isImmutable
isNullValue
sourceQuality
symbol
}
}
}
}
}
}The query results look similar to this example:
More Query Builder examples
The examples linked below explain how to query by using the visual Query Builder as well as by editing the query string yourself.