Site

Object

Contains the details about a site.

type Site implements GraphNode & Place & ThingContainer {
  buildings(filter: BuildingFilter): [Building]
  calendarEvents(filter: CalendarEventFilter): [CalendarEvent]
  collections(filter: CollectionFilter): [Collection]
  connectedDataSourceId: String
  connectors(filter: ConnectorFilterInput): [Connector]
  dateCreated: DateTime
  dateUpdated: DateTime
  description: String
  exactType: String
  frameGeometry: GraphQLJSON
  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: [SiteHasPropertyContributedFromUnion]
  hasPropertyContributedFromEdges: [SiteHasPropertyContributedFromEdge]
  id: String!
  identities: [SiteIdentityUnion]
  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
  organization: Org
  places(filter: PlaceFilter): [Place]
  points(filter: PointFilter): [Point]
  pointsPaginated(filter: PointFilter, pagination: PageInfoInput): PointsConnection
  rentableArea(filter: AreaQuantityFilter, transitive: Boolean = false): AreaQuantity
  rentableAreaEdges: [RentableAreaEdge]
  spacesPaginated(filter: SpaceFilter, pagination: PageInfoInput): SpacesConnection
  things(filter: ThingFilter): [Thing]
  type: [String]
  usableArea(filter: AreaQuantityFilter, transitive: Boolean = false): AreaQuantity
  usableAreaEdges: [UsableAreaEdge]
  zones(filter: ZoneFilter): [Zone]
}

Implements

• GraphNode
• Place
• ThingContainer

Fields

Field	Type	Description
buildings	[Building]	All the buildings in a site will be listed here. Arguments: filter: BuildingFilter
calendarEvents	[CalendarEvent]	Arguments: filter: CalendarEventFilter
collections	[Collection]	Arguments: filter: CollectionFilter
connectedDataSourceId	String
connectors	[Connector]	Any connectors configured for a site will be listed here. Arguments: filter: ConnectorFilterInput
dateCreated	DateTime	This timestamp represents the date the site was created.
dateUpdated	DateTime	This timestamp represents that date the site was last updated.
description	String	The description of a site; often left blank, especially if the site name is already descriptive.
exactType	String
frameGeometry	GraphQLJSON
grossArea	AreaQuantity	Arguments: 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]	Arguments: filter: PointFilter, transitive: Boolean = false
hasPointEdges	[HasPointEdge]
hasPrimBinding	[OpenUSDPrimBinding]	Arguments: filter: OpenUSDPrimBindingFilter, transitive: Boolean = false
hasPrimBindingEdges	[HasPrimBindingEdge]
hasPropertyContributedFrom	[SiteHasPropertyContributedFromUnion]
hasPropertyContributedFromEdges	[SiteHasPropertyContributedFromEdge]
id	String!	The unique ID of the site.
identities	[SiteIdentityUnion]
isAdjacentTo	[Place]	Arguments: filter: PlaceFilter, transitive: Boolean = false
isAdjacentToEdges	[IsAdjacentToEdge]
isFedBy	[Thing]	Arguments: filter: ThingFilter, transitive: Boolean = false
isFedByEdges	[IsFedByEdge]
isLocationOf	[IsLocationOfUnion]	Arguments: filter: EntityFilter
isLocationOfEdges	[IsLocationOfEdge]
isPartOf	[Place]	Arguments: filter: PlaceFilter, transitive: Boolean = false
isPartOfEdges	[IsPartOfEdge]
isServedBy	[Thing]	Arguments: filter: ThingFilter
isServedByEdges	[IsServedByEdge]
mappingKey	String
name	String	The name assigned to the site, like the name of a campus containing multiple buildings.
organization	Org	The organization a site belongs to; this field will be restricted by access rights.
places	[Place]	Arguments: filter: PlaceFilter
points	[Point]	Arguments: filter: PointFilter
pointsPaginated	PointsConnection	Cursor 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
rentableArea	AreaQuantity	Arguments: filter: AreaQuantityFilter, transitive: Boolean = false
rentableAreaEdges	[RentableAreaEdge]
spacesPaginated	SpacesConnection	Cursor 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
things	[Thing]	All the things associated with a site, or any sublevels of the site (building, floor or space), will show here. Arguments: filter: ThingFilter
type	[String]
usableArea	AreaQuantity	Arguments: filter: AreaQuantityFilter, transitive: Boolean = false
usableAreaEdges	[UsableAreaEdge]
zones	[Zone]	Arguments: filter: ZoneFilter

Used by

• Building.sites (field)
• Connector.sites (field)
• GenericPlace.sites (field)
• Org.sites (field)
• sites (query)