Connector

Object

Contains the details about a Connector.

type Connector {
  baseUrl: String
  buildings(filter: BuildingFilter): [Building]
  config: JSONSchema
  configHash: String
  connectorType: ConnectorType
  connectorTypeId: String
  contributions: [ConnectorContribution]
  created: DateTime
  direction: ConnectorTypeConnectorDirection
  floors(filter: FloorFilter): [Floor]
  hostId: String
  id: String
  kinematicJoints(filter: KinematicJointFilter): [KinematicJoint]
  lastSeen: DateTime
  lastUpdatedBy: String
  logs(filter: ConnectorLogFilterInput): [ConnectorLog]
  name: String
  openUSDLODHeuristics(filter: OpenUSDLODHeuristicFilter): [OpenUSDLODHeuristic]
  openUSDLayers(filter: OpenUSDLayerFilter): [OpenUSDLayer]
  openUSDPrimBindings(filter: OpenUSDPrimBindingFilter): [OpenUSDPrimBinding]
  organization: Org
  points(filter: PointFilter): [Point]
  pointsPaginated(filter: PointFilter, pagination: PageInfoInput): PointsConnection
  runtimeVersion: ConnectorTypeRuntimeVersion
  sites(filter: SiteFilter): [Site]
  spaces(filter: SpaceFilter): [Space]
  spacesPaginated(filter: SpaceFilter, pagination: PageInfoInput): SpacesConnection
  state: ConnectorState
  stateDetails: String
  things(filter: ThingFilter): [Thing]
  updated: DateTime
  userId: String
  workflowId: String
  zones(filter: ZoneFilter): [Zone]
}

Fields

Field	Type	Description
baseUrl	String
buildings	[Building]	Arguments: filter: BuildingFilter
config	JSONSchema	Any settings required in order to create a Connector will be provided here.
configHash	String	Random string that identifies the current Connector configuration; if you need to update the configuration, you will need to include the current configHash value in the mutation request.
connectorType	ConnectorType	The type/category/vendor of a Connector, such as "Weather" or "Butlr".
connectorTypeId	String	The unique id of the connector type.
contributions	[ConnectorContribution]
created	DateTime	Timestamp for the Connector's creation.
direction	ConnectorTypeConnectorDirection
floors	[Floor]	Arguments: filter: FloorFilter
hostId	String
id	String	The unique id of a Connector.
kinematicJoints	[KinematicJoint]	The kinematic joints this Connector contributed. Arguments: filter: KinematicJointFilter
lastSeen	DateTime
lastUpdatedBy	String
logs	[ConnectorLog]	Arguments: filter: ConnectorLogFilterInput
name	String	The name of a Connector you provided when setting it up for your org.
openUSDLODHeuristics	[OpenUSDLODHeuristic]	The OpenUSD level-of-detail selection policies this Connector contributed. Arguments: filter: OpenUSDLODHeuristicFilter
openUSDLayers	[OpenUSDLayer]	The OpenUSD layers this Connector contributed. Arguments: filter: OpenUSDLayerFilter
openUSDPrimBindings	[OpenUSDPrimBinding]	The OpenUSD prim bindings this Connector contributed. Arguments: filter: OpenUSDPrimBindingFilter
organization	Org	Contains the details about the organization associated with this Connector.
points	[Point]	Lists all the points returned by the Connector. 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
runtimeVersion	ConnectorTypeRuntimeVersion
sites	[Site]	Arguments: filter: SiteFilter
spaces	[Space]	Arguments: filter: SpaceFilter
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
state	ConnectorState	Lists the state of a Connector, such as ACTIVE or STOPPED.
stateDetails	String	Currently provides additional information about a Connector in an ERROR_GENERAL state.
things	[Thing]	Lists all the things returned by the Connector. Arguments: filter: ThingFilter
updated	DateTime	Timestamp when a connector was last updated.
userId	String
workflowId	String	This is an internal-only field; the value(s) included in this field may be requested by support for troubleshooting purposes, but otherwise holds no value for external developers.
zones	[Zone]	Arguments: filter: ZoneFilter

Used by

• Building.connectors (field)
• ConnectorCreateResponse.connector (field)
• connectors (query)
• ConnectorUpdateResponse.connector (field)
• Floor.connectors (field)
• GenericPlace.connectors (field)
• Lease.connectors (field)
• Org.connectors (field)
• Place.connectors (field)
• Site.connectors (field)
• Space.connectors (field)
• SubBuilding.connectors (field)
• Zone.connectors (field)