SiteSummary

Object

What a site holds, counted by Core from the search index so a client can judge a site without reading it. A section is null when Core did not or could not count it, or when the caller cannot read it; zero means Core counted and found none.

type SiteSummary {
  collections: SiteSummaryTypeCounts
  computedAt: DateTime!
  floors: [SiteSummaryFloor!]!
  geometry: SiteSummaryGeometry!
  name: String
  places: SiteSummaryPlaceCounts!
  points: SiteSummaryTypeCounts
  serviceRequests: SiteSummaryWorkCounts
  siteId: String!
  things: SiteSummaryTypeCounts
  workOrders: SiteSummaryWorkCounts
}

Fields

Field	Type	Description
collections	SiteSummaryTypeCounts	Collections at the site, counted by type. Null when Core could not count them; zero total means none.
computedAt	DateTime!	When Core counted.
floors	[SiteSummaryFloor!]!	Every floor of the site, with a small summary per floor.
geometry	SiteSummaryGeometry!	What geometry and 3D models the site has, for judging whether a floor plan or 3D view can be drawn.
name	String	The site's name; null when it has none.
places	SiteSummaryPlaceCounts!	The buildings, floors, spaces and zones of the site.
points	SiteSummaryTypeCounts	Points at the site, counted by type. Null when the caller cannot read points or Core could not count them; zero total means none.
serviceRequests	SiteSummaryWorkCounts	Service requests that relate to the site's places. Null when Core did not compute them or the caller cannot read them; zero total means none.
siteId	String!	The id of the site that was counted.
things	SiteSummaryTypeCounts	Things at the site, counted by type. Null when the caller cannot read things (Thing.Read.All) or Core could not count them; zero total means none.
workOrders	SiteSummaryWorkCounts	Work orders that relate to the site's places. Null when Core did not compute them or the caller cannot read them; zero total means none.

Used by

• siteSummary (query)