Skip to main content

Building

Object

Contains all the details of a building.

type Building implements GraphNode & Place & ThingContainer {
address: Address
calendarEvents(filter: CalendarEventFilter): [CalendarEvent]
collections(filter: CollectionFilter): [Collection]
connectedDataSourceId: String
connectors(filter: ConnectorFilterInput): [Connector]
dateCreated: DateTime
dateUpdated: DateTime
description: String
exactType: String
floors(filter: FloorFilter): [Floor]
frameGeometry: GraphQLJSON
geolocation(filter: GeoPointQuantityFilter, transitive: Boolean = false): GeoPointQuantity
geolocationEdges: [GeolocationEdge]
grossArea(filter: AreaQuantityFilter, transitive: Boolean = false): AreaQuantity
grossAreaEdges: [GrossAreaEdge]
hasExtendedProperty(filter: ExtendedPropertyFilter, transitive: Boolean = false): [ExtendedProperty]
hasExtendedPropertyEdges: [HasExtendedPropertyEdge]
hasPart(filter: PlaceFilter, transitive: Boolean = false): [Place]
hasPartEdges: [HasPartEdge]
hasPoint(filter: PointFilter, transitive: Boolean = false): [Point]
hasPointEdges: [HasPointEdge]
hasPrimBinding(filter: OpenUSDPrimBindingFilter, transitive: Boolean = false): [OpenUSDPrimBinding]
hasPrimBindingEdges: [HasPrimBindingEdge]
hasPropertyContributedFrom: [BuildingHasPropertyContributedFromUnion]
hasPropertyContributedFromEdges: [BuildingHasPropertyContributedFromEdge]
id: String!
identities: [BuildingIdentityUnion]
isAdjacentTo(filter: PlaceFilter, transitive: Boolean = false): [Place]
isAdjacentToEdges: [IsAdjacentToEdge]
isFedBy(filter: ThingFilter, transitive: Boolean = false): [Thing]
isFedByEdges: [IsFedByEdge]
isLocationOf(filter: EntityFilter): [IsLocationOfUnion]
isLocationOfEdges: [IsLocationOfEdge]
isPartOf(filter: PlaceFilter, transitive: Boolean = false): [Place]
isPartOfEdges: [IsPartOfEdge]
isServedBy(filter: ThingFilter): [Thing]
isServedByEdges: [IsServedByEdge]
mappingKey: String
name: String
places(filter: PlaceFilter): [Place]
points(filter: PointFilter): [Point]
pointsPaginated(filter: PointFilter, pagination: PageInfoInput): PointsConnection
rentableArea(filter: AreaQuantityFilter, transitive: Boolean = false): AreaQuantity
rentableAreaEdges: [RentableAreaEdge]
sites(filter: SiteFilter): [Site]
spaces(childDepth: Int, filter: SpaceFilter): [Space]
spacesPaginated(filter: SpaceFilter, pagination: PageInfoInput): SpacesConnection
subBuildings(filter: SubBuildingFilter): [SubBuilding]
things(filter: ThingFilter): [Thing]
timeZone: String
type: [String]
usableArea(filter: AreaQuantityFilter, transitive: Boolean = false): AreaQuantity
usableAreaEdges: [UsableAreaEdge]
zones(filter: ZoneFilter): [Zone]
}

Implements​

Fields​

FieldTypeDescription
addressAddressThe address of a building, contains fields that support international addresses.
calendarEvents[CalendarEvent]Arguments: filter: CalendarEventFilter
collections[Collection]Arguments: filter: CollectionFilter
connectedDataSourceIdString
connectors[Connector]Any connectors configured for a building will be listed here.
Arguments: filter: ConnectorFilterInput
dateCreatedDateTimeThis timestamp represents the date the building was created.
dateUpdatedDateTimeThis timestamp represents that date the building was last updated.
descriptionStringThe description of a building; often left blank, especially if the building name is already descriptive.
exactTypeStringThe exactType is the most granular Brick Schema Location type defined for this building.
floors[Floor]All the floors present in a building will be listed here.
Arguments: filter: FloorFilter
frameGeometryGraphQLJSON
geolocationGeoPointQuantityArguments: filter: GeoPointQuantityFilter, transitive: Boolean = false
geolocationEdges[GeolocationEdge]
grossAreaAreaQuantityArguments: filter: AreaQuantityFilter, transitive: Boolean = false
grossAreaEdges[GrossAreaEdge]
hasExtendedProperty[ExtendedProperty]Arguments: filter: ExtendedPropertyFilter, transitive: Boolean = false
hasExtendedPropertyEdges[HasExtendedPropertyEdge]
hasPart[Place]Arguments: filter: PlaceFilter, transitive: Boolean = false
hasPartEdges[HasPartEdge]
hasPoint[Point]In some limited scenarios, a point may be associated with a building as opposed to a thing, like a building electrical meter. Those details will be provided here.
Arguments: filter: PointFilter, transitive: Boolean = false
hasPointEdges[HasPointEdge]
hasPrimBinding[OpenUSDPrimBinding]Arguments: filter: OpenUSDPrimBindingFilter, transitive: Boolean = false
hasPrimBindingEdges[HasPrimBindingEdge]
hasPropertyContributedFrom[BuildingHasPropertyContributedFromUnion]
hasPropertyContributedFromEdges[BuildingHasPropertyContributedFromEdge]
idString!The unique ID of a building.
identities[BuildingIdentityUnion]
isAdjacentTo[Place]Arguments: filter: PlaceFilter, transitive: Boolean = false
isAdjacentToEdges[IsAdjacentToEdge]
isFedBy[Thing]Arguments: filter: ThingFilter, transitive: Boolean = false
isFedByEdges[IsFedByEdge]
isLocationOf[IsLocationOfUnion]Superset of anything that could be in a building - a thing, a person, a meeting (people and meetings currently in development).
Arguments: filter: EntityFilter
isLocationOfEdges[IsLocationOfEdge]
isPartOf[Place]This contains the next level up in the place hierarchy; for a building, this will contain site information.
Arguments: filter: PlaceFilter, transitive: Boolean = false
isPartOfEdges[IsPartOfEdge]
isServedBy[Thing]Arguments: filter: ThingFilter
isServedByEdges[IsServedByEdge]
mappingKeyString
nameStringThe name of a building; often just the street address.
places[Place]Arguments: filter: PlaceFilter
points[Point]Any of the points available inside a building will be listed here.
Arguments: filter: PointFilter
pointsPaginatedPointsConnectionCursor paginated variant of "points". Prefer it over "points" whenever an organization can have a large number of points - it pages results through the search index instead of materializing every match.
Arguments: filter: PointFilter, pagination: PageInfoInput
rentableAreaAreaQuantityArguments: filter: AreaQuantityFilter, transitive: Boolean = false
rentableAreaEdges[RentableAreaEdge]
sites[Site]The site associated with a building.
Arguments: filter: SiteFilter
spaces[Space]Arguments: childDepth: Int, filter: SpaceFilter
spacesPaginatedSpacesConnectionCursor paginated variant of "spaces". Prefer it over "spaces" whenever an organization can have a large number of spaces - it pages results through the search index instead of materializing every match.
Arguments: filter: SpaceFilter, pagination: PageInfoInput
subBuildings[SubBuilding]Arguments: filter: SubBuildingFilter
things[Thing]All the things associated with a building, or any floor or space in the building, will show here.
Arguments: filter: ThingFilter
timeZoneString
type[String]Type includes all possible hierarchal types for the building, such as "Place" and "Building".
usableAreaAreaQuantityArguments: filter: AreaQuantityFilter, transitive: Boolean = false
usableAreaEdges[UsableAreaEdge]
zones[Zone]Arguments: filter: ZoneFilter

Used by​