Queries
accessConnectorAuth
Response
Returns a ConnectorAuthResponseSecret
Arguments
| Name | Description |
|---|---|
input - ConnectorAuthAccessRequestInput
|
Example
Query
query accessConnectorAuth($input: ConnectorAuthAccessRequestInput) {
accessConnectorAuth(input: $input) {
accessToken {
...ConnectorServicesAccessTokenFragment
}
staticToken {
...ConnectorAuthStaticTokenFragment
}
usernamePassword {
...ConnectorAuthUsernamePasswordFragment
}
}
}
Variables
{"input": ConnectorAuthAccessRequestInput}
Response
{
"data": {
"accessConnectorAuth": {
"accessToken": ConnectorServicesAccessToken,
"staticToken": ConnectorAuthStaticToken,
"usernamePassword": ConnectorAuthUsernamePassword
}
}
}
availableConnectorTypes
Description
Returns the complete list of Connector Types (type = category or vendor) available to you for install; this does not reflect which Connectors are already installed, use "connectors" for that query.
Response
Returns a ConnectorTypeListAvailableResponse
Arguments
| Name | Description |
|---|---|
filter - ConnectorTypeFilterInput
|
This filter is typically used to restrict results to a specific connector type or types. |
includeRequested - Boolean
|
|
includeUponRequest - Boolean
|
Example
Query
query availableConnectorTypes(
$filter: ConnectorTypeFilterInput,
$includeRequested: Boolean,
$includeUponRequest: Boolean
) {
availableConnectorTypes(
filter: $filter,
includeRequested: $includeRequested,
includeUponRequest: $includeUponRequest
) {
available {
...ConnectorTypeFragment
}
connectorTypes {
...ConnectorTypeFragment
}
requested {
...ConnectorTypeFragment
}
uponRequest {
...ConnectorTypeFragment
}
}
}
Variables
{
"filter": ConnectorTypeFilterInput,
"includeRequested": true,
"includeUponRequest": true
}
Response
{
"data": {
"availableConnectorTypes": {
"available": [ConnectorType],
"connectorTypes": [ConnectorType],
"requested": [ConnectorType],
"uponRequest": [ConnectorType]
}
}
}
buildings
Description
Buildings are subsections of sites, where each site may have multiple associated buildings. Use this query to view building specific data such as id, name and geoshape.
Response
Returns [Building]
Arguments
| Name | Description |
|---|---|
filter - BuildingFilter
|
This filter is typically used to restrict results to a specific building or buildings. |
Example
Query
query buildings($filter: BuildingFilter) {
buildings(filter: $filter) {
address {
...AddressFragment
}
calendarEvents {
...CalendarEventFragment
}
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
floors {
...FloorFragment
}
hasPart {
...PlaceFragment
}
hasPartEdges {
...HasPartEdgeFragment
}
hasPoint {
...PointFragment
}
hasPointEdges {
...HasPointEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
...ThingFragment
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
mappingKey
name
points {
...PointFragment
}
sites {
...SiteFragment
}
spaces {
...SpaceFragment
}
things {
...ThingFragment
}
type
}
}
Variables
{"filter": BuildingFilter}
Response
{
"data": {
"buildings": [
{
"address": Address,
"calendarEvents": [CalendarEvent],
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"floors": [Floor],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Thing],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"mappingKey": "abc123",
"name": "xyz789",
"points": [Point],
"sites": [Site],
"spaces": [Space],
"things": [Thing],
"type": ["xyz789"]
}
]
}
}
calendarEvents
Description
Currently in development; will be used in association with Connectors that expose calendar events such as scheduled meetings.
Response
Returns [CalendarEvent]
Arguments
| Name | Description |
|---|---|
filter - CalendarEventFilter
|
This filter is used to return information about a specific calendar event. |
Example
Query
query calendarEvents($filter: CalendarEventFilter) {
calendarEvents(filter: $filter) {
dateCreated
dateUpdated
description
endTime
exactType
hasInvitations {
...CalendarInvitationFragment
}
hasInvitees {
... on Person {
...PersonFragment
}
... on Space {
...SpaceFragment
}
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
mappingKey
name
startTime
type
}
}
Variables
{"filter": CalendarEventFilter}
Response
{
"data": {
"calendarEvents": [
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"endTime": "2007-12-03T10:15:30Z",
"exactType": "xyz789",
"hasInvitations": [CalendarInvitation],
"hasInvitees": [Person],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "abc123",
"startTime": "2007-12-03T10:15:30Z",
"type": ["xyz789"]
}
]
}
}
connectorAuth
Description
Currently in development.
Response
Returns a ConnectorAuth
Arguments
| Name | Description |
|---|---|
id - String
|
Provide the ID for the connector auth here. |
Example
Query
query connectorAuth($id: String) {
connectorAuth(id: $id) {
created
id
lastAccessed
updated
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"connectorAuth": {
"created": "2007-12-03T10:15:30Z",
"id": "abc123",
"lastAccessed": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z"
}
}
}
connectorTypes
Description
Currently in development.
Response
Returns [ConnectorType]
Arguments
| Name | Description |
|---|---|
filter - ConnectorTypeFilterInput
|
This filter is most often used to restrict results to a specific connector type or types. |
Example
Query
query connectorTypes($filter: ConnectorTypeFilterInput) {
connectorTypes(filter: $filter) {
configSchema
description
direction
id
name
taskQueue
version
}
}
Variables
{"filter": ConnectorTypeFilterInput}
Response
{
"data": {
"connectorTypes": [
{
"configSchema": JSONSchema,
"description": "xyz789",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"id": "abc123",
"name": "abc123",
"taskQueue": "xyz789",
"version": "xyz789"
}
]
}
}
connectors
Description
Use this query to view data about the Connectors configured for the organization, including gateways.
Response
Returns [Connector]
Arguments
| Name | Description |
|---|---|
filter - ConnectorFilterInput
|
This filter is typically used to restrict results to a specific connector or connectors. |
Example
Query
query connectors($filter: ConnectorFilterInput) {
connectors(filter: $filter) {
buildings {
...BuildingFragment
}
config
configHash
connectorType {
...ConnectorTypeFragment
}
connectorTypeId
contributions {
...ConnectorContributionFragment
}
created
direction
floors {
...FloorFragment
}
id
lastSeen
lastUpdatedBy
name
organization {
...OrgFragment
}
points {
...PointFragment
}
sites {
...SiteFragment
}
spaces {
...SpaceFragment
}
state
stateDetails
things {
...ThingFragment
}
updated
userId
workflowId
}
}
Variables
{"filter": ConnectorFilterInput}
Response
{
"data": {
"connectors": [
{
"buildings": [Building],
"config": JSONSchema,
"configHash": "abc123",
"connectorType": ConnectorType,
"connectorTypeId": "abc123",
"contributions": [ConnectorContribution],
"created": "2007-12-03T10:15:30Z",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"floors": [Floor],
"id": "xyz789",
"lastSeen": "2007-12-03T10:15:30Z",
"lastUpdatedBy": "xyz789",
"name": "abc123",
"organization": Org,
"points": [Point],
"sites": [Site],
"spaces": [Space],
"state": "ACTIVE",
"stateDetails": "abc123",
"things": [Thing],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789",
"workflowId": "xyz789"
}
]
}
}
floors
Description
Floors are subsections of buildings, typically identified numerically like "floor1". Use this query to view floor specific data such as id, name or geoshape.
Response
Returns [Floor]
Arguments
| Name | Description |
|---|---|
filter - FloorFilter
|
This filter is typically used to restrict results to a specific floor or floors. |
Example
Query
query floors($filter: FloorFilter) {
floors(filter: $filter) {
building {
...BuildingFragment
}
calendarEvents {
...CalendarEventFragment
}
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
geoshape
hasPart {
...PlaceFragment
}
hasPartEdges {
...HasPartEdgeFragment
}
hasPoint {
...PointFragment
}
hasPointEdges {
...HasPointEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
...ThingFragment
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
level
mappingKey
name
points {
...PointFragment
}
spaces {
...SpaceFragment
}
things {
...ThingFragment
}
type
zones {
...ZoneFragment
}
}
}
Variables
{"filter": FloorFilter}
Response
{
"data": {
"floors": [
{
"building": Building,
"calendarEvents": [CalendarEvent],
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"geoshape": GeoJSON,
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Thing],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"level": 123,
"mappingKey": "xyz789",
"name": "abc123",
"points": [Point],
"spaces": [Space],
"things": [Thing],
"type": ["xyz789"],
"zones": [Zone]
}
]
}
}
gateways
Description
Provides details about the gateways associated with the organization, such as id or provisioning/active status.
Response
Returns [Gateway]
Arguments
| Name | Description |
|---|---|
filter - GatewayFilterInput
|
This filter is typically used to restrict results to a specific gateway or gateways. |
Example
Query
query gateways($filter: GatewayFilterInput) {
gateways(filter: $filter) {
active {
...GatewayActiveDetailsFragment
}
assignment {
...GatewayAssignmentDetailsFragment
}
firstBoot {
...GatewayFirstBootDetailsFragment
}
gatewayId
organization {
...OrgFragment
}
provisioning {
...GatewayProvisioningDetailsFragment
}
registration {
...GatewayRegistrationDetailsFragment
}
rma {
...GatewayRMADetailsFragment
}
shipping {
...GatewayShippingDetailsFragment
}
state
stateTime
suspension {
...GatewaySuspensionDetailsFragment
}
termination {
...GatewayTerminationDetailsFragment
}
}
}
Variables
{"filter": GatewayFilterInput}
Response
{
"data": {
"gateways": [
{
"active": GatewayActiveDetails,
"assignment": GatewayAssignmentDetails,
"firstBoot": GatewayFirstBootDetails,
"gatewayId": "xyz789",
"organization": Org,
"provisioning": GatewayProvisioningDetails,
"registration": GatewayRegistrationDetails,
"rma": GatewayRMADetails,
"shipping": GatewayShippingDetails,
"state": "ACTIVE",
"stateTime": "2007-12-03T10:15:30Z",
"suspension": GatewaySuspensionDetails,
"termination": GatewayTerminationDetails
}
]
}
}
getOrgMembershipsUser
Response
Returns [UserOrgDetail]
Example
Query
query getOrgMembershipsUser {
getOrgMembershipsUser {
orgId
roles
}
}
Response
{
"data": {
"getOrgMembershipsUser": [
{
"orgId": "xyz789",
"roles": ["abc123"]
}
]
}
}
grants
Description
Currently in development; will be used to list details about grants that provide access rights to parties outside the organization (like granting building tenants the right to view data about their spaces)
Response
Returns [Grant]
Arguments
| Name | Description |
|---|---|
filter - GrantFilterInput
|
This filter is typically used to restrict results to a specific grant or grants. |
Example
Query
query grants($filter: GrantFilterInput) {
grants(filter: $filter) {
approvalTime
grantedPlacesAndTypes {
...GrantPlacesAndTypesFragment
}
granteeUserId
grantorNotes {
...GrantNoteFragment
}
grantorUserId
id
requestTime
requests {
...GrantRequestFragment
}
state
updateTime
}
}
Variables
{"filter": GrantFilterInput}
Response
{
"data": {
"grants": [
{
"approvalTime": "2007-12-03T10:15:30Z",
"grantedPlacesAndTypes": [GrantPlacesAndTypes],
"granteeUserId": "abc123",
"grantorNotes": [GrantNote],
"grantorUserId": "abc123",
"id": "abc123",
"requestTime": "2007-12-03T10:15:30Z",
"requests": [GrantRequest],
"state": "APPROVED",
"updateTime": "2007-12-03T10:15:30Z"
}
]
}
}
invites
Description
Invites are used to add additional users to the org. Use this query to return the list of user invites created by your org, including those that were ACCEPTED or still PENDING.
Response
Returns [Invite]
Arguments
| Name | Description |
|---|---|
filter - InviteFilterInput
|
This filter typically used to restrict results to a specific invite or invites. |
Example
Query
query invites($filter: InviteFilterInput) {
invites(filter: $filter) {
created
email
expiration
id
inviterUserId
organization {
...OrgFragment
}
roles
status
}
}
Variables
{"filter": InviteFilterInput}
Response
{
"data": {
"invites": [
{
"created": "2007-12-03T10:15:30Z",
"email": "abc123",
"expiration": "2007-12-03T10:15:30Z",
"id": "xyz789",
"inviterUserId": "abc123",
"organization": Org,
"roles": ["ADMIN"],
"status": "ACCEPTED"
}
]
}
}
isOrgNameAvailable
Response
Returns an OrgIsOrgNameAvailableResponse
Arguments
| Name | Description |
|---|---|
orgName - String
|
Example
Query
query isOrgNameAvailable($orgName: String) {
isOrgNameAvailable(orgName: $orgName) {
isAvailable
suggestedOrgName
}
}
Variables
{"orgName": "xyz789"}
Response
{
"data": {
"isOrgNameAvailable": {
"isAvailable": true,
"suggestedOrgName": "abc123"
}
}
}
isPatNameAvailable
Response
Arguments
| Name | Description |
|---|---|
name - String
|
Example
Query
query isPatNameAvailable($name: String) {
isPatNameAvailable(name: $name) {
isAvailable
suggestedName
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"isPatNameAvailable": {
"isAvailable": true,
"suggestedName": "abc123"
}
}
}
leases
Response
Returns [Lease]
Arguments
| Name | Description |
|---|---|
filter - LeaseFilter
|
Example
Query
query leases($filter: LeaseFilter) {
leases(filter: $filter) {
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
leaseOf {
...PlaceFragment
}
leasee {
...OrgFragment
}
mappingKey
name
type
}
}
Variables
{"filter": LeaseFilter}
Response
{
"data": {
"leases": [
{
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"id": "abc123",
"identities": [AccessCredentialIdentity],
"leaseOf": [Place],
"leasee": Org,
"mappingKey": "abc123",
"name": "abc123",
"type": ["xyz789"]
}
]
}
}
liveQueries
Description
Live queries are GraphQL queries created once and then remain active, monitoring for changes perpetually for easy retrieval. Typically paired with a webhook to get proactive notificiations of changes pushed to an endpoint.
Response
Returns [LiveQuery]
Arguments
| Name | Description |
|---|---|
filter - LiveQueryFilterInput
|
This filter typically used to restrict results to a specific live query or queries. |
Example
Query
query liveQueries($filter: LiveQueryFilterInput) {
liveQueries(filter: $filter) {
dateCreated
dateUpdated
id
lastErrorDate
lastResult
lastResultDate
name
organization {
...OrgFragment
}
query
status
user {
...UserFragment
}
variables
}
}
Variables
{"filter": LiveQueryFilterInput}
Response
{
"data": {
"liveQueries": [
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"lastErrorDate": "2007-12-03T10:15:30Z",
"lastResult": GraphQLJSON,
"lastResultDate": "2007-12-03T10:15:30Z",
"name": "abc123",
"organization": Org,
"query": "xyz789",
"status": "FAILING",
"user": User,
"variables": GraphQLJSON
}
]
}
}
me
Description
Use this query to view data about the user associated with the token, such as name or id.
Response
Returns a User
Example
Query
query me {
me {
created
email
emailVerified
id
lastLogin
loginsCount
name
nickname
orgRoles
organization {
...OrgFragment
}
permissions
roles
tokens {
...PersonalAccessTokenFragment
}
updated
}
}
Response
{
"data": {
"me": {
"created": "2007-12-03T10:15:30Z",
"email": "abc123",
"emailVerified": false,
"id": "abc123",
"lastLogin": "2007-12-03T10:15:30Z",
"loginsCount": {},
"name": "abc123",
"nickname": "abc123",
"orgRoles": ["xyz789"],
"organization": Org,
"permissions": ["abc123"],
"roles": ["ADMIN"],
"tokens": [PersonalAccessToken],
"updated": "2007-12-03T10:15:30Z"
}
}
}
organization
Description
Use this query to view data about the organization associated with the the token, such as name or id.
Response
Returns an Org
Example
Query
query organization {
organization {
authenticationChallenge {
...OrgAuthenticationChallengeFragment
}
connectors {
...ConnectorFragment
}
created
gateways {
...GatewayFragment
}
id
metadata {
...MetadataRecordFragment
}
name
permissions
provisioningState
sites {
...SiteFragment
}
state
stripeCustomerId
things {
...ThingFragment
}
updated
users {
...UserFragment
}
}
}
Response
{
"data": {
"organization": {
"authenticationChallenge": OrgAuthenticationChallenge,
"connectors": [Connector],
"created": "2007-12-03T10:15:30Z",
"gateways": [Gateway],
"id": "abc123",
"metadata": [MetadataRecord],
"name": "xyz789",
"permissions": ["xyz789"],
"provisioningState": "PROVISIONING_STATE_ACCEPTED",
"sites": [Site],
"state": "ACTIVE",
"stripeCustomerId": "abc123",
"things": [Thing],
"updated": "2007-12-03T10:15:30Z",
"users": [User]
}
}
}
people
Description
Currently in development and will be used in with connectors that expose information about individuals, such as calendar events.
Response
Returns [Person]
Arguments
| Name | Description |
|---|---|
filter - PersonFilter
|
This filter is used to return information about a specific person. |
Example
Query
query people($filter: PersonFilter) {
people(filter: $filter) {
additionalName
dateCreated
dateUpdated
description
emails {
...EmailAddressFragment
}
exactType
familyName
givenName
hasCalendarEvents {
...CalendarEventFragment
}
hasCalendarInvitations {
...CalendarInvitationFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
mappingKey
name
type
}
}
Variables
{"filter": PersonFilter}
Response
{
"data": {
"people": [
{
"additionalName": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"emails": [EmailAddress],
"exactType": "abc123",
"familyName": "xyz789",
"givenName": "xyz789",
"hasCalendarEvents": [CalendarEvent],
"hasCalendarInvitations": [CalendarInvitation],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "abc123",
"type": ["xyz789"]
}
]
}
}
points
Description
A particular output at a particular time, like on/off for a device like a light. For more complex devices like a thermostat, points could be the ambient temperature in the room, what temperature is set, is the thermostat set to heat or set to cool.
Response
Returns [Point]
Arguments
| Name | Description |
|---|---|
filter - PointFilter
|
This filter is typically used to restrict results to a specific point or points. |
Example
Query
query points($filter: PointFilter) {
points(filter: $filter) {
aggregation {
...TimeseriesAggregateRowFragment
}
datatype
dateCreated
dateUpdated
description
exactType
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isPointOf {
... on Building {
...BuildingFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
isPointOfEdges {
...IsPointOfEdgeFragment
}
mappingKey
name
series {
...TimeseriesRowFragment
}
stateTexts
type
unit {
...UnitFragment
}
valueMap
}
}
Variables
{"filter": PointFilter}
Response
{
"data": {
"points": [
{
"aggregation": [TimeseriesAggregateRow],
"datatype": "BOOL",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "xyz789",
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isPointOf": [Building],
"isPointOfEdges": [IsPointOfEdge],
"mappingKey": "xyz789",
"name": "xyz789",
"series": [TimeseriesRow],
"stateTexts": ["abc123"],
"type": ["xyz789"],
"unit": Unit,
"valueMap": Map
}
]
}
}
productBundleSubscriptions
Description
For internal use only.
Response
Example
Query
query productBundleSubscriptions {
productBundleSubscriptions {
productBundle {
...BillingCalculatedProductBundleResponseFragment
}
subscriptionId
}
}
Response
{
"data": {
"productBundleSubscriptions": [
{
"productBundle": BillingCalculatedProductBundleResponse,
"subscriptionId": "xyz789"
}
]
}
}
sites
Description
Sites are the top level place - they contain buildings, which contain floors, which contain spaces. Use this query to view site specific data such as id, name or geoshape.
Response
Returns [Site]
Arguments
| Name | Description |
|---|---|
filter - SiteFilter
|
This filter is typically used to restrict results to a specific site or sites. |
Example
Query
query sites($filter: SiteFilter) {
sites(filter: $filter) {
buildings {
...BuildingFragment
}
calendarEvents {
...CalendarEventFragment
}
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
hasPart {
...PlaceFragment
}
hasPartEdges {
...HasPartEdgeFragment
}
hasPoint {
...PointFragment
}
hasPointEdges {
...HasPointEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
...ThingFragment
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
mappingKey
name
organization {
...OrgFragment
}
points {
...PointFragment
}
things {
...ThingFragment
}
type
}
}
Variables
{"filter": SiteFilter}
Response
{
"data": {
"sites": [
{
"buildings": [Building],
"calendarEvents": [CalendarEvent],
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Thing],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"mappingKey": "abc123",
"name": "abc123",
"organization": Org,
"points": [Point],
"things": [Thing],
"type": ["abc123"]
}
]
}
}
spaces
Description
Spaces are subsections of a floor, such as an office or a breakroom. Use this query to view space specific data such as id, name or geoshape.
Response
Returns [Space]
Arguments
| Name | Description |
|---|---|
filter - SpaceFilter
|
This filter is typically used to restrict results to a specific space or spaces. |
Example
Query
query spaces($filter: SpaceFilter) {
spaces(filter: $filter) {
calendarEvents {
...CalendarEventFragment
}
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
floor {
...FloorFragment
}
geoshape
hasPart {
...PlaceFragment
}
hasPartEdges {
...HasPartEdgeFragment
}
hasPoint {
...PointFragment
}
hasPointEdges {
...HasPointEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
...ThingFragment
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
mappingKey
maxOccupancy
name
parentSpaceId
points {
...PointFragment
}
things {
...ThingFragment
}
type
}
}
Variables
{"filter": SpaceFilter}
Response
{
"data": {
"spaces": [
{
"calendarEvents": [CalendarEvent],
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"floor": Floor,
"geoshape": GeoJSON,
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Thing],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"mappingKey": "xyz789",
"maxOccupancy": 987,
"name": "abc123",
"parentSpaceId": "abc123",
"points": [Point],
"things": [Thing],
"type": ["abc123"]
}
]
}
}
suggestEquivalentSpaces
Response
Arguments
| Name | Description |
|---|---|
input - SpaceMappingSuggestEquivalentSpacesRequestInput
|
Example
Query
query suggestEquivalentSpaces($input: SpaceMappingSuggestEquivalentSpacesRequestInput) {
suggestEquivalentSpaces(input: $input) {
spaces {
...SpaceMappingEquivalentSpaceSuggestionFragment
}
}
}
Variables
{"input": SpaceMappingSuggestEquivalentSpacesRequestInput}
Response
{
"data": {
"suggestEquivalentSpaces": [
{"spaces": [SpaceMappingEquivalentSpaceSuggestion]}
]
}
}
suggestFloorLevels
Response
Arguments
| Name | Description |
|---|---|
input - SpaceMappingSuggestFloorLevelsRequestInput
|
Example
Query
query suggestFloorLevels($input: SpaceMappingSuggestFloorLevelsRequestInput) {
suggestFloorLevels(input: $input) {
confidence
level
}
}
Variables
{"input": SpaceMappingSuggestFloorLevelsRequestInput}
Response
{"data": {"suggestFloorLevels": [{"confidence": 987.65, "level": 987}]}}
suggestSpaceCodes
Response
Arguments
| Name | Description |
|---|---|
input - SpaceMappingSuggestSpaceCodesRequestInput
|
Example
Query
query suggestSpaceCodes($input: SpaceMappingSuggestSpaceCodesRequestInput) {
suggestSpaceCodes(input: $input) {
confidence
spaceCode
}
}
Variables
{"input": SpaceMappingSuggestSpaceCodesRequestInput}
Response
{
"data": {
"suggestSpaceCodes": [
{
"confidence": 123.45,
"spaceCode": "abc123"
}
]
}
}
things
Description
All the devices in your places - HVAC systems, security systems, lighting, badge readers, elevators and similar.
Response
Returns [Thing]
Arguments
| Name | Description |
|---|---|
filter - ThingFilter
|
This filter is most often used torestrict results to a specific thing or things. |
Example
Query
query things($filter: ThingFilter) {
things(filter: $filter) {
dateCreated
dateUpdated
description
exactType
feeds {
... on Building {
...BuildingFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
feedsEdges {
...FeedsEdgeFragment
}
firmwareVersion
geoshape
hasDeviceModel {
...DeviceModelFragment
}
hasDeviceModelEdges {
...HasDeviceModelEdgeFragment
}
hasLocation {
...PlaceFragment
}
hasLocationEdges {
...HasLocationEdgeFragment
}
hasPart {
...ThingFragment
}
hasPartEdges {
...HasPartEdgeFragment
}
hasPoint {
...PointFragment
}
hasPointEdges {
...HasPointEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isPartOf {
...ThingFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isVirtual
manufacturedBy {
...AgentFragment
}
manufacturedByEdges {
...ManufacturedByEdgeFragment
}
mappingKey
model {
...DeviceLibraryModelFragment
}
name
organization {
...OrgFragment
}
places {
...PlaceFragment
}
points {
...PointFragment
}
seeAlso
serves {
...ZoneFragment
}
type
}
}
Variables
{"filter": ThingFilter}
Response
{
"data": {
"things": [
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"feeds": [Building],
"feedsEdges": [FeedsEdge],
"firmwareVersion": "xyz789",
"geoshape": GeoJSON,
"hasDeviceModel": DeviceModel,
"hasDeviceModelEdges": [HasDeviceModelEdge],
"hasLocation": Place,
"hasLocationEdges": [HasLocationEdge],
"hasPart": [Thing],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isPartOf": [Thing],
"isPartOfEdges": [IsPartOfEdge],
"isVirtual": false,
"manufacturedBy": Agent,
"manufacturedByEdges": [ManufacturedByEdge],
"mappingKey": "abc123",
"model": DeviceLibraryModel,
"name": "xyz789",
"organization": Org,
"places": [Place],
"points": [Point],
"seeAlso": "xyz789",
"serves": [Zone],
"type": ["abc123"]
}
]
}
}
tokens
Description
This will return information about the tokens in your account, or if you're an admin, you can look at tokens for other users. Note this will not return the actual Personal Access Token, only the token record id and data like the name and scopes.
Response
Returns [PersonalAccessToken]
Arguments
| Name | Description |
|---|---|
filter - PersonalAccessTokenFilterInput
|
This filter is typically used to restrict results to a specific token or tokens. |
Example
Query
query tokens($filter: PersonalAccessTokenFilterInput) {
tokens(filter: $filter) {
created
id
integrityId
lastExchanged
name
permissions
updated
userId
}
}
Variables
{"filter": PersonalAccessTokenFilterInput}
Response
{
"data": {
"tokens": [
{
"created": "2007-12-03T10:15:30Z",
"id": "abc123",
"integrityId": "xyz789",
"lastExchanged": "2007-12-03T10:15:30Z",
"name": "xyz789",
"permissions": ["ANAXIENRICHMENT_READWRITE_ALL"],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789"
}
]
}
}
units
Description
Predefined / global list containing units of measurement for point data, such as "Degrees". Used for timeseries data comprehension, i.e. series data for a point shows "65", units helps you understand that means 65 degrees.
Response
Returns [Unit]
Arguments
| Name | Description |
|---|---|
filter - UnitFilterInput
|
This filter is typically used to restrict results to a specific unit or units. |
Example
Query
query units($filter: UnitFilterInput) {
units(filter: $filter) {
description
id
name
}
}
Variables
{"filter": UnitFilterInput}
Response
{
"data": {
"units": [
{
"description": "abc123",
"id": "abc123",
"name": "xyz789"
}
]
}
}
users
Description
If you're an admin, use this query to retrieve data about users. If you're a non-admin user, you can review the listed data about yourself.
Response
Returns [User]
Arguments
| Name | Description |
|---|---|
filter - UserFilterInput
|
This filter is typically used to restrict results to a specific user or users. |
Example
Query
query users($filter: UserFilterInput) {
users(filter: $filter) {
created
email
emailVerified
id
lastLogin
loginsCount
name
nickname
orgRoles
organization {
...OrgFragment
}
permissions
roles
tokens {
...PersonalAccessTokenFragment
}
updated
}
}
Variables
{"filter": UserFilterInput}
Response
{
"data": {
"users": [
{
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"emailVerified": false,
"id": "abc123",
"lastLogin": "2007-12-03T10:15:30Z",
"loginsCount": {},
"name": "xyz789",
"nickname": "xyz789",
"orgRoles": ["abc123"],
"organization": Org,
"permissions": ["abc123"],
"roles": ["ADMIN"],
"tokens": [PersonalAccessToken],
"updated": "2007-12-03T10:15:30Z"
}
]
}
}
webhookTargets
Description
Used to return data about webhook targets created by org admins.
Response
Returns [WebhookTarget]
Arguments
| Name | Description |
|---|---|
filter - WebhookTargetFilterInput
|
This filter is used to return information about a specific webhook. |
Example
Query
query webhookTargets($filter: WebhookTargetFilterInput) {
webhookTargets(filter: $filter) {
batchedContentModeConfig {
...WebhookTargetCloudEventBatchedContentModeConfigFragment
}
contentMode
enabled
eventExtensions
eventFilters {
...WebhookTargetEventFilterFragment
}
httpTarget {
...WebhookTargetHTTPTargetFragment
}
id
maxRetry
metadata {
...WebhookTargetMetadataEntryFragment
}
name
organization {
...OrgFragment
}
user {
...UserFragment
}
}
}
Variables
{"filter": WebhookTargetFilterInput}
Response
{
"data": {
"webhookTargets": [
{
"batchedContentModeConfig": WebhookTargetCloudEventBatchedContentModeConfig,
"contentMode": "BATCHED",
"enabled": false,
"eventExtensions": GraphQLJSON,
"eventFilters": WebhookTargetEventFilter,
"httpTarget": WebhookTargetHTTPTarget,
"id": "abc123",
"maxRetry": {},
"metadata": [WebhookTargetMetadataEntry],
"name": "abc123",
"organization": Org,
"user": User
}
]
}
}
workOrders
Response
Returns [WorkOrder]
Arguments
| Name | Description |
|---|---|
filter - WorkOrderFilter
|
Example
Query
query workOrders($filter: WorkOrderFilter) {
workOrders(filter: $filter) {
dateClosed
dateCompleted
dateCreated
dateUpdated
description
dueDate
exactType
externalDateCreated
externalDateUpdated
hasAssignedGroup {
...PeopleGroupFragment
}
hasAssignedGroupEdges {
...HasAssignedGroupEdgeFragment
}
hasAssignee {
...PersonFragment
}
hasAssigneeEdges {
...HasAssigneeEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isClosedBy {
...PersonFragment
}
isClosedByEdges {
...IsClosedByEdgeFragment
}
isCreatedBy {
...PersonFragment
}
isCreatedByEdges {
...IsCreatedByEdgeFragment
}
isReportedBy {
...PersonFragment
}
isReportedByEdges {
...IsReportedByEdgeFragment
}
jobPriority
jobStatus
jobSubStatus
jobType
mappingKey
name
problemDescription
referenceUrl
relatesTo {
... on Building {
...BuildingFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
relatesToEdges {
...RelatesToEdgeFragment
}
resolutionDescription
sector
subject
summary
type
}
}
Variables
{"filter": WorkOrderFilter}
Response
{
"data": {
"workOrders": [
{
"dateClosed": "2007-12-03T10:15:30Z",
"dateCompleted": "2007-12-03T10:15:30Z",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"dueDate": "2007-12-03T10:15:30Z",
"exactType": "xyz789",
"externalDateCreated": "2007-12-03T10:15:30Z",
"externalDateUpdated": "2007-12-03T10:15:30Z",
"hasAssignedGroup": PeopleGroup,
"hasAssignedGroupEdges": [HasAssignedGroupEdge],
"hasAssignee": [Person],
"hasAssigneeEdges": [HasAssigneeEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isClosedBy": Person,
"isClosedByEdges": [IsClosedByEdge],
"isCreatedBy": Person,
"isCreatedByEdges": [IsCreatedByEdge],
"isReportedBy": Person,
"isReportedByEdges": [IsReportedByEdge],
"jobPriority": "xyz789",
"jobStatus": "abc123",
"jobSubStatus": "xyz789",
"jobType": "xyz789",
"mappingKey": "abc123",
"name": "abc123",
"problemDescription": "abc123",
"referenceUrl": "xyz789",
"relatesTo": [Building],
"relatesToEdges": [RelatesToEdge],
"resolutionDescription": "abc123",
"sector": "xyz789",
"subject": "xyz789",
"summary": "abc123",
"type": ["abc123"]
}
]
}
}
zones
Response
Returns [Zone]
Arguments
| Name | Description |
|---|---|
filter - ZoneFilter
|
Example
Query
query zones($filter: ZoneFilter) {
zones(filter: $filter) {
calendarEvents {
...CalendarEventFragment
}
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
geoshape
hasPart {
...PlaceFragment
}
hasPartEdges {
...HasPartEdgeFragment
}
hasPoint {
...PointFragment
}
hasPointEdges {
...HasPointEdgeFragment
}
id
identities {
... on AccessCredentialIdentity {
...AccessCredentialIdentityFragment
}
... on BACnetObjectId {
...BACnetObjectIdFragment
}
... on BACnetVendorId {
...BACnetVendorIdFragment
}
... on EmailAddressIdentity {
...EmailAddressIdentityFragment
}
... on EmailIdentity {
...EmailIdentityFragment
}
... on ExternalIdentity {
...ExternalIdentityFragment
}
... on FloorLevelIdentity {
...FloorLevelIdentityFragment
}
... on GenericIdentity {
...GenericIdentityFragment
}
... on NameIdentity {
...NameIdentityFragment
}
... on PostalAddressIdentity {
...PostalAddressIdentityFragment
}
... on SpaceCode {
...SpaceCodeFragment
}
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
...ThingFragment
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
mappingKey
name
points {
...PointFragment
}
things {
...ThingFragment
}
type
}
}
Variables
{"filter": ZoneFilter}
Response
{
"data": {
"zones": [
{
"calendarEvents": [CalendarEvent],
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"geoshape": GeoJSON,
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Thing],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"mappingKey": "abc123",
"name": "xyz789",
"points": [Point],
"things": [Thing],
"type": ["xyz789"]
}
]
}
}
Mutations
assignGateway
Description
Used to assign a provisioned gateway to a building and/or spaces.
Response
Returns a GatewayAssignResponse
Arguments
| Name | Description |
|---|---|
input - GatewayAssignRequestInput
|
Provide the required input values here, such as the gateway ID and place IDs. |
Example
Query
mutation assignGateway($input: GatewayAssignRequestInput) {
assignGateway(input: $input) {
_
}
}
Variables
{"input": GatewayAssignRequestInput}
Response
{"data": {"assignGateway": {"_": "abc123"}}}
assignRole
Description
Used to assign a new acount role to a user (such as ADMIN); does not remove the previously assigned role.
Response
Returns a UserAssignRoleResponse
Arguments
| Name | Description |
|---|---|
input - UserAssignRoleRequestInput
|
Provide the required input values here, such as the user ID and role. |
Example
Query
mutation assignRole($input: UserAssignRoleRequestInput) {
assignRole(input: $input) {
user {
...UserFragment
}
}
}
Variables
{"input": UserAssignRoleRequestInput}
Response
{"data": {"assignRole": {"user": User}}}
createBuilding
Description
Used to create a new building for a specific site.
Response
Returns a BuildingCreateResponse
Arguments
| Name | Description |
|---|---|
input - BuildingCreateRequestInput
|
Provide the required input values here, such as the address of the building and the siteId. |
Example
Query
mutation createBuilding($input: BuildingCreateRequestInput) {
createBuilding(input: $input) {
building {
...BuildingMutationFragment
}
}
}
Variables
{"input": BuildingCreateRequestInput}
Response
{
"data": {
"createBuilding": {"building": BuildingMutation}
}
}
createConnector
Description
Currently in development; will be used to create a new Connector.
Response
Returns a ConnectorCreateResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorCreateRequestInput
|
Provide the required input values here, such as config details. |
Example
Query
mutation createConnector($input: ConnectorCreateRequestInput) {
createConnector(input: $input) {
connector {
...ConnectorFragment
}
}
}
Variables
{"input": ConnectorCreateRequestInput}
Response
{"data": {"createConnector": {"connector": Connector}}}
createConnectorAuth
Description
Currently in development; will be used to create the auth details for a Connector, including token details.
Response
Returns a ConnectorAuthCreateResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorAuthCreateRequestInput
|
Provide the required input values here, such as token information or user/pass details. |
Example
Query
mutation createConnectorAuth($input: ConnectorAuthCreateRequestInput) {
createConnectorAuth(input: $input) {
connectorAuth {
...ConnectorAuthFragment
}
}
}
Variables
{"input": ConnectorAuthCreateRequestInput}
Response
{
"data": {
"createConnectorAuth": {
"connectorAuth": ConnectorAuth
}
}
}
createConnectorRequest
Response
Returns a ConnectorRequestCreateResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorRequestCreateRequestInput
|
Example
Query
mutation createConnectorRequest($input: ConnectorRequestCreateRequestInput) {
createConnectorRequest(input: $input) {
request {
...ConnectorRequestFragment
}
}
}
Variables
{"input": ConnectorRequestCreateRequestInput}
Response
{
"data": {
"createConnectorRequest": {
"request": ConnectorRequest
}
}
}
createContributionRequest
Response
Returns a ContributionRequestCreateResponse
Arguments
| Name | Description |
|---|---|
input - ContributionRequestCreateRequestInput
|
Example
Query
mutation createContributionRequest($input: ContributionRequestCreateRequestInput) {
createContributionRequest(input: $input) {
contributionRequest {
...ContributionRequestFragment
}
}
}
Variables
{"input": ContributionRequestCreateRequestInput}
Response
{
"data": {
"createContributionRequest": {
"contributionRequest": ContributionRequest
}
}
}
createFloor
Description
Used to create a new floor for a specific building.
Response
Returns a FloorCreateResponse
Arguments
| Name | Description |
|---|---|
input - FloorCreateRequestInput
|
Provide the required input values here, such as the level of the floor and the geoshape details. |
Example
Query
mutation createFloor($input: FloorCreateRequestInput) {
createFloor(input: $input) {
floor {
...FloorMutationFragment
}
}
}
Variables
{"input": FloorCreateRequestInput}
Response
{"data": {"createFloor": {"floor": FloorMutation}}}
createGrant
Description
Currently in development; will be used to add an access right grant to an external user so they can view specific organization place data (like granting building tenants the right to view data about a particular space).
Response
Returns a GrantCreateResponse
Arguments
| Name | Description |
|---|---|
input - GrantCreateRequestInput
|
Provide the required input values here, such as place details. |
Example
Query
mutation createGrant($input: GrantCreateRequestInput) {
createGrant(input: $input) {
id
}
}
Variables
{"input": GrantCreateRequestInput}
Response
{"data": {"createGrant": {"id": "xyz789"}}}
createInvite
Description
Used to create a new invite to add a new user to the org.
Response
Returns an InviteCreateResponse
Arguments
| Name | Description |
|---|---|
input - InviteCreateRequestInput
|
Provide the required input values here, such as the user's email and intended role. |
Example
Query
mutation createInvite($input: InviteCreateRequestInput) {
createInvite(input: $input) {
invite {
...InviteFragment
}
inviteToken
}
}
Variables
{"input": InviteCreateRequestInput}
Response
{
"data": {
"createInvite": {
"invite": Invite,
"inviteToken": "xyz789"
}
}
}
createLiveQuery
Description
Used to create a new live query.
Response
Returns a LiveQueryCreateResponse
Arguments
| Name | Description |
|---|---|
input - LiveQueryCreateRequestInput
|
Provide the required input values here, such as a unique name and the query you want monitored. |
Example
Query
mutation createLiveQuery($input: LiveQueryCreateRequestInput) {
createLiveQuery(input: $input) {
liveQuery {
...LiveQueryFragment
}
}
}
Variables
{"input": LiveQueryCreateRequestInput}
Response
{"data": {"createLiveQuery": {"liveQuery": LiveQuery}}}
createPersonalAccessToken
Description
Used to create a new personal access token, assuming the token you're using has the needed scope (PERSONALACCESSTOKEN_READWRITE or the admin scope PERSONALACCESSTOKEN_READWRITE_ALL).
Response
Returns a PersonalAccessTokenCreateResponse
Arguments
| Name | Description |
|---|---|
input - PersonalAccessTokenCreateRequestInput
|
Provide the required input values here, such as permissions/scopes. |
Example
Query
mutation createPersonalAccessToken($input: PersonalAccessTokenCreateRequestInput) {
createPersonalAccessToken(input: $input) {
pat {
...PersonalAccessTokenFragment
}
token
}
}
Variables
{"input": PersonalAccessTokenCreateRequestInput}
Response
{
"data": {
"createPersonalAccessToken": {
"pat": PersonalAccessToken,
"token": "abc123"
}
}
}
createSite
Description
Used to create a new site for the org.
Response
Returns a SiteCreateResponse
Arguments
| Name | Description |
|---|---|
input - SiteCreateRequestInput
|
Provide the required input values here, in specific the desired name for the site. |
Example
Query
mutation createSite($input: SiteCreateRequestInput) {
createSite(input: $input) {
site {
...SiteMutationFragment
}
}
}
Variables
{"input": SiteCreateRequestInput}
Response
{"data": {"createSite": {"site": SiteMutation}}}
createSpace
Description
Used to create a new space for a floor in a building.
Response
Returns a SpaceCreateResponse
Arguments
| Name | Description |
|---|---|
input - SpaceCreateRequestInput
|
Provide the required input values here, such as the name and exactType of the building (such as Office). |
Example
Query
mutation createSpace($input: SpaceCreateRequestInput) {
createSpace(input: $input) {
space {
...SpaceMutationFragment
}
}
}
Variables
{"input": SpaceCreateRequestInput}
Response
{"data": {"createSpace": {"space": SpaceMutation}}}
createUser
Description
Used to create a new user in the organization; only available for admins.
Response
Returns a UserCreateResponse
Arguments
| Name | Description |
|---|---|
input - UserCreateRequestInput
|
Provide the required input values here, including user details like name and email address. |
Example
Query
mutation createUser($input: UserCreateRequestInput) {
createUser(input: $input) {
user {
...UserFragment
}
}
}
Variables
{"input": UserCreateRequestInput}
Response
{"data": {"createUser": {"user": User}}}
createWebhookTarget
Description
Used to create a new webhook.
Response
Returns a WebhookTargetCreateResponse
Arguments
| Name | Description |
|---|---|
input - WebhookTargetCreateRequestInput
|
Provide the required input values here, including the name of the webhook and the actual target destination such as an HTTP URL. |
Example
Query
mutation createWebhookTarget($input: WebhookTargetCreateRequestInput) {
createWebhookTarget(input: $input) {
target {
...WebhookTargetFragment
}
}
}
Variables
{"input": WebhookTargetCreateRequestInput}
Response
{
"data": {
"createWebhookTarget": {"target": WebhookTarget}
}
}
deleteBuilding
Description
Used to delete an existing building.
Response
Returns a BuildingDeleteResponse
Arguments
| Name | Description |
|---|---|
input - BuildingDeleteRequestInput
|
Provide the ID of the building you want to delete here. |
Example
Query
mutation deleteBuilding($input: BuildingDeleteRequestInput) {
deleteBuilding(input: $input) {
_
}
}
Variables
{"input": BuildingDeleteRequestInput}
Response
{
"data": {
"deleteBuilding": {"_": "abc123"}
}
}
deleteConnector
Description
Used to remove an existing Connector.
Response
Returns a ConnectorDeleteResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorDeleteRequestInput
|
Provide the ID of the Connector you want to delete here. |
Example
Query
mutation deleteConnector($input: ConnectorDeleteRequestInput) {
deleteConnector(input: $input) {
_
}
}
Variables
{"input": ConnectorDeleteRequestInput}
Response
{
"data": {
"deleteConnector": {"_": "xyz789"}
}
}
deleteConnectorAuth
Description
Used to delete the auth settings for a specific Connector.
Response
Returns a ConnectorAuthDeleteResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorAuthDeleteRequestInput
|
Provide the ID of the Connector auth you want to delete here; note this is not the same ID as the connector itself. |
Example
Query
mutation deleteConnectorAuth($input: ConnectorAuthDeleteRequestInput) {
deleteConnectorAuth(input: $input) {
_
}
}
Variables
{"input": ConnectorAuthDeleteRequestInput}
Response
{
"data": {
"deleteConnectorAuth": {"_": "abc123"}
}
}
deleteFloor
Description
Used to delete an existing floor in a building.
Response
Returns a FloorDeleteResponse
Arguments
| Name | Description |
|---|---|
input - FloorDeleteRequestInput
|
Provide the ID of the floor you want to delete here. |
Example
Query
mutation deleteFloor($input: FloorDeleteRequestInput) {
deleteFloor(input: $input) {
_
}
}
Variables
{"input": FloorDeleteRequestInput}
Response
{"data": {"deleteFloor": {"_": "abc123"}}}
deleteGrant
Description
Currently in development; will be used to remove an access grant from an external user.
Response
Returns a GrantDeleteResponse
Arguments
| Name | Description |
|---|---|
input - GrantDeleteRequestInput
|
Provide the required input values here, such as the ID of the grant you want to delete. |
Example
Query
mutation deleteGrant($input: GrantDeleteRequestInput) {
deleteGrant(input: $input) {
_
}
}
Variables
{"input": GrantDeleteRequestInput}
Response
{"data": {"deleteGrant": {"_": "abc123"}}}
deleteInvite
Description
Used to delete an user invite.
Response
Returns an InviteDeleteResponse
Arguments
| Name | Description |
|---|---|
input - InviteDeleteRequestInput
|
Provide the ID of the invite you want to delete here. |
Example
Query
mutation deleteInvite($input: InviteDeleteRequestInput) {
deleteInvite(input: $input) {
_
}
}
Variables
{"input": InviteDeleteRequestInput}
Response
{"data": {"deleteInvite": {"_": "xyz789"}}}
deleteLiveQuery
Description
Used to delete a live query.
Response
Returns a LiveQueryDeleteResponse
Arguments
| Name | Description |
|---|---|
input - LiveQueryDeleteRequestInput
|
Provide the ID of the live query you want to delete here. |
Example
Query
mutation deleteLiveQuery($input: LiveQueryDeleteRequestInput) {
deleteLiveQuery(input: $input) {
_
}
}
Variables
{"input": LiveQueryDeleteRequestInput}
Response
{
"data": {
"deleteLiveQuery": {"_": "xyz789"}
}
}
deletePersonalAccessToken
Description
Used to delete an existing personal access token, assuming the token you're using has the needed scope (PERSONALACCESSTOKEN_READWRITE or the admin scope PERSONALACCESSTOKEN_READWRITE_ALL).
Response
Returns a PersonalAccessTokenDeleteResponse
Arguments
| Name | Description |
|---|---|
input - PersonalAccessTokenDeleteRequestInput
|
Provide the ID of the connector you want to delete here; note this is not the actual token itself, it is the ID for the token. |
Example
Query
mutation deletePersonalAccessToken($input: PersonalAccessTokenDeleteRequestInput) {
deletePersonalAccessToken(input: $input) {
_
}
}
Variables
{"input": PersonalAccessTokenDeleteRequestInput}
Response
{
"data": {
"deletePersonalAccessToken": {
"_": "abc123"
}
}
}
deleteSite
Description
Used to delete a specific site from the org.
Response
Returns a SiteDeleteResponse
Arguments
| Name | Description |
|---|---|
input - SiteDeleteRequestInput
|
Provide the ID of the site you want to delete here. |
Example
Query
mutation deleteSite($input: SiteDeleteRequestInput) {
deleteSite(input: $input) {
_
}
}
Variables
{"input": SiteDeleteRequestInput}
Response
{"data": {"deleteSite": {"_": "abc123"}}}
deleteSpace
Description
Used to delete a specific space from a floor in a building.
Response
Returns a SpaceDeleteResponse
Arguments
| Name | Description |
|---|---|
input - SpaceDeleteRequestInput
|
Provide the ID of the space you want to delete here. |
Example
Query
mutation deleteSpace($input: SpaceDeleteRequestInput) {
deleteSpace(input: $input) {
_
}
}
Variables
{"input": SpaceDeleteRequestInput}
Response
{"data": {"deleteSpace": {"_": "xyz789"}}}
deleteWebhookTarget
Description
Used to delete a specific webhook.
Response
Returns a WebhookTargetDeleteResponse
Arguments
| Name | Description |
|---|---|
input - WebhookTargetDeleteRequestInput
|
Provide the ID of the webhook you want to delete here. |
Example
Query
mutation deleteWebhookTarget($input: WebhookTargetDeleteRequestInput) {
deleteWebhookTarget(input: $input) {
_
}
}
Variables
{"input": WebhookTargetDeleteRequestInput}
Response
{
"data": {
"deleteWebhookTarget": {"_": "abc123"}
}
}
doesOrgExist
Response
Returns a BusinessDoesOrgExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgExistRequestInput
|
Example
Query
mutation doesOrgExist($input: BusinessDoesOrgExistRequestInput) {
doesOrgExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgExistRequestInput}
Response
{"data": {"doesOrgExist": {"exists": false}}}
doesOrgFeatureExist
Response
Returns a BusinessDoesOrgFeatureExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgFeatureExistRequestInput
|
Example
Query
mutation doesOrgFeatureExist($input: BusinessDoesOrgFeatureExistRequestInput) {
doesOrgFeatureExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgFeatureExistRequestInput}
Response
{"data": {"doesOrgFeatureExist": {"exists": false}}}
doesOrgHaveAccessToPlan
Response
Returns a BusinessDoesOrgHaveAccessToPlanResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgHaveAccessToPlanRequestInput
|
Example
Query
mutation doesOrgHaveAccessToPlan($input: BusinessDoesOrgHaveAccessToPlanRequestInput) {
doesOrgHaveAccessToPlan(input: $input) {
hasAccess
}
}
Variables
{"input": BusinessDoesOrgHaveAccessToPlanRequestInput}
Response
{"data": {"doesOrgHaveAccessToPlan": {"hasAccess": false}}}
doesOrgPermissionExist
Response
Returns a BusinessDoesOrgPermissionExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgPermissionExistRequestInput
|
Example
Query
mutation doesOrgPermissionExist($input: BusinessDoesOrgPermissionExistRequestInput) {
doesOrgPermissionExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgPermissionExistRequestInput}
Response
{"data": {"doesOrgPermissionExist": {"exists": false}}}
doesOrgPlanExist
Response
Returns a BusinessDoesOrgPlanExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgPlanExistRequestInput
|
Example
Query
mutation doesOrgPlanExist($input: BusinessDoesOrgPlanExistRequestInput) {
doesOrgPlanExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgPlanExistRequestInput}
Response
{"data": {"doesOrgPlanExist": {"exists": false}}}
doesOrgPlanGroupExist
Response
Returns a BusinessDoesOrgPlanGroupExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgPlanGroupExistRequestInput
|
Example
Query
mutation doesOrgPlanGroupExist($input: BusinessDoesOrgPlanGroupExistRequestInput) {
doesOrgPlanGroupExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgPlanGroupExistRequestInput}
Response
{"data": {"doesOrgPlanGroupExist": {"exists": true}}}
doesOrgPlanGroupPlanExist
Response
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgPlanGroupPlanExistRequestInput
|
Example
Query
mutation doesOrgPlanGroupPlanExist($input: BusinessDoesOrgPlanGroupPlanExistRequestInput) {
doesOrgPlanGroupPlanExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgPlanGroupPlanExistRequestInput}
Response
{"data": {"doesOrgPlanGroupPlanExist": {"exists": false}}}
doesOrgUserExist
Response
Returns a BusinessDoesOrgUserExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesOrgUserExistRequestInput
|
Example
Query
mutation doesOrgUserExist($input: BusinessDoesOrgUserExistRequestInput) {
doesOrgUserExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesOrgUserExistRequestInput}
Response
{"data": {"doesOrgUserExist": {"exists": true}}}
doesPlanFeatureExist
Response
Returns a BusinessDoesPlanFeatureExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesPlanFeatureExistRequestInput
|
Example
Query
mutation doesPlanFeatureExist($input: BusinessDoesPlanFeatureExistRequestInput) {
doesPlanFeatureExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesPlanFeatureExistRequestInput}
Response
{"data": {"doesPlanFeatureExist": {"exists": true}}}
doesPlanProviderExist
Response
Returns a BusinessDoesPlanProviderExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesPlanProviderExistRequestInput
|
Example
Query
mutation doesPlanProviderExist($input: BusinessDoesPlanProviderExistRequestInput) {
doesPlanProviderExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesPlanProviderExistRequestInput}
Response
{"data": {"doesPlanProviderExist": {"exists": true}}}
doesPlanProviderPlanExist
Response
Arguments
| Name | Description |
|---|---|
input - BusinessDoesPlanProviderPlanExistRequestInput
|
Example
Query
mutation doesPlanProviderPlanExist($input: BusinessDoesPlanProviderPlanExistRequestInput) {
doesPlanProviderPlanExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesPlanProviderPlanExistRequestInput}
Response
{"data": {"doesPlanProviderPlanExist": {"exists": true}}}
doesRoleGroupExist
Response
Returns a BusinessDoesRoleGroupExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesRoleGroupExistRequestInput
|
Example
Query
mutation doesRoleGroupExist($input: BusinessDoesRoleGroupExistRequestInput) {
doesRoleGroupExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesRoleGroupExistRequestInput}
Response
{"data": {"doesRoleGroupExist": {"exists": false}}}
doesRoleGroupPermissionExist
Response
Arguments
| Name | Description |
|---|---|
input - BusinessDoesRoleGroupPermissionExistRequestInput
|
Example
Query
mutation doesRoleGroupPermissionExist($input: BusinessDoesRoleGroupPermissionExistRequestInput) {
doesRoleGroupPermissionExist(input: $input) {
exists
}
}
Variables
{
"input": BusinessDoesRoleGroupPermissionExistRequestInput
}
Response
{"data": {"doesRoleGroupPermissionExist": {"exists": false}}}
doesRoleGroupRoleExist
Response
Returns a BusinessDoesRoleGroupRoleExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesRoleGroupRoleExistRequestInput
|
Example
Query
mutation doesRoleGroupRoleExist($input: BusinessDoesRoleGroupRoleExistRequestInput) {
doesRoleGroupRoleExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesRoleGroupRoleExistRequestInput}
Response
{"data": {"doesRoleGroupRoleExist": {"exists": false}}}
doesRoleGroupUserExist
Response
Returns a BusinessDoesRoleGroupUserExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesRoleGroupUserExistRequestInput
|
Example
Query
mutation doesRoleGroupUserExist($input: BusinessDoesRoleGroupUserExistRequestInput) {
doesRoleGroupUserExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesRoleGroupUserExistRequestInput}
Response
{"data": {"doesRoleGroupUserExist": {"exists": false}}}
doesRolePermissionExist
Response
Returns a BusinessDoesRolePermissionExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesRolePermissionExistRequestInput
|
Example
Query
mutation doesRolePermissionExist($input: BusinessDoesRolePermissionExistRequestInput) {
doesRolePermissionExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesRolePermissionExistRequestInput}
Response
{"data": {"doesRolePermissionExist": {"exists": false}}}
doesUserExist
Response
Returns a BusinessDoesUserExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesUserExistRequestInput
|
Example
Query
mutation doesUserExist($input: BusinessDoesUserExistRequestInput) {
doesUserExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesUserExistRequestInput}
Response
{"data": {"doesUserExist": {"exists": false}}}
doesUserPermissionExist
Response
Returns a BusinessDoesUserPermissionExistResponse
Arguments
| Name | Description |
|---|---|
input - BusinessDoesUserPermissionExistRequestInput
|
Example
Query
mutation doesUserPermissionExist($input: BusinessDoesUserPermissionExistRequestInput) {
doesUserPermissionExist(input: $input) {
exists
}
}
Variables
{"input": BusinessDoesUserPermissionExistRequestInput}
Response
{"data": {"doesUserPermissionExist": {"exists": false}}}
enableWebhookTarget
Description
Used to enable or disable a webhook using a true / false boolean.
Response
Returns a WebhookTargetEnableResponse
Arguments
| Name | Description |
|---|---|
input - WebhookTargetEnableRequestInput
|
Provide the ID of the webhook you want to edit, and whether it's enabled (true) or disabled (false) |
Example
Query
mutation enableWebhookTarget($input: WebhookTargetEnableRequestInput) {
enableWebhookTarget(input: $input) {
currentEnabled
id
previousEnabled
}
}
Variables
{"input": WebhookTargetEnableRequestInput}
Response
{
"data": {
"enableWebhookTarget": {
"currentEnabled": false,
"id": "xyz789",
"previousEnabled": true
}
}
}
generateContainerSIDs
Description
Used to generate containerized software gateway security identifiers.
Response
Returns a GatewayGenerateContainerSIDsResponse
Arguments
| Name | Description |
|---|---|
input - GatewayGenerateContainerSIDsRequestInput
|
_ |
Example
Query
mutation generateContainerSIDs($input: GatewayGenerateContainerSIDsRequestInput) {
generateContainerSIDs(input: $input) {
availableCertificateCn
signingCertificateCn
}
}
Variables
{"input": GatewayGenerateContainerSIDsRequestInput}
Response
{
"data": {
"generateContainerSIDs": {
"availableCertificateCn": "xyz789",
"signingCertificateCn": "xyz789"
}
}
}
pauseLiveQuery
Description
Used to pause a live query, so it stops actively monitoring for changes.
Response
Returns a LiveQueryPauseResponse
Arguments
| Name | Description |
|---|---|
input - LiveQueryPauseRequestInput
|
Provide the ID of the live query here. |
Example
Query
mutation pauseLiveQuery($input: LiveQueryPauseRequestInput) {
pauseLiveQuery(input: $input) {
_
}
}
Variables
{"input": LiveQueryPauseRequestInput}
Response
{
"data": {
"pauseLiveQuery": {"_": "xyz789"}
}
}
registerGatewayContainer
Description
Creates the container for a software gateway.
Response
Returns a GatewayRegisterContainerResponse
Arguments
| Name | Description |
|---|---|
input - GatewayRegisterContainerRequestInput
|
Public and private key information for the container will go here. |
Example
Query
mutation registerGatewayContainer($input: GatewayRegisterContainerRequestInput) {
registerGatewayContainer(input: $input) {
deviceId
gatewayId
}
}
Variables
{"input": GatewayRegisterContainerRequestInput}
Response
{
"data": {
"registerGatewayContainer": {
"deviceId": "xyz789",
"gatewayId": "xyz789"
}
}
}
removeOrgMembershipUser
Description
Currently in development; will be used to remove an access grant related org membership for a particular user.
Response
Returns a UserRemoveOrgMembershipResponse
Arguments
| Name | Description |
|---|---|
input - UserRemoveOrgMembershipRequestInput
|
Provide the ID of the user and org here. |
Example
Query
mutation removeOrgMembershipUser($input: UserRemoveOrgMembershipRequestInput) {
removeOrgMembershipUser(input: $input) {
_
}
}
Variables
{"input": UserRemoveOrgMembershipRequestInput}
Response
{
"data": {
"removeOrgMembershipUser": {
"_": "abc123"
}
}
}
removeOrgUser
Response
Returns an OrgRemoveOrgUserAsyncResponse
Arguments
| Name | Description |
|---|---|
input - OrgRemoveOrgUserAsyncRequestInput
|
Example
Query
mutation removeOrgUser($input: OrgRemoveOrgUserAsyncRequestInput) {
removeOrgUser(input: $input) {
_
}
}
Variables
{"input": OrgRemoveOrgUserAsyncRequestInput}
Response
{"data": {"removeOrgUser": {"_": "abc123"}}}
removeRole
Description
Used to remove a role from a user (such as ADMIN).
Response
Returns a UserRemoveRoleResponse
Arguments
| Name | Description |
|---|---|
input - UserRemoveRoleRequestInput
|
Provide the ID of the user, and the role you want to remove. |
Example
Query
mutation removeRole($input: UserRemoveRoleRequestInput) {
removeRole(input: $input) {
user {
...UserFragment
}
}
}
Variables
{"input": UserRemoveRoleRequestInput}
Response
{"data": {"removeRole": {"user": User}}}
restartConnector
Description
Used to restart a Connector, typically a troubleshooting step if a Connector ceases to feed data to the graph.
Response
Returns a ConnectorRestartResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorRestartRequestInput
|
Provide the ID of the Connector here. |
Example
Query
mutation restartConnector($input: ConnectorRestartRequestInput) {
restartConnector(input: $input) {
_
}
}
Variables
{"input": ConnectorRestartRequestInput}
Response
{
"data": {
"restartConnector": {"_": "xyz789"}
}
}
resumeLiveQuery
Description
Used to resume/restart a live query that was paused, so it starts actively monitoring for changes again.
Response
Returns a LiveQueryResumeResponse
Arguments
| Name | Description |
|---|---|
input - LiveQueryResumeRequestInput
|
Provide the ID of the live query here. |
Example
Query
mutation resumeLiveQuery($input: LiveQueryResumeRequestInput) {
resumeLiveQuery(input: $input) {
_
}
}
Variables
{"input": LiveQueryResumeRequestInput}
Response
{
"data": {
"resumeLiveQuery": {"_": "abc123"}
}
}
startConnector
Description
Used to start a Connector back up after it was stopped.
Response
Returns a ConnectorStartResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorStartRequestInput
|
Provide the ID of the Connector here. |
Example
Query
mutation startConnector($input: ConnectorStartRequestInput) {
startConnector(input: $input) {
_
}
}
Variables
{"input": ConnectorStartRequestInput}
Response
{
"data": {
"startConnector": {"_": "abc123"}
}
}
stopConnector
Description
Used to stop a Connector from polling for data or processing incoming webhook data. All config and mapping is preserved.
Response
Returns a ConnectorStopResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorStopRequestInput
|
Provide the ID of the Connector here. |
Example
Query
mutation stopConnector($input: ConnectorStopRequestInput) {
stopConnector(input: $input) {
_
}
}
Variables
{"input": ConnectorStopRequestInput}
Response
{"data": {"stopConnector": {"_": "abc123"}}}
suspendGateway
Description
Used to suspend a gateway; this takes the gateway offline and prevents it from receiving or sending any further data.
Response
Returns a GatewaySuspendResponse
Arguments
| Name | Description |
|---|---|
input - GatewaySuspendRequestInput
|
Provide the ID of the gateway you want to suspend, and the details about the suspension (like notes). |
Example
Query
mutation suspendGateway($input: GatewaySuspendRequestInput) {
suspendGateway(input: $input) {
_
}
}
Variables
{"input": GatewaySuspendRequestInput}
Response
{
"data": {
"suspendGateway": {"_": "xyz789"}
}
}
updateBuilding
Description
Used to update the details of a specific building.
Response
Returns a BuildingUpdateResponse
Arguments
| Name | Description |
|---|---|
input - BuildingUpdateRequestInput
|
Provide the building details you want to update here, such as name and address. |
Example
Query
mutation updateBuilding($input: BuildingUpdateRequestInput) {
updateBuilding(input: $input) {
building {
...BuildingMutationFragment
}
}
}
Variables
{"input": BuildingUpdateRequestInput}
Response
{
"data": {
"updateBuilding": {"building": BuildingMutation}
}
}
updateConnector
Description
Used to update an existing Connector.
Response
Returns a ConnectorUpdateResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorUpdateRequestInput
|
Provide the required input values here, such as config details. |
Example
Query
mutation updateConnector($input: ConnectorUpdateRequestInput) {
updateConnector(input: $input) {
connector {
...ConnectorFragment
}
}
}
Variables
{"input": ConnectorUpdateRequestInput}
Response
{"data": {"updateConnector": {"connector": Connector}}}
updateConnectorAuth
Response
Returns a ConnectorAuthUpdateResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorAuthUpdateRequestInput
|
Example
Query
mutation updateConnectorAuth($input: ConnectorAuthUpdateRequestInput) {
updateConnectorAuth(input: $input) {
connectorAuth {
...ConnectorAuthFragment
}
}
}
Variables
{"input": ConnectorAuthUpdateRequestInput}
Response
{
"data": {
"updateConnectorAuth": {
"connectorAuth": ConnectorAuth
}
}
}
updateFloor
Description
Used to update the details of a specific floor in a building.
Response
Returns a FloorUpdateResponse
Arguments
| Name | Description |
|---|---|
input - FloorUpdateRequestInput
|
Provide the floor details you want to update here, such as level and geoshape. |
Example
Query
mutation updateFloor($input: FloorUpdateRequestInput) {
updateFloor(input: $input) {
floor {
...FloorMutationFragment
}
}
}
Variables
{"input": FloorUpdateRequestInput}
Response
{"data": {"updateFloor": {"floor": FloorMutation}}}
updateGrant
Description
Currently in development; will be used to update/modify an existing access grant.
Response
Returns a GrantUpdateResponse
Arguments
| Name | Description |
|---|---|
input - GrantUpdateRequestInput
|
Provide the required input values here, such as place and type details. |
Example
Query
mutation updateGrant($input: GrantUpdateRequestInput) {
updateGrant(input: $input) {
_
}
}
Variables
{"input": GrantUpdateRequestInput}
Response
{"data": {"updateGrant": {"_": "abc123"}}}
updateInvite
Description
Used to update the details of a specific user invite.
Response
Returns an InviteUpdateResponse
Arguments
| Name | Description |
|---|---|
input - InviteUpdateRequestInput
|
Provide the invite details you want to update here, such as the assigned role. |
Example
Query
mutation updateInvite($input: InviteUpdateRequestInput) {
updateInvite(input: $input) {
invite {
...InviteFragment
}
}
}
Variables
{"input": InviteUpdateRequestInput}
Response
{"data": {"updateInvite": {"invite": Invite}}}
updateLiveQuery
Description
Used to update the details of a specific live query.
Response
Returns a LiveQueryUpdateResponse
Arguments
| Name | Description |
|---|---|
input - LiveQueryUpdateRequestInput
|
Provide the live query details you want to update here, such as the name. |
Example
Query
mutation updateLiveQuery($input: LiveQueryUpdateRequestInput) {
updateLiveQuery(input: $input) {
liveQuery {
...LiveQueryFragment
}
}
}
Variables
{"input": LiveQueryUpdateRequestInput}
Response
{"data": {"updateLiveQuery": {"liveQuery": LiveQuery}}}
updateOrganization
Description
Used to update your organization information, such as the organization name.
Response
Returns an OrgUpdateResponse
Arguments
| Name | Description |
|---|---|
input - OrgUpdateRequestInput
|
Provide the specific org details you want to update here. |
Example
Query
mutation updateOrganization($input: OrgUpdateRequestInput) {
updateOrganization(input: $input) {
org {
...OrgFragment
}
}
}
Variables
{"input": OrgUpdateRequestInput}
Response
{"data": {"updateOrganization": {"org": Org}}}
updateOrganizationV2
Response
Returns an OrgUpdateV2Response
Arguments
| Name | Description |
|---|---|
input - OrgUpdateV2RequestInput
|
Example
Query
mutation updateOrganizationV2($input: OrgUpdateV2RequestInput) {
updateOrganizationV2(input: $input) {
org {
...OrgFragment
}
}
}
Variables
{"input": OrgUpdateV2RequestInput}
Response
{"data": {"updateOrganizationV2": {"org": Org}}}
updatePersonalAccessToken
Description
Used to update the scopes of an existing personal access token.
Response
Returns a PersonalAccessTokenUpdateResponse
Arguments
| Name | Description |
|---|---|
input - PersonalAccessTokenUpdateRequestInput
|
Provide the token details you want to update here, such as permissions/scopes. |
Example
Query
mutation updatePersonalAccessToken($input: PersonalAccessTokenUpdateRequestInput) {
updatePersonalAccessToken(input: $input) {
pat {
...PersonalAccessTokenFragment
}
token
}
}
Variables
{"input": PersonalAccessTokenUpdateRequestInput}
Response
{
"data": {
"updatePersonalAccessToken": {
"pat": PersonalAccessToken,
"token": "xyz789"
}
}
}
updateSite
Description
Used to update the details of a specific site.
Response
Returns a SiteUpdateResponse
Arguments
| Name | Description |
|---|---|
input - SiteUpdateRequestInput
|
Provide the site details you want to update here, such as the name. |
Example
Query
mutation updateSite($input: SiteUpdateRequestInput) {
updateSite(input: $input) {
site {
...SiteMutationFragment
}
}
}
Variables
{"input": SiteUpdateRequestInput}
Response
{"data": {"updateSite": {"site": SiteMutation}}}
updateSpace
Description
Used to update the details of a specific space on a floor in a building.
Response
Returns a SpaceUpdateResponse
Arguments
| Name | Description |
|---|---|
input - SpaceUpdateRequestInput
|
Provide the space details you want to update here, such as name and exactType. |
Example
Query
mutation updateSpace($input: SpaceUpdateRequestInput) {
updateSpace(input: $input) {
space {
...SpaceMutationFragment
}
}
}
Variables
{"input": SpaceUpdateRequestInput}
Response
{"data": {"updateSpace": {"space": SpaceMutation}}}
updateUser
Description
Used to update information about a user. If you're using an admin token, you can update the information of other users; if not, you can only update your own details.
Response
Returns a UserUpdateResponse
Arguments
| Name | Description |
|---|---|
input - UserUpdateRequestInput
|
Provide the specific user details you want to update here, like name. |
Example
Query
mutation updateUser($input: UserUpdateRequestInput) {
updateUser(input: $input) {
user {
...UserFragment
}
}
}
Variables
{"input": UserUpdateRequestInput}
Response
{"data": {"updateUser": {"user": User}}}
updateWebhookTarget
Description
Used to update the details of a specific webhook.
Response
Returns a WebhookTargetUpdateResponse
Arguments
| Name | Description |
|---|---|
input - WebhookTargetUpdateRequestInput
|
Provide the webhook details you want to update here, such as name and maxRetry value. |
Example
Query
mutation updateWebhookTarget($input: WebhookTargetUpdateRequestInput) {
updateWebhookTarget(input: $input) {
target {
...WebhookTargetFragment
}
}
}
Variables
{"input": WebhookTargetUpdateRequestInput}
Response
{
"data": {
"updateWebhookTarget": {"target": WebhookTarget}
}
}
upsertConfigConnector
Description
Currently in development; will be used to update an existing connector configuration, or create a new configuration if one does not already exist.
Response
Returns a ConnectorUpsertConfigResponse
Arguments
| Name | Description |
|---|---|
input - ConnectorUpsertConfigRequestInput
|
Provide the specific config details you want to update here. |
Example
Query
mutation upsertConfigConnector($input: ConnectorUpsertConfigRequestInput) {
upsertConfigConnector(input: $input) {
config
configHash
configUnchanged
id
}
}
Variables
{"input": ConnectorUpsertConfigRequestInput}
Response
{
"data": {
"upsertConfigConnector": {
"config": JSONSchema,
"configHash": "xyz789",
"configUnchanged": false,
"id": "abc123"
}
}
}
Types
APIKey
APIKeyInput
AccessCredentialIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "xyz789"
}
AccessCredentialIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| AccessCredentialIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "xyz789"
}
Address
Example
{
"countryName": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"locality": "abc123",
"postalCode": "abc123",
"region": "abc123",
"streetAddress": "abc123"
}
AddressMutation
Example
{
"countryName": "xyz789",
"id": "abc123",
"locality": "xyz789",
"postalCode": "abc123",
"region": "xyz789",
"streetAddress": "xyz789",
"type": ["abc123"],
"validate": true
}
AddressMutationInput
Example
{
"countryName": "xyz789",
"id": "abc123",
"locality": "xyz789",
"postalCode": "abc123",
"region": "abc123",
"streetAddress": "xyz789",
"type": ["xyz789"],
"validate": false
}
Agent
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "xyz789",
"type": ["abc123"]
}
AgentIdentityUnion
Example
AccessCredentialIdentity
AuthMode
Description
The list of available authorization modes
Values
| Enum Value | Description |
|---|---|
|
|
Example
"PAT"
BACnetObjectId
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "xyz789"
}
BACnetObjectIdModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| BACnetObjectIdModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
BACnetVendorId
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "xyz789"
}
BACnetVendorIdModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| BACnetVendorIdModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
BasicAuth
BasicAuthInput
BillingCalculatedProductBundleResponse
Fields
| Field Name | Description |
|---|---|
calculation - BillingCalculationResponse
|
|
code - Int
|
|
productBundle - ProductBundleResponse
|
|
productSlug - String
|
|
statusMessage - String
|
Example
{
"calculation": BillingCalculationResponse,
"code": 123,
"productBundle": ProductBundleResponse,
"productSlug": "abc123",
"statusMessage": "xyz789"
}
BillingCalculationResponse
Example
{
"fixedPrice": {},
"itemSlug": "xyz789",
"overagePrice": {},
"productPriceItem": ProductPriceItemResponse,
"quantity": {},
"unitPrice": {}
}
BillingProductBundleSubscriptionResponse
Fields
| Field Name | Description |
|---|---|
productBundle - BillingCalculatedProductBundleResponse
|
|
subscriptionId - String
|
Example
{
"productBundle": BillingCalculatedProductBundleResponse,
"subscriptionId": "xyz789"
}
BoolFilterExpressionInput
Boolean
Description
Built-in Boolean
Example
true
Building
Description
Contains all the details of a building.
Fields
| Field Name | Description |
|---|---|
address - Address
|
The address of a building, contains fields that support international addresses. |
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
connectors - [Connector]
|
Any connectors configured for a building will be listed here. |
Arguments
|
|
dateCreated - DateTime
|
This timestamp represents the date the building was created. |
dateUpdated - DateTime
|
This timestamp represents that date the building was last updated. |
description - String
|
The description of a building; often left blank, especially if the building name is already descriptive. |
exactType - String
|
The exactType is the most granular Brick Schema Location type defined for this building. |
floors - [Floor]
|
All the floors present in a building will be listed here. |
Arguments
|
|
hasPart - [Place]
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
In some limited scenarios, a point may be associated with a building as opposed to a thing, like a building electrical meter. Those details will be provided here. |
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of a building. |
identities - [BuildingIdentityUnion]
|
|
isFedBy - [Thing]
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [Thing]
|
Superset of anything that could be in a building - a thing, a person, a meeting (people and meetings currently in development). |
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
This contains the next level up in the place hierarchy; for a building, this will contain site information. |
isPartOfEdges - [IsPartOfEdge]
|
|
mappingKey - String
|
|
name - String
|
The name of a building; often just the street address. |
points - [Point]
|
Any of the points available inside a building will be listed here. |
Arguments
|
|
sites - [Site]
|
The site associated with a building. |
Arguments
|
|
spaces - [Space]
|
|
Arguments
|
|
things - [Thing]
|
All the things associated with a building, or any floor or space in the building, will show here. |
Arguments
|
|
type - [String]
|
Type includes all possible hierarchal types for the building, such as "Place" and "Building". |
Example
{
"address": Address,
"calendarEvents": [CalendarEvent],
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"floors": [Floor],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Thing],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"mappingKey": "xyz789",
"name": "xyz789",
"points": [Point],
"sites": [Site],
"spaces": [Space],
"things": [Thing],
"type": ["abc123"]
}
BuildingCreateRequestInput
Fields
| Input Field | Description |
|---|---|
building - BuildingMutationInput
|
Example
{"building": BuildingMutationInput}
BuildingCreateResponse
Fields
| Field Name | Description |
|---|---|
building - BuildingMutation
|
Example
{"building": BuildingMutation}
BuildingDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
BuildingDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
BuildingFilter
Description
Contains the input values needed to filter building queries.
Fields
| Input Field | Description |
|---|---|
and - [BuildingFilter]
|
Used to combine multiple filter criteria. |
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
Used to filter for a specific ID or IDs (refer to IDFilterExpressionInput for input options). |
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - BuildingFilter
|
Used to omit a specific result or results from the response. |
or - [BuildingFilter]
|
Used to return results that match at least one of the defined criteria. |
type - StringArrayFilterExpressionInput
|
Example
{
"and": [BuildingFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": BuildingFilter,
"or": [BuildingFilter],
"type": StringArrayFilterExpressionInput
}
BuildingIdentityUnion
Example
AccessCredentialIdentity
BuildingMutation
Fields
| Field Name | Description |
|---|---|
address - AddressMutation
|
|
geoshape - GeoJSON
|
No longer supported |
id - String
|
|
name - String
|
|
siteId - String
|
Example
{
"address": AddressMutation,
"geoshape": GeoJSON,
"id": "abc123",
"name": "xyz789",
"siteId": "abc123"
}
BuildingMutationInput
Fields
| Input Field | Description |
|---|---|
address - AddressMutationInput
|
|
id - String
|
|
name - String
|
|
siteId - String
|
Example
{
"address": AddressMutationInput,
"id": "xyz789",
"name": "abc123",
"siteId": "xyz789"
}
BuildingUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
building - BuildingMutationInput
|
Example
{"building": BuildingMutationInput}
BuildingUpdateResponse
Fields
| Field Name | Description |
|---|---|
building - BuildingMutation
|
Example
{"building": BuildingMutation}
BundleState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BUNDLE_STATE_ACTIVE"
BusinessDoesOrgExistRequestInput
Fields
| Input Field | Description |
|---|---|
orgId - String
|
Example
{"orgId": "xyz789"}
BusinessDoesOrgExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesOrgFeatureExistRequestInput
BusinessDoesOrgFeatureExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesOrgHaveAccessToPlanRequestInput
BusinessDoesOrgHaveAccessToPlanResponse
Fields
| Field Name | Description |
|---|---|
hasAccess - Boolean
|
Example
{"hasAccess": true}
BusinessDoesOrgPermissionExistRequestInput
BusinessDoesOrgPermissionExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": false}
BusinessDoesOrgPlanExistRequestInput
BusinessDoesOrgPlanExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": false}
BusinessDoesOrgPlanGroupExistRequestInput
BusinessDoesOrgPlanGroupExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesOrgPlanGroupPlanExistRequestInput
BusinessDoesOrgPlanGroupPlanExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesOrgUserExistRequestInput
Fields
| Input Field | Description |
|---|---|
orgId - String
|
|
user - BusinessUserInput
|
Example
{
"orgId": "xyz789",
"user": BusinessUserInput
}
BusinessDoesOrgUserExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesPlanFeatureExistRequestInput
BusinessDoesPlanFeatureExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesPlanProviderExistRequestInput
Fields
| Input Field | Description |
|---|---|
planProvider - String
|
Example
{"planProvider": "abc123"}
BusinessDoesPlanProviderExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": false}
BusinessDoesPlanProviderPlanExistRequestInput
BusinessDoesPlanProviderPlanExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesRoleGroupExistRequestInput
BusinessDoesRoleGroupExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesRoleGroupPermissionExistRequestInput
BusinessDoesRoleGroupPermissionExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesRoleGroupRoleExistRequestInput
BusinessDoesRoleGroupRoleExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": false}
BusinessDoesRoleGroupUserExistRequestInput
Fields
| Input Field | Description |
|---|---|
orgId - String
|
|
roleGroup - String
|
|
user - BusinessUserInput
|
Example
{
"orgId": "abc123",
"roleGroup": "xyz789",
"user": BusinessUserInput
}
BusinessDoesRoleGroupUserExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": false}
BusinessDoesRolePermissionExistRequestInput
BusinessDoesRolePermissionExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessDoesUserExistRequestInput
Fields
| Input Field | Description |
|---|---|
user - BusinessUserInput
|
|
userRepo - BusinessUserRepoTypeInput
|
Example
{
"user": BusinessUserInput,
"userRepo": "USERREPOTYPE_ADMIN"
}
BusinessDoesUserExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": false}
BusinessDoesUserPermissionExistRequestInput
Fields
| Input Field | Description |
|---|---|
orgId - String
|
|
permission - String
|
|
user - BusinessUserInput
|
Example
{
"orgId": "abc123",
"permission": "abc123",
"user": BusinessUserInput
}
BusinessDoesUserPermissionExistResponse
Fields
| Field Name | Description |
|---|---|
exists - Boolean
|
Example
{"exists": true}
BusinessUserInput
BusinessUserRepoTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"USERREPOTYPE_ADMIN"
CalendarEvent
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
endTime - DateTime
|
|
exactType - String
|
|
hasInvitations - [CalendarInvitation]
|
|
hasInvitees - [CalendarInvitee]
|
|
id - String!
|
|
identities - [CalendarEventIdentityUnion]
|
|
mappingKey - String
|
|
name - String
|
|
startTime - DateTime
|
|
type - [String]
|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"endTime": "2007-12-03T10:15:30Z",
"exactType": "abc123",
"hasInvitations": [CalendarInvitation],
"hasInvitees": [Person],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "xyz789",
"startTime": "2007-12-03T10:15:30Z",
"type": ["abc123"]
}
CalendarEventFilter
Fields
| Input Field | Description |
|---|---|
and - [CalendarEventFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
endTime - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
hasInviteeEmail - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - CalendarEventFilter
|
|
or - [CalendarEventFilter]
|
|
startTime - TimestampFilterExpressionInput
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [CalendarEventFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"endTime": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"hasInviteeEmail": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": CalendarEventFilter,
"or": [CalendarEventFilter],
"startTime": TimestampFilterExpressionInput,
"type": StringArrayFilterExpressionInput
}
CalendarEventIdentityUnion
Example
AccessCredentialIdentity
CalendarInvitation
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
email - EmailAddress!
|
|
event - CalendarEvent
|
|
exactType - String
|
|
hasInvitee - CalendarInvitee
|
|
id - String!
|
|
identities - [CalendarInvitationIdentityUnion]
|
|
mappingKey - String
|
|
name - String
|
|
response - CalendarInvitationResponse
|
|
type - [String]
|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"email": EmailAddress,
"event": CalendarEvent,
"exactType": "xyz789",
"hasInvitee": Person,
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "xyz789",
"response": "ACCEPTED",
"type": ["xyz789"]
}
CalendarInvitationFilter
Fields
| Input Field | Description |
|---|---|
and - [CalendarInvitationFilter]
|
|
dateCreated - DateTimeFilterExpressionInput
|
|
dateUpdated - DateTimeFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - StringFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - CalendarInvitationFilter
|
|
or - [CalendarInvitationFilter]
|
|
response - CalendarInvitationResponseFilterExpressionInput
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [CalendarInvitationFilter],
"dateCreated": DateTimeFilterExpressionInput,
"dateUpdated": DateTimeFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": StringFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": CalendarInvitationFilter,
"or": [CalendarInvitationFilter],
"response": CalendarInvitationResponseFilterExpressionInput,
"type": StringArrayFilterExpressionInput
}
CalendarInvitationIdentityUnion
Example
AccessCredentialIdentity
CalendarInvitationResponse
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
CalendarInvitationResponseFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - CalendarInvitationResponse
|
|
in - [CalendarInvitationResponse]
|
Example
{"eq": "ACCEPTED", "in": ["ACCEPTED"]}
CalendarInvitee
CloudEventSourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLOUDEVENTSOURCETYPE_UNSPECIFIED"
CloudEventSourceTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLOUDEVENTSOURCETYPE_UNSPECIFIED"
Connector
Description
Contains the details about a Connector.
Fields
| Field Name | Description |
|---|---|
buildings - [Building]
|
|
Arguments
|
|
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
|
|
id - String
|
The unique id of a Connector. |
lastSeen - DateTime
|
|
lastUpdatedBy - String
|
|
name - String
|
The name of a Connector you provided when setting it up for your org. |
organization - Org
|
Contains the details about the organization associated with this Connector. |
points - [Point]
|
Lists all the points returned by the Connector. |
Arguments
|
|
sites - [Site]
|
|
Arguments
|
|
spaces - [Space]
|
|
Arguments
|
|
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
|
|
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. |
Example
{
"buildings": [Building],
"config": JSONSchema,
"configHash": "xyz789",
"connectorType": ConnectorType,
"connectorTypeId": "abc123",
"contributions": [ConnectorContribution],
"created": "2007-12-03T10:15:30Z",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"floors": [Floor],
"id": "abc123",
"lastSeen": "2007-12-03T10:15:30Z",
"lastUpdatedBy": "xyz789",
"name": "abc123",
"organization": Org,
"points": [Point],
"sites": [Site],
"spaces": [Space],
"state": "ACTIVE",
"stateDetails": "xyz789",
"things": [Thing],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789",
"workflowId": "xyz789"
}
ConnectorAuth
ConnectorAuthAccessRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ConnectorAuthCreateRequestInput
Description
Contains the input values needed to create an Connector auth.
Fields
| Input Field | Description |
|---|---|
secret - ConnectorAuthRequestSecretInput
|
Example
{"secret": ConnectorAuthRequestSecretInput}
ConnectorAuthCreateResponse
Fields
| Field Name | Description |
|---|---|
connectorAuth - ConnectorAuth
|
Example
{"connectorAuth": ConnectorAuth}
ConnectorAuthDeleteRequestInput
Description
Contains the input values needed to delete Connector auth.
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ConnectorAuthDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
ConnectorAuthInput
ConnectorAuthRequestSecretInput
Fields
| Input Field | Description |
|---|---|
refreshToken - ConnectorServicesRefreshTokenInput
|
|
staticToken - ConnectorAuthStaticTokenInput
|
|
usernamePassword - ConnectorAuthUsernamePasswordInput
|
Example
{
"refreshToken": ConnectorServicesRefreshTokenInput,
"staticToken": ConnectorAuthStaticTokenInput,
"usernamePassword": ConnectorAuthUsernamePasswordInput
}
ConnectorAuthResponseSecret
Fields
| Field Name | Description |
|---|---|
accessToken - ConnectorServicesAccessToken
|
|
staticToken - ConnectorAuthStaticToken
|
|
usernamePassword - ConnectorAuthUsernamePassword
|
Example
{
"accessToken": ConnectorServicesAccessToken,
"staticToken": ConnectorAuthStaticToken,
"usernamePassword": ConnectorAuthUsernamePassword
}
ConnectorAuthStaticToken
Fields
| Field Name | Description |
|---|---|
token - String
|
Example
{"token": "xyz789"}
ConnectorAuthStaticTokenInput
Fields
| Input Field | Description |
|---|---|
token - String
|
Example
{"token": "xyz789"}
ConnectorAuthUpdateRequestInput
Description
Contains the input values needed to update Connector auth.
Fields
| Input Field | Description |
|---|---|
connectorAuth - ConnectorAuthInput
|
|
secret - ConnectorAuthRequestSecretInput
|
Example
{
"connectorAuth": ConnectorAuthInput,
"secret": ConnectorAuthRequestSecretInput
}
ConnectorAuthUpdateResponse
Fields
| Field Name | Description |
|---|---|
connectorAuth - ConnectorAuth
|
Example
{"connectorAuth": ConnectorAuth}
ConnectorAuthUsernamePassword
ConnectorAuthUsernamePasswordInput
ConnectorContribution
ConnectorCreateRequestInput
Description
Contains the input values needed to create a Connector.
Fields
| Input Field | Description |
|---|---|
connector - ConnectorInput
|
Example
{"connector": ConnectorInput}
ConnectorCreateResponse
Fields
| Field Name | Description |
|---|---|
connector - Connector
|
Example
{"connector": Connector}
ConnectorDeleteRequestInput
Description
Contains the input values needed to delete a Connector.
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
ConnectorDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
ConnectorFilterInput
Description
Contains the input values needed to filter Connector queries.
Fields
| Input Field | Description |
|---|---|
connectorTypeId - IDFilterExpressionInput
|
Used if you want to filter by a connectorType instead of a specific Connector installation. |
direction - ConnectorTypeConnectorDirectionFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
Used to filter for a specific ID or IDs (refer to IDFilterExpressionInput for input options). |
Example
{
"connectorTypeId": IDFilterExpressionInput,
"direction": ConnectorTypeConnectorDirectionFilterExpressionInput,
"id": IDFilterExpressionInput
}
ConnectorInput
Description
Contains the details about a Connector.
Fields
| Input Field | Description |
|---|---|
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. |
connectorTypeId - String
|
The unique id of the connector type. |
created - DateTime
|
Timestamp for the Connector's creation. |
direction - ConnectorTypeConnectorDirectionInput
|
|
id - String
|
The unique id of a Connector. |
lastSeen - DateTime
|
|
lastUpdatedBy - String
|
|
name - String
|
The name of a Connector you provided when setting it up for your org. |
state - ConnectorStateInput
|
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. |
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. |
Example
{
"config": JSONSchema,
"configHash": "abc123",
"connectorTypeId": "abc123",
"created": "2007-12-03T10:15:30Z",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"id": "xyz789",
"lastSeen": "2007-12-03T10:15:30Z",
"lastUpdatedBy": "xyz789",
"name": "abc123",
"state": "ACTIVE",
"stateDetails": "abc123",
"updated": "2007-12-03T10:15:30Z",
"userId": "abc123",
"workflowId": "xyz789"
}
ConnectorRequest
ConnectorRequestCreateRequestInput
Fields
| Input Field | Description |
|---|---|
connectorTypeId - String
|
Example
{"connectorTypeId": "abc123"}
ConnectorRequestCreateResponse
Fields
| Field Name | Description |
|---|---|
request - ConnectorRequest
|
Example
{"request": ConnectorRequest}
ConnectorRestartRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ConnectorRestartResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
ConnectorServicesAccessToken
Fields
| Field Name | Description |
|---|---|
accessToken - String
|
|
expiration - DateTime
|
|
tokenType - ConnectorServicesAccessTokenType
|
Example
{
"accessToken": "xyz789",
"expiration": "2007-12-03T10:15:30Z",
"tokenType": "ACCESSTOKENTYPE_UNSPECIFIED"
}
ConnectorServicesAccessTokenType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACCESSTOKENTYPE_UNSPECIFIED"
ConnectorServicesRefreshTokenInput
ConnectorStartRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
ConnectorStartResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
ConnectorState
Description
Current state of the Connector.
Values
| Enum Value | Description |
|---|---|
|
|
Connector is up and running, retrieving data from the device vendor. |
|
|
|
|
|
|
|
|
Connector state cannot be identified, contact [email protected] for help. |
|
|
Connector was deleted, displays for audit purposes. |
|
|
Transient state, displayed while Connector is in process of deletion. |
|
|
Connector is in an error state, contact [email protected] for help. |
|
|
Connector is stopped, no longer retrieving data from the device vendor, but still exists and can be restarted. |
|
|
Transient state, displayed while Connector is in process of stopping. |
Example
"ACTIVE"
ConnectorStateInput
Description
Current state of the Connector.
Values
| Enum Value | Description |
|---|---|
|
|
Connector is up and running, retrieving data from the device vendor. |
|
|
|
|
|
|
|
|
Connector state cannot be identified, contact [email protected] for help. |
|
|
Connector was deleted, displays for audit purposes. |
|
|
Transient state, displayed while Connector is in process of deletion. |
|
|
Connector is in an error state, contact [email protected] for help. |
|
|
Connector is stopped, no longer retrieving data from the device vendor, but still exists and can be restarted. |
|
|
Transient state, displayed while Connector is in process of stopping. |
Example
"ACTIVE"
ConnectorStopRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ConnectorStopResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
ConnectorType
Description
Contains Connector type details.
Fields
| Field Name | Description |
|---|---|
configSchema - JSONSchema
|
This is the JSON schema used to define how the config for a Connector needs to look. |
description - String
|
The description of the Connector type. |
direction - ConnectorTypeConnectorDirection
|
Reflects whether the Connector is SOURCE (ingress, data from the vendor to your org) or DESTINATION (egress, data from your org to an external destination like a data lake). |
id - String
|
The unique ID of the Connector type. |
name - String
|
The uneditable, assigned name of the Connector type; this is not the same as the Connector name defined by you when adding it to your org.. |
taskQueue - 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. |
version - String
|
This identifies the version of the Connector setup in your org; Connectors may have multiple versions available. |
Example
{
"configSchema": JSONSchema,
"description": "abc123",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"id": "abc123",
"name": "abc123",
"taskQueue": "xyz789",
"version": "abc123"
}
ConnectorTypeConnectorDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONNECTOR_DIRECTION_UNSPECIFIED"
ConnectorTypeConnectorDirectionFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - ConnectorTypeConnectorDirectionInput
|
|
in - [ConnectorTypeConnectorDirectionInput]
|
Example
{
"eq": "CONNECTOR_DIRECTION_UNSPECIFIED",
"in": ["CONNECTOR_DIRECTION_UNSPECIFIED"]
}
ConnectorTypeConnectorDirectionInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONNECTOR_DIRECTION_UNSPECIFIED"
ConnectorTypeFilterInput
Description
Used to filter the Connector type results.
Fields
| Input Field | Description |
|---|---|
connectorTypeId - IDFilterExpressionInput
|
The ID of the Connector type. |
description - IDFilterExpressionInput
|
The description of the Connector type. |
direction - ConnectorTypeConnectorDirectionFilterExpressionInput
|
|
name - IDFilterExpressionInput
|
The name of the Connector type. |
version - IDFilterExpressionInput
|
The version of the Connector type. |
Example
{
"connectorTypeId": IDFilterExpressionInput,
"description": IDFilterExpressionInput,
"direction": ConnectorTypeConnectorDirectionFilterExpressionInput,
"name": IDFilterExpressionInput,
"version": IDFilterExpressionInput
}
ConnectorTypeListAvailableResponse
Fields
| Field Name | Description |
|---|---|
available - [ConnectorType]
|
|
connectorTypes - [ConnectorType]
|
No longer supported |
requested - [ConnectorType]
|
|
uponRequest - [ConnectorType]
|
Example
{