Builder APIConcepts
Relationships
How resources are connected - parts, feeds, locations and sub-meters - and how to walk them.
Relationships connect resources, and resources.related walks them.
| Relationship | Example |
|---|---|
brick_Has_Part | building → levels → rooms (maxDepth: 2) |
brick_Feeds | air handling unit → terminal units → rooms |
rec_Located_In | equipment located in a space |
brick_Has_Sub_Meter / brick_Is_Metered_By | meter hierarchies, and what a meter meters |
direction: "out"follows the relationship as named;"in"follows it backwards.maxDepthis how many steps to walk;targetTypeKeyskeeps only the resources of those types.resourceTypes.relationshipsshows which relationships a building uses and between which types, so you can plan a walk before making it.truncated: truein the response means the result was cut: narrow the filters.- An unknown relationship name is an error (
unknown_relationship), not an empty result.