Docs Portal
Documentation
API ReferenceConsole

Collections

Collections describe groups of Things and Points that belong together as part of a meaningful system. Use Collections to model functional systems like a Chilled Water System, where multiple pieces of equipment such as Chillers, Pumps, and Valves work together to deliver a shared outcome.

Mapped follows the Brick Schema approach to Collections, which can include Systems and Loops. A System is a group of entities in a specific order, while a Loop might include primary and secondary Systems. At the top level, a Collection is a grouping of other entities, like a Water System that includes Pumps and Tanks or an Air Loop System that includes Heating and Cooling Sensors:

RequestLive Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
{
  collections(filter: {name: {eq: "AirLoop2"}}) {
    id
    name
    exactType
    points(filter: {type: {eq: "Sensor"}}) {
      id
      name
      exactType
    }
  }
}

Systems

A System is a group of assets (physical or virtual) working together to serve a common purpose. For example, a Chilled Water System might have the following relationships with entities:

  • hasPart Chiller, CHWP
  • hasPoint Entering Chilled Water Temperature Sensor, Entering Water Temperature Setpoint, Leaving Chilled Water Temperature Sensor Water Differential Pressure Sensor, Water Differential Pressure Setpoint, Valve Position Command, Valve Position Sensor, etc

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  collections(filter: {exactType: {eq: "Chilled_Water_System"}}) {
    id
    name
    description
    exactType
    hasPart {
      ... on Thing {
        id
        name
        exactType
      }
    }
    hasPoint {
      id
      name
      exactType
    }
  }
}

Similarly, an Exhaust Air System might include a Damper, and various Airflow Setpoint and Limit sensors:

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  collections(filter: {exactType: {eq: "Exhaust_Air_System"}}) {
    id
    name
    description
    exactType
    hasPart {
      ... on Thing {
        id
        name
        exactType
      }
    }
    hasPoint {
      id
      name
      exactType
    }
  }
}