Skip to main content

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
  logCountsByLevel(bucketSeconds: Int, filter: ConnectorLogFilterInput): [ConnectorLogCountByLevelBucket]
  logs(filter: ConnectorLogFilterInput, pagination: PaginationInput): ConnectorLogListResponse
  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​

FieldTypeDescription
baseUrlString
buildings[Building]Arguments: filter: BuildingFilter
configJSONSchemaAny settings required in order to create a Connector will be provided here.
configHashStringRandom 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.
connectorTypeConnectorTypeThe type/category/vendor of a Connector, such as "Weather" or "Butlr".
connectorTypeIdStringThe unique id of the connector type.
contributions[ConnectorContribution]
createdDateTimeTimestamp for the Connector's creation.
directionConnectorTypeConnectorDirection
floors[Floor]Arguments: filter: FloorFilter
hostIdString
idStringThe unique id of a Connector.
kinematicJoints[KinematicJoint]The kinematic joints this Connector contributed.
Arguments: filter: KinematicJointFilter
lastSeenDateTime
lastUpdatedByString
logCountsByLevel[ConnectorLogCountByLevelBucket]How many of the Connector's logs each level has per time bucket, over the whole period, for a chart. Takes the same filter as logs. Buckets sit on a UTC grid aligned to bucketSeconds, the first and the last count only their part inside the period, and buckets and levels with no logs are left out.
Arguments: bucketSeconds: Int, filter: ConnectorLogFilterInput
logsConnectorLogListResponseThe Connector's customer-facing logs, newest first, a page at a time. The period comes from filter.timestamp or from a timestamp:[A TO B] clause in filter.query; it ends at lte (exclusive) or now, starts at gte (inclusive) or 24 hours before its end, and spans at most 30 days. Ask for the next page with the nextToken of the previous one and the same filter.
Arguments: filter: ConnectorLogFilterInput, pagination: PaginationInput
nameStringThe 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
organizationOrgContains the details about the organization associated with this Connector.
points[Point]Lists all the points returned by the Connector.
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
runtimeVersionConnectorTypeRuntimeVersion
sites[Site]Arguments: filter: SiteFilter
spaces[Space]Arguments: 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
stateConnectorStateLists the state of a Connector, such as ACTIVE or STOPPED.
stateDetailsStringCurrently provides additional information about a Connector in an ERROR_GENERAL state.
things[Thing]Lists all the things returned by the Connector.
Arguments: filter: ThingFilter
updatedDateTimeTimestamp when a connector was last updated.
userIdString
workflowIdStringThis 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​