Skip to main content

Space

Object

Contains the details about the space.

type Space implements GraphNode & Place & ThingContainer {
calendar: Calendar
calendarEvents(filter: CalendarEventFilter): [CalendarEvent]
collections(filter: CollectionFilter): [Collection]
connectedDataSourceId: String
connectors(filter: ConnectorFilterInput): [Connector]
dateCreated: DateTime
dateUpdated: DateTime
description: String
exactType: String
floor: Floor!
frameGeometry: GraphQLJSON
geoshape: GeoJSON
grossArea(filter: AreaQuantityFilter, transitive: Boolean = false): AreaQuantity
grossAreaEdges: [GrossAreaEdge]
hasCalendar(filter: CalendarFilter, transitive: Boolean = false): [Calendar]
hasCalendarEdges: [HasCalendarEdge]
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: [SpaceHasPropertyContributedFromUnion]
hasPropertyContributedFromEdges: [SpaceHasPropertyContributedFromEdge]
id: String!
identities: [SpaceIdentityUnion]
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): [Place]
isPartOfEdges: [IsPartOfEdge]
isServedBy(filter: ThingFilter): [Thing]
isServedByEdges: [IsServedByEdge]
mappingKey: String
maxOccupancy: Int
name: String
parentSpaceId: String
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]
}

Implements​

Fields​

FieldTypeDescription
calendarCalendar
calendarEvents[CalendarEvent]Arguments: filter: CalendarEventFilter
collections[Collection]Arguments: filter: CollectionFilter
connectedDataSourceIdString
connectors[Connector]Any connectors configured for the space will be listed here.
Arguments: filter: ConnectorFilterInput
dateCreatedDateTimeThis timestamp represents the date the space was created.
dateUpdatedDateTimeThis timestamp represents that date the space was last updated.
descriptionStringThe description of the space; often left blank, especially if the space name is already descriptive.
exactTypeStringThis is the most specific type available for the space, i.e. where 'type' may return a list like [Place, Space, Room, Office], exactType will return just Office.
floorFloor!Contains the details of the floor where the space is present.
frameGeometryGraphQLJSON
geoshapeGeoJSONThe geographic shape of the space, represented by latitude/longitude coordinate pairs.
grossAreaAreaQuantityArguments: filter: AreaQuantityFilter, transitive: Boolean = false
grossAreaEdges[GrossAreaEdge]
hasCalendar[Calendar]Arguments: filter: CalendarFilter, transitive: Boolean = false
hasCalendarEdges[HasCalendarEdge]
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[SpaceHasPropertyContributedFromUnion]
hasPropertyContributedFromEdges[SpaceHasPropertyContributedFromEdge]
idString!The unique ID of the space.
identities[SpaceIdentityUnion]
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
isPartOfEdges[IsPartOfEdge]
isServedBy[Thing]Arguments: filter: ThingFilter
isServedByEdges[IsServedByEdge]
mappingKeyString
maxOccupancyInt
nameStringThe name assigned to the space, like "breakroom" or "rm101".
parentSpaceIdString_
places[Place]Arguments: filter: PlaceFilter
points[Point]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]
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
things[Thing]All the things associated with a space will show here.
Arguments: filter: ThingFilter
type[String]The class or subclass of a space, like Room and Office.
usableAreaAreaQuantityArguments: filter: AreaQuantityFilter, transitive: Boolean = false
usableAreaEdges[UsableAreaEdge]

Used by​