Queries
accessConnectorAuth
Response
Returns a ConnectorAuthResponseSecret
Arguments
| Name | Description |
|---|---|
input - ConnectorAuthAccessRequestInput
|
Example
Query
query accessConnectorAuth($input: ConnectorAuthAccessRequestInput) {
accessConnectorAuth(input: $input) {
staticToken {
...ConnectorAuthStaticTokenFragment
}
usernamePassword {
...ConnectorAuthUsernamePasswordFragment
}
}
}
Variables
{"input": ConnectorAuthAccessRequestInput}
Response
{
"data": {
"accessConnectorAuth": {
"staticToken": ConnectorAuthStaticToken,
"usernamePassword": ConnectorAuthUsernamePassword
}
}
}
accessTokenFromPAT
Response
Returns a String
Arguments
| Name | Description |
|---|---|
input - PersonalAccessTokenGetAccessTokenFromPATRequestInput
|
Example
Query
query accessTokenFromPAT($input: PersonalAccessTokenGetAccessTokenFromPATRequestInput) {
accessTokenFromPAT(input: $input)
}
Variables
{
"input": PersonalAccessTokenGetAccessTokenFromPATRequestInput
}
Response
{"data": {"accessTokenFromPAT": "abc123"}}
accounts
Response
Returns [Account]
Arguments
| Name | Description |
|---|---|
filter - AccountFilter
|
Example
Query
query accounts($filter: AccountFilter) {
accounts(filter: $filter) {
connectedDataSourceId
dateCreated
dateUpdated
description
exactType
hasBill {
...PointFragment
}
hasBillEdges {
...HasBillEdgeFragment
}
hasProvider {
...OrganizationFragment
}
hasProviderEdges {
...HasProviderEdgeFragment
}
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": AccountFilter}
Response
{
"data": {
"accounts": [
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "xyz789",
"hasBill": [Point],
"hasBillEdges": [HasBillEdge],
"hasProvider": [Organization],
"hasProviderEdges": [HasProviderEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "abc123",
"name": "xyz789",
"type": ["xyz789"]
}
]
}
}
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": false,
"includeUponRequest": false
}
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
}
collections {
...CollectionFragment
}
connectedDataSourceId
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
floors {
...FloorFragment
}
geolocation {
...GeoPointQuantityFragment
}
geolocationEdges {
...GeolocationEdgeFragment
}
grossArea {
...AreaQuantityFragment
}
grossAreaEdges {
...GrossAreaEdgeFragment
}
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
}
}
isAdjacentTo {
...PlaceFragment
}
isAdjacentToEdges {
...IsAdjacentToEdgeFragment
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isServedBy {
...ThingFragment
}
isServedByEdges {
...IsServedByEdgeFragment
}
mappingKey
name
points {
...PointFragment
}
rentableArea {
...AreaQuantityFragment
}
rentableAreaEdges {
...RentableAreaEdgeFragment
}
sites {
...SiteFragment
}
spaces {
...SpaceFragment
}
things {
...ThingFragment
}
timeZone
type
usableArea {
...AreaQuantityFragment
}
usableAreaEdges {
...UsableAreaEdgeFragment
}
}
}
Variables
{"filter": BuildingFilter}
Response
{
"data": {
"buildings": [
{
"address": Address,
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"floors": [Floor],
"geolocation": GeoPointQuantity,
"geolocationEdges": [GeolocationEdge],
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"sites": [Site],
"spaces": [Space],
"things": [Thing],
"timeZone": "abc123",
"type": ["xyz789"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
]
}
}
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) {
connectedDataSourceId
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": [
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"endTime": "2007-12-03T10:15:30Z",
"exactType": "abc123",
"hasInvitations": [CalendarInvitation],
"hasInvitees": [Person],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "abc123",
"startTime": "2007-12-03T10:15:30Z",
"type": ["abc123"]
}
]
}
}
collections
Response
Returns [Collection]
Arguments
| Name | Description |
|---|---|
filter - CollectionFilter
|
Example
Query
query collections($filter: CollectionFilter) {
collections(filter: $filter) {
connectedDataSourceId
dateCreated
dateUpdated
description
exactType
feeds {
... on Building {
...BuildingFragment
}
... on Collection {
...CollectionFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
feedsEdges {
...FeedsEdgeFragment
}
hasLocation {
...PlaceFragment
}
hasLocationEdges {
...HasLocationEdgeFragment
}
hasPart {
... on Building {
...BuildingFragment
}
... on Collection {
...CollectionFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
hasPartEdges {
...HasPartEdgeFragment
}
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 {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isFedByEdges {
...IsFedByEdgeFragment
}
mappingKey
name
points {
...PointFragment
}
type
}
}
Variables
{"filter": CollectionFilter}
Response
{
"data": {
"collections": [
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"feeds": [Building],
"feedsEdges": [FeedsEdge],
"hasLocation": [Place],
"hasLocationEdges": [HasLocationEdge],
"hasPart": [Building],
"hasPartEdges": [HasPartEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Collection],
"isFedByEdges": [IsFedByEdge],
"mappingKey": "abc123",
"name": "abc123",
"points": [Point],
"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": "xyz789",
"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
metadata {
...MetadataRecordFragment
}
name
runtimeVersion
taskQueue
version
webhookReceiveStorage
}
}
Variables
{"filter": ConnectorTypeFilterInput}
Response
{
"data": {
"connectorTypes": [
{
"configSchema": JSONSchema,
"description": "xyz789",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"id": "abc123",
"metadata": [MetadataRecord],
"name": "abc123",
"runtimeVersion": "RUNTIMEVERSION_UNSPECIFIED",
"taskQueue": "xyz789",
"version": "abc123",
"webhookReceiveStorage": "RECEIVESTORAGE_CENTRIFUGO_CHANNEL"
}
]
}
}
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) {
baseUrl
buildings {
...BuildingFragment
}
config
configHash
connectorType {
...ConnectorTypeFragment
}
connectorTypeId
contributions {
...ConnectorContributionFragment
}
created
direction
floors {
...FloorFragment
}
id
lastSeen
lastUpdatedBy
name
organization {
...OrgFragment
}
points {
...PointFragment
}
runtimeVersion
sites {
...SiteFragment
}
spaces {
...SpaceFragment
}
state
stateDetails
things {
...ThingFragment
}
updated
userId
workflowId
}
}
Variables
{"filter": ConnectorFilterInput}
Response
{
"data": {
"connectors": [
{
"baseUrl": "abc123",
"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": "abc123",
"name": "abc123",
"organization": Org,
"points": [Point],
"runtimeVersion": "RUNTIMEVERSION_UNSPECIFIED",
"sites": [Site],
"spaces": [Space],
"state": "ACTIVE",
"stateDetails": "xyz789",
"things": [Thing],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789",
"workflowId": "abc123"
}
]
}
}
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
}
collections {
...CollectionFragment
}
connectedDataSourceId
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
geoshape
grossArea {
...AreaQuantityFragment
}
grossAreaEdges {
...GrossAreaEdgeFragment
}
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
}
}
isAdjacentTo {
...PlaceFragment
}
isAdjacentToEdges {
...IsAdjacentToEdgeFragment
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isServedBy {
...ThingFragment
}
isServedByEdges {
...IsServedByEdgeFragment
}
level
mappingKey
name
points {
...PointFragment
}
rentableArea {
...AreaQuantityFragment
}
rentableAreaEdges {
...RentableAreaEdgeFragment
}
spaces {
...SpaceFragment
}
things {
...ThingFragment
}
type
usableArea {
...AreaQuantityFragment
}
usableAreaEdges {
...UsableAreaEdgeFragment
}
zones {
...ZoneFragment
}
}
}
Variables
{"filter": FloorFilter}
Response
{
"data": {
"floors": [
{
"building": Building,
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "xyz789",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"level": 123,
"mappingKey": "abc123",
"name": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"spaces": [Space],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge],
"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": ["xyz789"]
}
]
}
}
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": "xyz789",
"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": "xyz789",
"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": "abc123"}
Response
{
"data": {
"isOrgNameAvailable": {
"isAvailable": false,
"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) {
connectedDataSourceId
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": [
{
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"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": "xyz789",
"organization": Org,
"query": "abc123",
"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
}
roles
tokens {
...PersonalAccessTokenFragment
}
updated
}
}
Response
{
"data": {
"me": {
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"emailVerified": false,
"id": "xyz789",
"lastLogin": "2007-12-03T10:15:30Z",
"loginsCount": {},
"name": "abc123",
"nickname": "abc123",
"orgRoles": ["xyz789"],
"organization": Org,
"roles": ["ADMIN"],
"tokens": [PersonalAccessToken],
"updated": "2007-12-03T10:15:30Z"
}
}
}
orgRoleGroups
Response
Returns [OrgRoleGroupDTO]
Arguments
| Name | Description |
|---|---|
filter - OrgRoleGroupFilterInput
|
Example
Query
query orgRoleGroups($filter: OrgRoleGroupFilterInput) {
orgRoleGroups(filter: $filter) {
createdAt
description
id
isSynced
name
roles
state
updatedAt
}
}
Variables
{"filter": OrgRoleGroupFilterInput}
Response
{
"data": {
"orgRoleGroups": [
{
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": "xyz789",
"isSynced": false,
"name": "abc123",
"roles": ["xyz789"],
"state": "ORGROLEGROUP_STATE_DISABLED",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
orgServiceAccounts
Response
Returns [OrgServiceAccountContainer]
Arguments
| Name | Description |
|---|---|
filter - OrgServiceAccountFilterInput
|
Example
Query
query orgServiceAccounts($filter: OrgServiceAccountFilterInput) {
orgServiceAccounts(filter: $filter) {
orgServiceAccount {
...OrgServiceAccountDTOFragment
}
secrets {
...OrgServiceAccountSecretHintFragment
}
}
}
Variables
{"filter": OrgServiceAccountFilterInput}
Response
{
"data": {
"orgServiceAccounts": [
{
"orgServiceAccount": OrgServiceAccountDTO,
"secrets": [OrgServiceAccountSecretHint]
}
]
}
}
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
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": "xyz789",
"metadata": [MetadataRecord],
"name": "abc123",
"provisioningState": "PROVISIONING_STATE_ACCEPTED",
"sites": [Site],
"state": "ACTIVE",
"stripeCustomerId": "xyz789",
"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
connectedDataSourceId
dateCreated
dateUpdated
description
emails {
...EmailAddressFragment
}
exactType
familyName
givenName
hasAccessCredential {
...AccessCredentialFragment
}
hasAccessCredentialEdges {
...HasAccessCredentialEdgeFragment
}
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
}
}
isMemberOf {
...OrganizationFragment
}
isMemberOfEdges {
...IsMemberOfEdgeFragment
}
mappingKey
name
type
}
}
Variables
{"filter": PersonFilter}
Response
{
"data": {
"people": [
{
"additionalName": "abc123",
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"emails": [EmailAddress],
"exactType": "xyz789",
"familyName": "abc123",
"givenName": "xyz789",
"hasAccessCredential": [AccessCredential],
"hasAccessCredentialEdges": [
HasAccessCredentialEdge
],
"hasCalendarEvents": [CalendarEvent],
"hasCalendarInvitations": [CalendarInvitation],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isMemberOf": [Organization],
"isMemberOfEdges": [IsMemberOfEdge],
"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
}
connectedDataSourceId
datatype
dateCreated
dateUpdated
description
exactType
hasBill {
...PointFragment
}
hasHeartbeat {
...HeartbeatFragment
}
hasHeartbeatEdges {
...HasHeartbeatEdgeFragment
}
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
}
}
isBilledTo {
...AccountFragment
}
isBilledToEdges {
...IsBilledToEdgeFragment
}
isPointOf {
... on Building {
...BuildingFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
isPointOfEdges {
...IsPointOfEdgeFragment
}
mappingKey
name
series {
...TimeseriesRowFragment
}
stateTexts
type
unit {
...UnitFragment
}
unused
valueMap
}
}
Variables
{"filter": PointFilter}
Response
{
"data": {
"points": [
{
"aggregation": [TimeseriesAggregateRow],
"connectedDataSourceId": "xyz789",
"datatype": "DATATYPE_KEY_UNSPECIFIED",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"hasBill": [Point],
"hasHeartbeat": Heartbeat,
"hasHeartbeatEdges": [HasHeartbeatEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isBilledTo": Account,
"isBilledToEdges": [IsBilledToEdge],
"isPointOf": [Building],
"isPointOfEdges": [IsPointOfEdge],
"mappingKey": "abc123",
"name": "abc123",
"series": [TimeseriesRow],
"stateTexts": ["xyz789"],
"type": ["xyz789"],
"unit": Unit,
"unused": true,
"valueMap": Map
}
]
}
}
productBundleSubscriptions
Description
For internal use only.
Response
Example
Query
query productBundleSubscriptions {
productBundleSubscriptions {
productBundle {
...BillingCalculatedProductBundleResponseFragment
}
subscriptionId
}
}
Response
{
"data": {
"productBundleSubscriptions": [
{
"productBundle": BillingCalculatedProductBundleResponse,
"subscriptionId": "abc123"
}
]
}
}
roleManagers
Response
Returns [RoleManagerRoleDTO]
Arguments
| Name | Description |
|---|---|
filter - RoleManagerFilterInput
|
Example
Query
query roleManagers($filter: RoleManagerFilterInput) {
roleManagers(filter: $filter) {
createdAt
description
id
isSynced
metadata {
...MetadataRecordFragment
}
name
permissions
roleType
state
updatedAt
}
}
Variables
{"filter": RoleManagerFilterInput}
Response
{
"data": {
"roleManagers": [
{
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "xyz789",
"isSynced": false,
"metadata": [MetadataRecord],
"name": "abc123",
"permissions": ["xyz789"],
"roleType": "ROLE_TYPE_COMMON",
"state": "ROLE_STATE_DISABLED",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
serviceRequests
Response
Returns [ServiceRequest]
Arguments
| Name | Description |
|---|---|
filter - ServiceRequestFilter
|
Example
Query
query serviceRequests($filter: ServiceRequestFilter) {
serviceRequests(filter: $filter) {
connectedDataSourceId
dateCreated
dateUpdated
description
exactType
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
}
}
isReportedBy {
...PersonFragment
}
isReportedByEdges {
...IsReportedByEdgeFragment
}
isResponsibilityOf {
...PeopleGroupFragment
}
isResponsibilityOfEdges {
...IsResponsibilityOfEdgeFragment
}
jobPriority
mappingKey
name
origin
referenceUrl
relatesTo {
... on Building {
...BuildingFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on ServiceRequest {
...ServiceRequestFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
relatesToEdges {
...RelatesToEdgeFragment
}
requestStatus
sector
summary
type
}
}
Variables
{"filter": ServiceRequestFilter}
Response
{
"data": {
"serviceRequests": [
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"hasAssignee": [Person],
"hasAssigneeEdges": [HasAssigneeEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isReportedBy": Person,
"isReportedByEdges": [IsReportedByEdge],
"isResponsibilityOf": [PeopleGroup],
"isResponsibilityOfEdges": [
IsResponsibilityOfEdge
],
"jobPriority": "xyz789",
"mappingKey": "abc123",
"name": "abc123",
"origin": "abc123",
"referenceUrl": "xyz789",
"relatesTo": [Building],
"relatesToEdges": [RelatesToEdge],
"requestStatus": "xyz789",
"sector": "abc123",
"summary": "xyz789",
"type": ["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
}
collections {
...CollectionFragment
}
connectedDataSourceId
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
grossArea {
...AreaQuantityFragment
}
grossAreaEdges {
...GrossAreaEdgeFragment
}
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
}
}
isAdjacentTo {
...PlaceFragment
}
isAdjacentToEdges {
...IsAdjacentToEdgeFragment
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isServedBy {
...ThingFragment
}
isServedByEdges {
...IsServedByEdgeFragment
}
mappingKey
name
organization {
...OrgFragment
}
points {
...PointFragment
}
rentableArea {
...AreaQuantityFragment
}
rentableAreaEdges {
...RentableAreaEdgeFragment
}
things {
...ThingFragment
}
type
usableArea {
...AreaQuantityFragment
}
usableAreaEdges {
...UsableAreaEdgeFragment
}
}
}
Variables
{"filter": SiteFilter}
Response
{
"data": {
"sites": [
{
"buildings": [Building],
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "xyz789",
"organization": Org,
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["xyz789"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
]
}
}
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
}
collections {
...CollectionFragment
}
connectedDataSourceId
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
floor {
...FloorFragment
}
geoshape
grossArea {
...AreaQuantityFragment
}
grossAreaEdges {
...GrossAreaEdgeFragment
}
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
}
}
isAdjacentTo {
...PlaceFragment
}
isAdjacentToEdges {
...IsAdjacentToEdgeFragment
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isServedBy {
...ThingFragment
}
isServedByEdges {
...IsServedByEdgeFragment
}
mappingKey
maxOccupancy
name
parentSpaceId
points {
...PointFragment
}
rentableArea {
...AreaQuantityFragment
}
rentableAreaEdges {
...RentableAreaEdgeFragment
}
things {
...ThingFragment
}
type
usableArea {
...AreaQuantityFragment
}
usableAreaEdges {
...UsableAreaEdgeFragment
}
}
}
Variables
{"filter": SpaceFilter}
Response
{
"data": {
"spaces": [
{
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "xyz789",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"floor": Floor,
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"maxOccupancy": 123,
"name": "abc123",
"parentSpaceId": "xyz789",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["xyz789"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
]
}
}
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": 123}]}}
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) {
assetTrackingID
connectedDataSourceId
dateCreated
dateInstalled
dateUpdated
description
exactType
feeds {
... on Building {
...BuildingFragment
}
... on Collection {
...CollectionFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... 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 {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isFedByEdges {
...IsFedByEdgeFragment
}
isPartOf {
...ThingFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isResponsibilityOf {
...PeopleGroupFragment
}
isResponsibilityOfEdges {
...IsResponsibilityOfEdgeFragment
}
isVirtual
manufacturedBy {
...AgentFragment
}
manufacturedByEdges {
...ManufacturedByEdgeFragment
}
mappingKey
model {
...DeviceLibraryModelFragment
}
name
organization {
...OrgFragment
}
places {
...PlaceFragment
}
points {
...PointFragment
}
seeAlso
serialNumber
serves {
... on Building {
...BuildingFragment
}
... on Floor {
...FloorFragment
}
... on GenericPlace {
...GenericPlaceFragment
}
... on Organization {
...OrganizationFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... on Zone {
...ZoneFragment
}
}
servesEdges {
...ServesEdgeFragment
}
type
}
}
Variables
{"filter": ThingFilter}
Response
{
"data": {
"things": [
{
"assetTrackingID": "xyz789",
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateInstalled": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"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": [Collection],
"isFedByEdges": [IsFedByEdge],
"isPartOf": [Thing],
"isPartOfEdges": [IsPartOfEdge],
"isResponsibilityOf": [PeopleGroup],
"isResponsibilityOfEdges": [
IsResponsibilityOfEdge
],
"isVirtual": true,
"manufacturedBy": Agent,
"manufacturedByEdges": [ManufacturedByEdge],
"mappingKey": "xyz789",
"model": DeviceLibraryModel,
"name": "xyz789",
"organization": Org,
"places": [Place],
"points": [Point],
"seeAlso": "xyz789",
"serialNumber": "xyz789",
"serves": [Building],
"servesEdges": [ServesEdge],
"type": ["xyz789"]
}
]
}
}
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": "abc123",
"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": "xyz789",
"id": "xyz789",
"name": "abc123"
}
]
}
}
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
}
roles
tokens {
...PersonalAccessTokenFragment
}
updated
}
}
Variables
{"filter": UserFilterInput}
Response
{
"data": {
"users": [
{
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"emailVerified": true,
"id": "abc123",
"lastLogin": "2007-12-03T10:15:30Z",
"loginsCount": {},
"name": "xyz789",
"nickname": "xyz789",
"orgRoles": ["xyz789"],
"organization": Org,
"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": "xyz789",
"maxRetry": {},
"metadata": [WebhookTargetMetadataEntry],
"name": "xyz789",
"organization": Org,
"user": User
}
]
}
}
workOrders
Response
Returns [WorkOrder]
Arguments
| Name | Description |
|---|---|
filter - WorkOrderFilter
|
Example
Query
query workOrders($filter: WorkOrderFilter) {
workOrders(filter: $filter) {
connectedDataSourceId
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 ServiceRequest {
...ServiceRequestFragment
}
... on Site {
...SiteFragment
}
... on Space {
...SpaceFragment
}
... on SubBuilding {
...SubBuildingFragment
}
... on Thing {
...ThingFragment
}
... on Zone {
...ZoneFragment
}
}
relatesToEdges {
...RelatesToEdgeFragment
}
resolutionDescription
sector
subject
summary
type
}
}
Variables
{"filter": WorkOrderFilter}
Response
{
"data": {
"workOrders": [
{
"connectedDataSourceId": "abc123",
"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": "abc123",
"dueDate": "2007-12-03T10:15:30Z",
"exactType": "abc123",
"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": "abc123",
"jobStatus": "abc123",
"jobSubStatus": "xyz789",
"jobType": "xyz789",
"mappingKey": "xyz789",
"name": "abc123",
"problemDescription": "abc123",
"referenceUrl": "xyz789",
"relatesTo": [Building],
"relatesToEdges": [RelatesToEdge],
"resolutionDescription": "abc123",
"sector": "xyz789",
"subject": "abc123",
"summary": "abc123",
"type": ["xyz789"]
}
]
}
}
zones
Response
Returns [Zone]
Arguments
| Name | Description |
|---|---|
filter - ZoneFilter
|
Example
Query
query zones($filter: ZoneFilter) {
zones(filter: $filter) {
calendarEvents {
...CalendarEventFragment
}
collections {
...CollectionFragment
}
connectedDataSourceId
connectors {
...ConnectorFragment
}
dateCreated
dateUpdated
description
exactType
geoshape
grossArea {
...AreaQuantityFragment
}
grossAreaEdges {
...GrossAreaEdgeFragment
}
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
}
}
isAdjacentTo {
...PlaceFragment
}
isAdjacentToEdges {
...IsAdjacentToEdgeFragment
}
isFedBy {
...ThingFragment
}
isFedByEdges {
...IsFedByEdgeFragment
}
isLocationOf {
... on Collection {
...CollectionFragment
}
... on Thing {
...ThingFragment
}
}
isLocationOfEdges {
...IsLocationOfEdgeFragment
}
isPartOf {
...PlaceFragment
}
isPartOfEdges {
...IsPartOfEdgeFragment
}
isServedBy {
...ThingFragment
}
isServedByEdges {
...IsServedByEdgeFragment
}
mappingKey
name
points {
...PointFragment
}
rentableArea {
...AreaQuantityFragment
}
rentableAreaEdges {
...RentableAreaEdgeFragment
}
things {
...ThingFragment
}
type
usableArea {
...AreaQuantityFragment
}
usableAreaEdges {
...UsableAreaEdgeFragment
}
}
}
Variables
{"filter": ZoneFilter}
Response
{
"data": {
"zones": [
{
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "xyz789",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
]
}
}
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": {"_": "xyz789"}}}
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": "abc123"}}}
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": "abc123"
}
}
}
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}}}
createOrgRoleGroup
Response
Returns an OrgRoleGroupCreateResponse
Arguments
| Name | Description |
|---|---|
input - OrgRoleGroupCreateRequestInput
|
Example
Query
mutation createOrgRoleGroup($input: OrgRoleGroupCreateRequestInput) {
createOrgRoleGroup(input: $input) {
orgRoleGroup {
...OrgRoleGroupDTOFragment
}
}
}
Variables
{"input": OrgRoleGroupCreateRequestInput}
Response
{
"data": {
"createOrgRoleGroup": {
"orgRoleGroup": OrgRoleGroupDTO
}
}
}
createOrgServiceAccount
Response
Returns an OrgServiceAccountCreateResponse
Arguments
| Name | Description |
|---|---|
input - OrgServiceAccountCreateRequestInput
|
Example
Query
mutation createOrgServiceAccount($input: OrgServiceAccountCreateRequestInput) {
createOrgServiceAccount(input: $input) {
orgServiceAccount {
...OrgServiceAccountDTOFragment
}
}
}
Variables
{"input": OrgServiceAccountCreateRequestInput}
Response
{
"data": {
"createOrgServiceAccount": {
"orgServiceAccount": OrgServiceAccountDTO
}
}
}
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"
}
}
}
createSecretOrgServiceAccount
Response
Returns an OrgServiceAccountCreateSecretResponse
Arguments
| Name | Description |
|---|---|
input - OrgServiceAccountCreateSecretRequestInput
|
Example
Query
mutation createSecretOrgServiceAccount($input: OrgServiceAccountCreateSecretRequestInput) {
createSecretOrgServiceAccount(input: $input) {
clientId
clientSecret
expirationUnix
secretName
serviceAccountName
}
}
Variables
{"input": OrgServiceAccountCreateSecretRequestInput}
Response
{
"data": {
"createSecretOrgServiceAccount": {
"clientId": "xyz789",
"clientSecret": "xyz789",
"expirationUnix": {},
"secretName": "abc123",
"serviceAccountName": "xyz789"
}
}
}
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": {"_": "xyz789"}
}
}
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": {"_": "xyz789"}
}
}
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": {"_": "xyz789"}}}
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": {"_": "abc123"}}}
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": {"_": "abc123"}
}
}
deleteOrgRoleGroup
Response
Returns an OrgRoleGroupDeleteResponse
Arguments
| Name | Description |
|---|---|
input - OrgRoleGroupDeleteRequestInput
|
Example
Query
mutation deleteOrgRoleGroup($input: OrgRoleGroupDeleteRequestInput) {
deleteOrgRoleGroup(input: $input) {
success
}
}
Variables
{"input": OrgRoleGroupDeleteRequestInput}
Response
{"data": {"deleteOrgRoleGroup": {"success": true}}}
deleteOrgServiceAccount
Response
Returns an OrgServiceAccountDeleteResponse
Arguments
| Name | Description |
|---|---|
input - OrgServiceAccountDeleteRequestInput
|
Example
Query
mutation deleteOrgServiceAccount($input: OrgServiceAccountDeleteRequestInput) {
deleteOrgServiceAccount(input: $input) {
success
}
}
Variables
{"input": OrgServiceAccountDeleteRequestInput}
Response
{"data": {"deleteOrgServiceAccount": {"success": true}}}
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": {
"_": "xyz789"
}
}
}
deleteSecretsOrgServiceAccount
Response
Returns an OrgServiceAccountDeleteSecretsResponse
Arguments
| Name | Description |
|---|---|
input - OrgServiceAccountDeleteSecretsRequestInput
|
Example
Query
mutation deleteSecretsOrgServiceAccount($input: OrgServiceAccountDeleteSecretsRequestInput) {
deleteSecretsOrgServiceAccount(input: $input) {
_
}
}
Variables
{"input": OrgServiceAccountDeleteSecretsRequestInput}
Response
{
"data": {
"deleteSecretsOrgServiceAccount": {
"_": "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": {"_": "xyz789"}}}
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"}}}
deleteWebhookReceiver
Response
Returns a WebhookReceiverDeleteResponse
Arguments
| Name | Description |
|---|---|
input - WebhookReceiverDeleteRequestInput
|
Example
Query
mutation deleteWebhookReceiver($input: WebhookReceiverDeleteRequestInput) {
deleteWebhookReceiver(input: $input) {
_
}
}
Variables
{"input": WebhookReceiverDeleteRequestInput}
Response
{
"data": {
"deleteWebhookReceiver": {"_": "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"}
}
}
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": true,
"id": "abc123",
"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": "abc123",
"signingCertificateCn": "xyz789"
}
}
}
getByFingerprint
Response
Returns an EdgeProfileGetByFingerprintResponse
Arguments
| Name | Description |
|---|---|
input - EdgeProfileGetByFingerprintRequestInput
|
Example
Query
mutation getByFingerprint($input: EdgeProfileGetByFingerprintRequestInput) {
getByFingerprint(input: $input) {
profile {
...EdgeProfileFragment
}
}
}
Variables
{"input": EdgeProfileGetByFingerprintRequestInput}
Response
{"data": {"getByFingerprint": {"profile": EdgeProfile}}}
getFields
Response
Returns an EdgeProfileGetFieldsResponse
Arguments
| Name | Description |
|---|---|
input - EdgeProfileGetFieldsRequestInput
|
Example
Query
mutation getFields($input: EdgeProfileGetFieldsRequestInput) {
getFields(input: $input) {
fields {
...EdgeProfileFieldsFragment
}
}
}
Variables
{"input": EdgeProfileGetFieldsRequestInput}
Response
{"data": {"getFields": {"fields": [EdgeProfileFields]}}}
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": {"_": "abc123"}
}
}
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": {
"_": "xyz789"
}
}
}
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": {"_": "abc123"}
}
}
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": {"_": "xyz789"}
}
}
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": {"_": "xyz789"}
}
}
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": {"_": "xyz789"}}}
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": {"_": "xyz789"}}}
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}}}
updateOrgRoleGroup
Response
Returns an OrgRoleGroupUpdateResponse
Arguments
| Name | Description |
|---|---|
input - OrgRoleGroupUpdateRequestInput
|
Example
Query
mutation updateOrgRoleGroup($input: OrgRoleGroupUpdateRequestInput) {
updateOrgRoleGroup(input: $input) {
orgRoleGroup {
...OrgRoleGroupDTOFragment
}
}
}
Variables
{"input": OrgRoleGroupUpdateRequestInput}
Response
{
"data": {
"updateOrgRoleGroup": {
"orgRoleGroup": OrgRoleGroupDTO
}
}
}
updateOrgServiceAccount
Response
Returns an OrgServiceAccountUpdateResponse
Arguments
| Name | Description |
|---|---|
input - OrgServiceAccountUpdateRequestInput
|
Example
Query
mutation updateOrgServiceAccount($input: OrgServiceAccountUpdateRequestInput) {
updateOrgServiceAccount(input: $input) {
orgServiceAccount {
...OrgServiceAccountDTOFragment
}
}
}
Variables
{"input": OrgServiceAccountUpdateRequestInput}
Response
{
"data": {
"updateOrgServiceAccount": {
"orgServiceAccount": OrgServiceAccountDTO
}
}
}
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": "abc123"
}
}
}
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": true,
"id": "abc123"
}
}
}
upsertWebhookReceiver
Response
Returns a WebhookReceiverUpsertResponse
Arguments
| Name | Description |
|---|---|
input - WebhookReceiverUpsertRequestInput
|
Example
Query
mutation upsertWebhookReceiver($input: WebhookReceiverUpsertRequestInput) {
upsertWebhookReceiver(input: $input) {
receiver {
...WebhookReceiverFragment
}
}
}
Variables
{"input": WebhookReceiverUpsertRequestInput}
Response
{
"data": {
"upsertWebhookReceiver": {"receiver": WebhookReceiver}
}
}
Types
APIKey
APIKeyInput
AccessCredential
Example
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "abc123",
"name": "xyz789",
"type": ["abc123"]
}
AccessCredentialFilter
Fields
| Input Field | Description |
|---|---|
and - [AccessCredentialFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - AccessCredentialFilter
|
|
or - [AccessCredentialFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [AccessCredentialFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": AccessCredentialFilter,
"or": [AccessCredentialFilter],
"type": StringArrayFilterExpressionInput
}
AccessCredentialIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
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": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
AccessCredentialIdentityUnion
Types
| Union Types |
|---|
Example
AccessCredentialIdentity
Account
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
hasBill - [Point]
|
|
Arguments
|
|
hasBillEdges - [HasBillEdge]
|
|
hasProvider - [Organization]
|
|
Arguments
|
|
hasProviderEdges - [HasProviderEdge]
|
|
id - String!
|
|
identities - [AccountIdentityUnion]
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"hasBill": [Point],
"hasBillEdges": [HasBillEdge],
"hasProvider": [Organization],
"hasProviderEdges": [HasProviderEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "abc123",
"type": ["abc123"]
}
AccountFilter
Fields
| Input Field | Description |
|---|---|
and - [AccountFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - AccountFilter
|
|
or - [AccountFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [AccountFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": AccountFilter,
"or": [AccountFilter],
"type": StringArrayFilterExpressionInput
}
AccountIdentityUnion
Example
AccessCredentialIdentity
Address
Example
{
"countryName": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"locality": "abc123",
"postalCode": "xyz789",
"region": "xyz789",
"streetAddress": "xyz789"
}
AddressMutation
Example
{
"countryName": "abc123",
"id": "abc123",
"locality": "abc123",
"postalCode": "xyz789",
"region": "abc123",
"streetAddress": "abc123",
"type": ["abc123"],
"validate": true
}
AddressMutationInput
Example
{
"countryName": "xyz789",
"id": "abc123",
"locality": "abc123",
"postalCode": "abc123",
"region": "abc123",
"streetAddress": "xyz789",
"type": ["xyz789"],
"validate": false
}
Agent
Example
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "abc123",
"name": "xyz789",
"type": ["xyz789"]
}
AgentFilter
Fields
| Input Field | Description |
|---|---|
and - [AgentFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - AgentFilter
|
|
or - [AgentFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [AgentFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": AgentFilter,
"or": [AgentFilter],
"type": StringArrayFilterExpressionInput
}
AgentIdentityUnion
Example
AccessCredentialIdentity
AreaQuantity
AreaQuantityFilter
Fields
| Input Field | Description |
|---|---|
and - [AreaQuantityFilter]
|
|
not - AreaQuantityFilter
|
|
or - [AreaQuantityFilter]
|
Example
{
"and": [AreaQuantityFilter],
"not": AreaQuantityFilter,
"or": [AreaQuantityFilter]
}
Auth
AuthInput
Fields
| Input Field | Description |
|---|---|
and - [AuthInput]
|
|
matches - [MatchInput]
|
|
not - [AuthInput]
|
|
or - [AuthInput]
|
Example
{
"and": [AuthInput],
"matches": [MatchInput],
"not": [AuthInput],
"or": [AuthInput]
}
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": "xyz789"
}
BACnetVendorId
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"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": "xyz789"
}
BasicAuth
BasicAuthInput
BillingCalculatedProductBundleResponse
Fields
| Field Name | Description |
|---|---|
calculation - BillingCalculationResponse
|
|
code - Int
|
|
productBundle - ProductBundleResponse
|
|
productSlug - String
|
|
statusMessage - String
|
Example
{
"calculation": BillingCalculationResponse,
"code": 987,
"productBundle": ProductBundleResponse,
"productSlug": "abc123",
"statusMessage": "abc123"
}
BillingCalculationResponse
Example
{
"fixedPrice": {},
"itemSlug": "xyz789",
"overagePrice": {},
"productPriceItem": ProductPriceItemResponse,
"quantity": {},
"unitPrice": {}
}
BillingProductBundleSubscriptionResponse
Fields
| Field Name | Description |
|---|---|
productBundle - BillingCalculatedProductBundleResponse
|
|
subscriptionId - String
|
Example
{
"productBundle": BillingCalculatedProductBundleResponse,
"subscriptionId": "xyz789"
}
BodyValueLocation
BodyValueLocationInput
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
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
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
|
|
geolocation - GeoPointQuantity
|
|
Arguments
|
|
geolocationEdges - [GeolocationEdge]
|
|
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
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. |
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of a building. |
identities - [BuildingIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
Superset of anything that could be in a building - a thing, a person, a meeting (people and meetings currently in development). |
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
This contains the next level up in the place hierarchy; for a building, this will contain site information. |
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
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
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
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
|
|
timeZone - String
|
|
type - [String]
|
Type includes all possible hierarchal types for the building, such as "Place" and "Building". |
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Example
{
"address": Address,
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "xyz789",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "xyz789",
"floors": [Floor],
"geolocation": GeoPointQuantity,
"geolocationEdges": [GeolocationEdge],
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"sites": [Site],
"spaces": [Space],
"things": [Thing],
"timeZone": "xyz789",
"type": ["xyz789"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
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": "xyz789",
"name": "abc123",
"siteId": "xyz789"
}
BuildingMutationInput
Fields
| Input Field | Description |
|---|---|
address - AddressMutationInput
|
|
id - String
|
|
name - String
|
|
siteId - String
|
Example
{
"address": AddressMutationInput,
"id": "abc123",
"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"
CalendarEvent
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
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
{
"connectedDataSourceId": "abc123",
"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": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "abc123",
"name": "abc123",
"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 |
|---|---|
connectedDataSourceId - String
|
|
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
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"email": EmailAddress,
"event": CalendarEvent,
"exactType": "abc123",
"hasInvitee": Person,
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "abc123",
"name": "xyz789",
"response": "ACCEPTED",
"type": ["abc123"]
}
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
CertMatch
Fields
| Field Name | Description |
|---|---|
caCerts - CertificateAuthorityBundle
|
|
dnsName - String
|
|
serialNumber - String
|
Example
{
"caCerts": CertificateAuthorityBundle,
"dnsName": "abc123",
"serialNumber": "abc123"
}
CertMatchInput
Fields
| Input Field | Description |
|---|---|
caCerts - CertificateAuthorityBundleInput
|
|
dnsName - String
|
|
serialNumber - String
|
Example
{
"caCerts": CertificateAuthorityBundleInput,
"dnsName": "abc123",
"serialNumber": "xyz789"
}
Certificate
Fields
| Field Name | Description |
|---|---|
certificate - String
|
|
type - CertificateType
|
Example
{
"certificate": "xyz789",
"type": "CERTIFICATETYPE_UNSPECIFIED"
}
CertificateAuthorityBundle
Fields
| Field Name | Description |
|---|---|
caCertificates - [Certificate]
|
Example
{"caCertificates": [Certificate]}
CertificateAuthorityBundleInput
Fields
| Input Field | Description |
|---|---|
caCertificates - [CertificateInput]
|
Example
{"caCertificates": [CertificateInput]}
CertificateInput
Fields
| Input Field | Description |
|---|---|
certificate - String
|
|
type - CertificateTypeInput
|
Example
{
"certificate": "xyz789",
"type": "CERTIFICATETYPE_UNSPECIFIED"
}
CertificateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CERTIFICATETYPE_UNSPECIFIED"
CertificateTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CERTIFICATETYPE_UNSPECIFIED"
CloudEventSourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLOUDEVENTSOURCETYPE_UNSPECIFIED"
CloudEventSourceTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLOUDEVENTSOURCETYPE_UNSPECIFIED"
Collection
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
feeds - [FeedsUnion]
|
|
Arguments
|
|
feedsEdges - [FeedsEdge]
|
|
hasLocation - [Place]
|
|
Arguments
|
|
hasLocationEdges - [HasLocationEdge]
|
|
hasPart - [HasPartUnion]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
id - String!
|
|
identities - [CollectionIdentityUnion]
|
|
isFedBy - [IsFedByUnion]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
points - [Point]
|
|
Arguments
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"feeds": [Building],
"feedsEdges": [FeedsEdge],
"hasLocation": [Place],
"hasLocationEdges": [HasLocationEdge],
"hasPart": [Building],
"hasPartEdges": [HasPartEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isFedBy": [Collection],
"isFedByEdges": [IsFedByEdge],
"mappingKey": "xyz789",
"name": "abc123",
"points": [Point],
"type": ["abc123"]
}
CollectionFilter
Fields
| Input Field | Description |
|---|---|
and - [CollectionFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - CollectionFilter
|
|
or - [CollectionFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [CollectionFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": CollectionFilter,
"or": [CollectionFilter],
"type": StringArrayFilterExpressionInput
}
CollectionIdentityUnion
Example
AccessCredentialIdentity
Connector
Description
Contains the details about a Connector.
Fields
| Field Name | Description |
|---|---|
baseUrl - String
|
|
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
|
|
runtimeVersion - ConnectorTypeRuntimeVersion
|
|
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
{
"baseUrl": "xyz789",
"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": "abc123",
"lastSeen": "2007-12-03T10:15:30Z",
"lastUpdatedBy": "xyz789",
"name": "abc123",
"organization": Org,
"points": [Point],
"runtimeVersion": "RUNTIMEVERSION_UNSPECIFIED",
"sites": [Site],
"spaces": [Space],
"state": "ACTIVE",
"stateDetails": "abc123",
"things": [Thing],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789",
"workflowId": "xyz789"
}
ConnectorAuth
ConnectorAuthAccessRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
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
{"_": "abc123"}
ConnectorAuthInput
ConnectorAuthRequestSecretInput
Fields
| Input Field | Description |
|---|---|
staticToken - ConnectorAuthStaticTokenInput
|
|
usernamePassword - ConnectorAuthUsernamePasswordInput
|
Example
{
"staticToken": ConnectorAuthStaticTokenInput,
"usernamePassword": ConnectorAuthUsernamePasswordInput
}
ConnectorAuthResponseSecret
Fields
| Field Name | Description |
|---|---|
staticToken - ConnectorAuthStaticToken
|
|
usernamePassword - ConnectorAuthUsernamePassword
|
Example
{
"staticToken": ConnectorAuthStaticToken,
"usernamePassword": ConnectorAuthUsernamePassword
}
ConnectorAuthStaticToken
Fields
| Field Name | Description |
|---|---|
token - String
|
Example
{"token": "abc123"}
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": "abc123"}
ConnectorDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
ConnectorFilterInput
Description
Contains the input values needed to filter Connector queries.
Fields
| Input Field | Description |
|---|---|
and - [ConnectorFilterInput]
|
|
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). |
not - [ConnectorFilterInput]
|
|
or - [ConnectorFilterInput]
|
Example
{
"and": [ConnectorFilterInput],
"connectorTypeId": IDFilterExpressionInput,
"direction": ConnectorTypeConnectorDirectionFilterExpressionInput,
"id": IDFilterExpressionInput,
"not": [ConnectorFilterInput],
"or": [ConnectorFilterInput]
}
ConnectorInput
Description
Contains the details about a Connector.
Fields
| Input Field | Description |
|---|---|
baseUrl - String
|
|
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. |
runtimeVersion - ConnectorTypeRuntimeVersionInput
|
|
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
{
"baseUrl": "abc123",
"config": JSONSchema,
"configHash": "abc123",
"connectorTypeId": "xyz789",
"created": "2007-12-03T10:15:30Z",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"id": "xyz789",
"lastSeen": "2007-12-03T10:15:30Z",
"lastUpdatedBy": "abc123",
"name": "abc123",
"runtimeVersion": "RUNTIMEVERSION_UNSPECIFIED",
"state": "ACTIVE",
"stateDetails": "xyz789",
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789",
"workflowId": "abc123"
}
ConnectorRequest
ConnectorRequestCreateRequestInput
Fields
| Input Field | Description |
|---|---|
connectorTypeId - String
|
Example
{"connectorTypeId": "xyz789"}
ConnectorRequestCreateResponse
Fields
| Field Name | Description |
|---|---|
request - ConnectorRequest
|
Example
{"request": ConnectorRequest}
ConnectorRestartRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
ConnectorRestartResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
ConnectorStartRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ConnectorStartResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
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 support@mapped.com 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 support@mapped.com 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 support@mapped.com 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 support@mapped.com 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": "xyz789"}
ConnectorStopResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
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. |
metadata - [MetadataRecord]
|
|
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.. |
runtimeVersion - ConnectorTypeRuntimeVersion
|
|
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. |
webhookReceiveStorage - ConnectorTypeWebhookReceiveStorage
|
Example
{
"configSchema": JSONSchema,
"description": "xyz789",
"direction": "CONNECTOR_DIRECTION_UNSPECIFIED",
"id": "abc123",
"metadata": [MetadataRecord],
"name": "xyz789",
"runtimeVersion": "RUNTIMEVERSION_UNSPECIFIED",
"taskQueue": "abc123",
"version": "abc123",
"webhookReceiveStorage": "RECEIVESTORAGE_CENTRIFUGO_CHANNEL"
}
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
|
|
metadataKey - StringFilterExpressionInput
|
|
metadataValue - StringFilterExpressionInput
|
|
name - IDFilterExpressionInput
|
The name of the Connector type. |
runtimeVersion - ConnectorTypeRuntimeVersionFilterExpressionInput
|
|
version - IDFilterExpressionInput
|
The version of the Connector type. |
webhookReceiveStorage - ConnectorTypeWebhookReceiveStorageInput
|
Example
{
"connectorTypeId": IDFilterExpressionInput,
"description": IDFilterExpressionInput,
"direction": ConnectorTypeConnectorDirectionFilterExpressionInput,
"metadataKey": StringFilterExpressionInput,
"metadataValue": StringFilterExpressionInput,
"name": IDFilterExpressionInput,
"runtimeVersion": ConnectorTypeRuntimeVersionFilterExpressionInput,
"version": IDFilterExpressionInput,
"webhookReceiveStorage": "RECEIVESTORAGE_CENTRIFUGO_CHANNEL"
}
ConnectorTypeListAvailableResponse
Fields
| Field Name | Description |
|---|---|
available - [ConnectorType]
|
|
connectorTypes - [ConnectorType]
|
No longer supported |
requested - [ConnectorType]
|
|
uponRequest - [ConnectorType]
|
Example
{
"available": [ConnectorType],
"connectorTypes": [ConnectorType],
"requested": [ConnectorType],
"uponRequest": [ConnectorType]
}
ConnectorTypeRuntimeVersion
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"RUNTIMEVERSION_UNSPECIFIED"
ConnectorTypeRuntimeVersionFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - ConnectorTypeRuntimeVersionInput
|
|
in - [ConnectorTypeRuntimeVersionInput]
|
Example
{"eq": "RUNTIMEVERSION_UNSPECIFIED", "in": ["RUNTIMEVERSION_UNSPECIFIED"]}
ConnectorTypeRuntimeVersionInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"RUNTIMEVERSION_UNSPECIFIED"
ConnectorTypeWebhookReceiveStorage
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RECEIVESTORAGE_CENTRIFUGO_CHANNEL"
ConnectorTypeWebhookReceiveStorageInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RECEIVESTORAGE_CENTRIFUGO_CHANNEL"
ConnectorUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
connector - ConnectorInput
|
Example
{"connector": ConnectorInput}
ConnectorUpdateResponse
Fields
| Field Name | Description |
|---|---|
connector - Connector
|
Example
{"connector": Connector}
ConnectorUpsertConfigRequestInput
Fields
| Input Field | Description |
|---|---|
config - JSONSchema
|
|
configHash - String
|
|
id - String
|
|
restart - ConnectorUpsertConfigRestartOptionsInput
|
Example
{
"config": JSONSchema,
"configHash": "xyz789",
"id": "xyz789",
"restart": "CONNECTOR_DO_NOT_RESTART"
}
ConnectorUpsertConfigResponse
Fields
| Field Name | Description |
|---|---|
config - JSONSchema
|
|
configHash - String
|
|
configUnchanged - Boolean
|
|
id - String
|
Example
{
"config": JSONSchema,
"configHash": "xyz789",
"configUnchanged": true,
"id": "xyz789"
}
ConnectorUpsertConfigRestartOptionsInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONNECTOR_DO_NOT_RESTART"
ContributionRequest
Fields
| Field Name | Description |
|---|---|
id - String
|
|
properties - ContributionRequestPropertyValues
|
|
target - ContributionRequestTargetEntity
|
Example
{
"id": "xyz789",
"properties": ContributionRequestPropertyValues,
"target": ContributionRequestTargetEntity
}
ContributionRequestCreateRequestInput
Fields
| Input Field | Description |
|---|---|
contributionRequest - ContributionRequestInput
|
Example
{"contributionRequest": ContributionRequestInput}
ContributionRequestCreateResponse
Fields
| Field Name | Description |
|---|---|
contributionRequest - ContributionRequest
|
Example
{"contributionRequest": ContributionRequest}
ContributionRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
|
properties - ContributionRequestPropertyValuesInput
|
|
target - ContributionRequestTargetEntityInput
|
Example
{
"id": "abc123",
"properties": ContributionRequestPropertyValuesInput,
"target": ContributionRequestTargetEntityInput
}
ContributionRequestPropertyValues
Fields
| Field Name | Description |
|---|---|
additionalName - String
|
|
address - String
|
|
attachment - [String]
|
|
callInfo - String
|
|
countryName - String
|
|
description - String
|
|
deviceModelId - String
|
|
elevation - Float
|
|
endTime - DateTime
|
|
exactType - String
|
|
familyName - String
|
|
firmwareVersion - String
|
|
geoshape - GeoJSON
|
|
givenName - String
|
|
hostname - String
|
|
iCalUid - String
|
|
image - String
|
|
ipv4Address - [String]
|
|
ipv6Address - [String]
|
|
level - Int
|
|
locality - String
|
|
macAddress - String
|
|
maxLimit - Float
|
|
maxOccupancy - Int
|
|
minLimit - Float
|
|
name - String
|
|
postalCode - String
|
|
region - String
|
|
response - String
|
|
seeAlso - String
|
|
serialNumber - String
|
|
stateTexts - [String]
|
|
streetAddress - String
|
|
systemType - [String]
|
|
type - [String]
|
|
unit - String
|
|
valueType - String
|
Example
{
"additionalName": "abc123",
"address": "abc123",
"attachment": ["xyz789"],
"callInfo": "abc123",
"countryName": "abc123",
"description": "abc123",
"deviceModelId": "abc123",
"elevation": 987.65,
"endTime": "2007-12-03T10:15:30Z",
"exactType": "xyz789",
"familyName": "xyz789",
"firmwareVersion": "abc123",
"geoshape": GeoJSON,
"givenName": "xyz789",
"hostname": "xyz789",
"iCalUid": "abc123",
"image": "xyz789",
"ipv4Address": ["xyz789"],
"ipv6Address": ["xyz789"],
"level": 123,
"locality": "xyz789",
"macAddress": "abc123",
"maxLimit": 123.45,
"maxOccupancy": 123,
"minLimit": 123.45,
"name": "xyz789",
"postalCode": "abc123",
"region": "abc123",
"response": "xyz789",
"seeAlso": "xyz789",
"serialNumber": "xyz789",
"stateTexts": ["abc123"],
"streetAddress": "xyz789",
"systemType": ["abc123"],
"type": ["abc123"],
"unit": "abc123",
"valueType": "xyz789"
}
ContributionRequestPropertyValuesInput
Fields
| Input Field | Description |
|---|---|
additionalName - String
|
|
address - String
|
|
attachment - [String]
|
|
callInfo - String
|
|
countryName - String
|
|
description - String
|
|
deviceModelId - String
|
|
elevation - Float
|
|
endTime - DateTime
|
|
exactType - String
|
|
familyName - String
|
|
firmwareVersion - String
|
|
geoshape - GeoJSON
|
|
givenName - String
|
|
hostname - String
|
|
iCalUid - String
|
|
image - String
|
|
ipv4Address - [String]
|
|
ipv6Address - [String]
|
|
level - Int
|
|
locality - String
|
|
macAddress - String
|
|
maxLimit - Float
|
|
maxOccupancy - Int
|
|
minLimit - Float
|
|
name - String
|
|
postalCode - String
|
|
region - String
|
|
response - String
|
|
seeAlso - String
|
|
serialNumber - String
|
|
stateTexts - [String]
|
|
streetAddress - String
|
|
systemType - [String]
|
|
type - [String]
|
|
unit - String
|
|
valueType - String
|
Example
{
"additionalName": "abc123",
"address": "abc123",
"attachment": ["xyz789"],
"callInfo": "xyz789",
"countryName": "xyz789",
"description": "abc123",
"deviceModelId": "abc123",
"elevation": 987.65,
"endTime": "2007-12-03T10:15:30Z",
"exactType": "abc123",
"familyName": "abc123",
"firmwareVersion": "abc123",
"geoshape": GeoJSON,
"givenName": "xyz789",
"hostname": "abc123",
"iCalUid": "abc123",
"image": "xyz789",
"ipv4Address": ["xyz789"],
"ipv6Address": ["xyz789"],
"level": 987,
"locality": "abc123",
"macAddress": "xyz789",
"maxLimit": 987.65,
"maxOccupancy": 987,
"minLimit": 987.65,
"name": "xyz789",
"postalCode": "abc123",
"region": "abc123",
"response": "xyz789",
"seeAlso": "xyz789",
"serialNumber": "xyz789",
"stateTexts": ["xyz789"],
"streetAddress": "abc123",
"systemType": ["xyz789"],
"type": ["xyz789"],
"unit": "abc123",
"valueType": "xyz789"
}
ContributionRequestTargetEntity
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ContributionRequestTargetEntityInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
DatatypeKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATATYPE_KEY_UNSPECIFIED"
DateTime
Description
An RFC-3339 compliant DateTime Scalar
Example
"2007-12-03T10:15:30Z"
DateTimeFilterExpressionInput
Example
{
"eq": "2007-12-03T10:15:30Z",
"gt": "2007-12-03T10:15:30Z",
"gte": "2007-12-03T10:15:30Z",
"in": ["2007-12-03T10:15:30Z"],
"lt": "2007-12-03T10:15:30Z",
"lte": "2007-12-03T10:15:30Z"
}
DeviceLibraryModel
Example
{
"description": "abc123",
"id": "xyz789",
"imageUrl": "abc123",
"manufacturer": DeviceManufacturer,
"manufacturerId": "xyz789",
"name": "abc123",
"seeAlsoUrls": ["abc123"]
}
DeviceManufacturer
DeviceModel
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
id - String!
|
|
identities - [DeviceModelIdentityUnion]
|
|
manufacturedBy - Agent
|
|
Arguments
|
|
manufacturedByEdges - [ManufacturedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"id": "abc123",
"identities": [AccessCredentialIdentity],
"manufacturedBy": Agent,
"manufacturedByEdges": [ManufacturedByEdge],
"mappingKey": "xyz789",
"name": "xyz789",
"type": ["abc123"]
}
DeviceModelFilter
Fields
| Input Field | Description |
|---|---|
and - [DeviceModelFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - DeviceModelFilter
|
|
or - [DeviceModelFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [DeviceModelFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": DeviceModelFilter,
"or": [DeviceModelFilter],
"type": StringArrayFilterExpressionInput
}
DeviceModelIdentityUnion
Example
AccessCredentialIdentity
Duration
DurationInput
Edge
Possible Types
| Edge Types |
|---|
Example
{
"mappingKey": "xyz789",
"node": GraphNode
}
EdgeProfile
Fields
| Field Name | Description |
|---|---|
fields - [String]
|
|
id - String
|
|
manufacturer - String
|
|
model - String
|
|
name - String
|
|
patternHashesV1 - [String]
|
|
patterns - [FingerprintPattern]
|
|
protocol - GatewayProtocol
|
Example
{
"fields": ["abc123"],
"id": "xyz789",
"manufacturer": "xyz789",
"model": "xyz789",
"name": "xyz789",
"patternHashesV1": ["xyz789"],
"patterns": [FingerprintPattern],
"protocol": "BACNET"
}
EdgeProfileFields
Fields
| Field Name | Description |
|---|---|
fields - [String]
|
|
id - String
|
|
protocol - GatewayProtocol
|
Example
{
"fields": ["xyz789"],
"id": "abc123",
"protocol": "BACNET"
}
EdgeProfileGetByFingerprintRequestInput
Fields
| Input Field | Description |
|---|---|
fingerprint - FingerprintInput
|
Example
{"fingerprint": FingerprintInput}
EdgeProfileGetByFingerprintResponse
Fields
| Field Name | Description |
|---|---|
profile - EdgeProfile
|
Example
{"profile": EdgeProfile}
EdgeProfileGetFieldsRequestInput
Fields
| Input Field | Description |
|---|---|
protocol - GatewayProtocolInput
|
Example
{"protocol": "BACNET"}
EdgeProfileGetFieldsResponse
Fields
| Field Name | Description |
|---|---|
fields - [EdgeProfileFields]
|
Example
{"fields": [EdgeProfileFields]}
EmailAddress
Example
{
"address": "abc123",
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"mappingKey": "xyz789",
"name": "abc123",
"type": ["xyz789"]
}
EmailAddressIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "xyz789"
}
EmailAddressIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| EmailAddressIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
EmailAddressIdentityUnion
Example
AccessCredentialIdentity
EmailFilter
Fields
| Input Field | Description |
|---|---|
and - [EmailFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - EmailFilter
|
|
or - [EmailFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [EmailFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": EmailFilter,
"or": [EmailFilter],
"type": StringArrayFilterExpressionInput
}
EmailIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
EmailIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| EmailIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "abc123"
}
EncodingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BASE64"
EncodingTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BASE64"
EntityFilter
Fields
| Input Field | Description |
|---|---|
and - [EntityFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - EntityFilter
|
|
or - [EntityFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [EntityFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": EntityFilter,
"or": [EntityFilter],
"type": StringArrayFilterExpressionInput
}
Event
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
endTime - DateTime
|
|
exactType - String
|
|
id - String!
|
|
mappingKey - String
|
|
name - String
|
|
startTime - DateTime
|
|
type - [String]
|
Possible Types
| Event Types |
|---|
Example
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"endTime": "2007-12-03T10:15:30Z",
"exactType": "abc123",
"id": "abc123",
"mappingKey": "xyz789",
"name": "abc123",
"startTime": "2007-12-03T10:15:30Z",
"type": ["xyz789"]
}
ExternalIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "abc123"
}
ExternalIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| ExternalIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "xyz789"
}
FeedsEdge
FeedsUnion
Types
| Union Types |
|---|
Example
Building
FingerprintFieldStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIELD_STATUS_ACCESS_DENIED"
FingerprintFieldStatusInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIELD_STATUS_ACCESS_DENIED"
FingerprintInput
Fields
| Input Field | Description |
|---|---|
device - GatewaySubtendedDeviceInput
|
|
patterns - [FingerprintPatternInput]
|
|
timestamp - DateTime
|
Example
{
"device": GatewaySubtendedDeviceInput,
"patterns": [FingerprintPatternInput],
"timestamp": "2007-12-03T10:15:30Z"
}
FingerprintPattern
Fields
| Field Name | Description |
|---|---|
fieldQuery - String
|
|
fieldStatus - FingerprintFieldStatus
|
|
fieldType - String
|
|
fieldValue - String
|
|
protocol - GatewayProtocol
|
|
protocolPort - Int
|
Example
{
"fieldQuery": "abc123",
"fieldStatus": "FIELD_STATUS_ACCESS_DENIED",
"fieldType": "xyz789",
"fieldValue": "xyz789",
"protocol": "BACNET",
"protocolPort": 123
}
FingerprintPatternInput
Fields
| Input Field | Description |
|---|---|
fieldQuery - String
|
|
fieldStatus - FingerprintFieldStatusInput
|
|
fieldType - String
|
|
fieldValue - String
|
|
protocol - GatewayProtocolInput
|
|
protocolPort - Int
|
Example
{
"fieldQuery": "xyz789",
"fieldStatus": "FIELD_STATUS_ACCESS_DENIED",
"fieldType": "abc123",
"fieldValue": "abc123",
"protocol": "BACNET",
"protocolPort": 123
}
Float
Description
Built-in Float
Example
987.65
Floor
Description
Contains the details about the floor.
Fields
| Field Name | Description |
|---|---|
building - Building!
|
Contains the details of the building where the floor is present. |
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
Any connectors configured for the floor will be listed here. |
Arguments
|
|
dateCreated - DateTime
|
This timestamp represents the date the floor was created. |
dateUpdated - DateTime
|
This timestamp represents that date the floor was last updated. |
description - String
|
The description of the floor; often left blank, especially if the floor name is already descriptive. |
exactType - String
|
|
geoshape - GeoJSON
|
The geographic shape of the floor, represented by latitude/longitude coordinate pairs. |
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
Lists the spaces on the floor - spaces are "part of" a floor. |
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
|
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of the floor. |
identities - [FloorIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
|
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
This contains the next level up in the place hierarchy; for a floor, this will contain building information. |
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
level - Int
|
This is the floor level represented numerically. Starting at 0 for ground floor, with basement levels below ground floor identified as negative numbers. |
mappingKey - String
|
|
name - String
|
The name of the floor, typically just a number or "floor1", "floor2". |
points - [Point]
|
Any of the points available on the floor will be listed here. |
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
spaces - [Space]
|
All the spaces present on the floor will be listed here. |
Arguments
|
|
things - [Thing]
|
All the things associated with the floor, or any spaces on the floor, will show here. |
Arguments
|
|
type - [String]
|
Type includes all possible hierarchal types for the building, such as "Place" and "Floor". |
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
zones - [Zone]
|
Currently in development; will show all the zones associated with the floor. |
Arguments
|
|
Example
{
"building": Building,
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"level": 987,
"mappingKey": "xyz789",
"name": "xyz789",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"spaces": [Space],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge],
"zones": [Zone]
}
FloorCreateRequestInput
Fields
| Input Field | Description |
|---|---|
floor - FloorMutationInput
|
Example
{"floor": FloorMutationInput}
FloorCreateResponse
Fields
| Field Name | Description |
|---|---|
floor - FloorMutation
|
Example
{"floor": FloorMutation}
FloorDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
FloorDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
FloorFilter
Description
Contains the input values needed to filter floor queries.
Fields
| Input Field | Description |
|---|---|
and - [FloorFilter]
|
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) |
level - IntFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - FloorFilter
|
Used to omit a specific result or results from the response. |
or - [FloorFilter]
|
Used to return results that match at least one of the defined criteria. |
type - StringArrayFilterExpressionInput
|
Example
{
"and": [FloorFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"level": IntFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": FloorFilter,
"or": [FloorFilter],
"type": StringArrayFilterExpressionInput
}
FloorIdentityUnion
Example
AccessCredentialIdentity
FloorLevelIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "xyz789"
}
FloorLevelIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| FloorLevelIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "abc123"
}
FloorMutation
FloorMutationInput
FloorUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
floor - FloorMutationInput
|
Example
{"floor": FloorMutationInput}
FloorUpdateResponse
Fields
| Field Name | Description |
|---|---|
floor - FloorMutation
|
Example
{"floor": FloorMutation}
GRPCRequestOptions
Fields
| Input Field | Description |
|---|---|
requestTimeout - Int
|
Request Timeout in milliseconds |
Example
{"requestTimeout": 123}
Gateway
Description
Contains the details about the gateway.
Fields
| Field Name | Description |
|---|---|
active - GatewayActiveDetails
|
If the gateway is in an active state, this will contain the last seen time value. |
assignment - GatewayAssignmentDetails
|
Contains the gateway place assignment details, including place IDs and system types. |
firstBoot - GatewayFirstBootDetails
|
This contains the timestamp for the gateway's first boot. |
gatewayId - String
|
The unique ID of the gateway. |
organization - Org
|
Contains the details about the organization associated with this gateway. |
provisioning - GatewayProvisioningDetails
|
Contains the timestamp for the gateway's initial provisioning to the organization. |
registration - GatewayRegistrationDetails
|
Contains gateway registration details, including serial number and IMEI information. |
rma - GatewayRMADetails
|
If the gateway needs to be returned, this will contain details like the RMA reason along with any explanatory notes. |
shipping - GatewayShippingDetails
|
If the gateway is currently in a SHIPPED state, details about the shipment will show here, including carrier and tracking number. |
state - GatewayLifecycleState
|
The current state of the gateway - many states are transitory, like FIRST_BOOT; the more common states will be ACTIVE, ASSIGNED, PROVISIONING and SHIPPED as those exist for longer windows. |
stateTime - DateTime
|
Timestamp for the start of the current state. |
suspension - GatewaySuspensionDetails
|
If the gateway was suspended, this will contain details like the suspension reason along with any explanatory notes. |
termination - GatewayTerminationDetails
|
If the gateway was terminated, this will contain details like the suspension reason along with any explanatory notes. This differs from suspenson as the gateway cannot be returned to active once terminated. |
Example
{
"active": GatewayActiveDetails,
"assignment": GatewayAssignmentDetails,
"firstBoot": GatewayFirstBootDetails,
"gatewayId": "abc123",
"organization": Org,
"provisioning": GatewayProvisioningDetails,
"registration": GatewayRegistrationDetails,
"rma": GatewayRMADetails,
"shipping": GatewayShippingDetails,
"state": "ACTIVE",
"stateTime": "2007-12-03T10:15:30Z",
"suspension": GatewaySuspensionDetails,
"termination": GatewayTerminationDetails
}
GatewayActiveDetails
GatewayAssignRequestInput
Description
Contains the input values needed to assign a gateway.
Fields
| Input Field | Description |
|---|---|
assignment - GatewayAssignmentDetailsInput
|
|
gatewayId - String
|
Example
{
"assignment": GatewayAssignmentDetailsInput,
"gatewayId": "abc123"
}
GatewayAssignResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
GatewayAssignmentDetails
Example
{
"assignmentTime": "2007-12-03T10:15:30Z",
"physicalPlaceId": "xyz789",
"preciseGeoLocation": GeoJSON,
"servesPlaceIds": ["xyz789"],
"servesSystemTypes": ["AIR_QUALITY_MONITORING_SYSTEM"],
"supportAccessAllowed": false,
"supportAccessExpiration": "2007-12-03T10:15:30Z",
"uniqueName": "abc123"
}
GatewayAssignmentDetailsInput
Example
{
"assignmentTime": "2007-12-03T10:15:30Z",
"physicalPlaceId": "xyz789",
"preciseGeoLocation": GeoJSON,
"servesPlaceIds": ["abc123"],
"servesSystemTypes": ["AIR_QUALITY_MONITORING_SYSTEM"],
"supportAccessAllowed": true,
"supportAccessExpiration": "2007-12-03T10:15:30Z",
"uniqueName": "xyz789"
}
GatewayAuthTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AUTH_TYPE_UNSPECIFIED"
GatewayCourier
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COURIER_DHL"
GatewayCredentialsInput
Fields
| Input Field | Description |
|---|---|
authType - GatewayAuthTypeInput
|
|
cleartext - String
|
|
hashed - GatewayHashTypeInput
|
|
username - String
|
Example
{
"authType": "AUTH_TYPE_UNSPECIFIED",
"cleartext": "xyz789",
"hashed": GatewayHashTypeInput,
"username": "xyz789"
}
GatewayFilterInput
Description
Contains the input values needed to filter gateway queries.
Fields
| Input Field | Description |
|---|---|
and - [GatewayFilterInput]
|
Used to combine multiple filter criteria. |
deviceId - IDFilterExpressionInput
|
|
gatewayId - IDFilterExpressionInput
|
|
iccid - StringFilterExpressionInput
|
|
imei - StringFilterExpressionInput
|
|
lanMac - StringFilterExpressionInput
|
|
mappedModel - GatewayModelFilterExpressionInput
|
|
not - [GatewayFilterInput]
|
Used to omit a specific result or results from the response. |
or - [GatewayFilterInput]
|
Used to return results that match at least one of the defined criteria. |
physicalPlaceId - IDFilterExpressionInput
|
|
serialNumber - StringFilterExpressionInput
|
|
servesPlaceIds - StringArrayFilterExpressionInput
|
|
servesSystemTypes - GatewaySystemTypeFilterExpressionInput
|
|
state - GatewayLifecycleStateFilterExpressionInput
|
|
stateTime - TimestampFilterExpressionInput
|
|
uniqueName - StringFilterExpressionInput
|
Search by the gateway's name, either an exact match, in a defined set or by a partial match. |
Example
{
"and": [GatewayFilterInput],
"deviceId": IDFilterExpressionInput,
"gatewayId": IDFilterExpressionInput,
"iccid": StringFilterExpressionInput,
"imei": StringFilterExpressionInput,
"lanMac": StringFilterExpressionInput,
"mappedModel": GatewayModelFilterExpressionInput,
"not": [GatewayFilterInput],
"or": [GatewayFilterInput],
"physicalPlaceId": IDFilterExpressionInput,
"serialNumber": StringFilterExpressionInput,
"servesPlaceIds": StringArrayFilterExpressionInput,
"servesSystemTypes": GatewaySystemTypeFilterExpressionInput,
"state": GatewayLifecycleStateFilterExpressionInput,
"stateTime": TimestampFilterExpressionInput,
"uniqueName": StringFilterExpressionInput
}
GatewayFirstBootDetails
Fields
| Field Name | Description |
|---|---|
bootTime - DateTime
|
Example
{"bootTime": "2007-12-03T10:15:30Z"}
GatewayGenerateContainerSIDsRequestInput
Description
Currently not used, placeholder.
Fields
| Input Field | Description |
|---|---|
_ - String
|
NOT USED |
Example
{"_": "xyz789"}
GatewayGenerateContainerSIDsResponse
GatewayHashMethodInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HASH_METHOD_UNSPECIFIED"
GatewayHashTypeInput
Fields
| Input Field | Description |
|---|---|
hash - String
|
|
method - GatewayHashMethodInput
|
Example
{
"hash": "abc123",
"method": "HASH_METHOD_UNSPECIFIED"
}
GatewayIpAddressInput
Fields
| Input Field | Description |
|---|---|
v4 - GatewayIpv4AddressInput
|
|
v6 - GatewayIpv6AddressInput
|
Example
{
"v4": GatewayIpv4AddressInput,
"v6": GatewayIpv6AddressInput
}
GatewayIpv4AddressInput
Fields
| Input Field | Description |
|---|---|
address - Int
|
Example
{"address": 123}
GatewayIpv6AddressInput
Fields
| Input Field | Description |
|---|---|
address - String
|
Example
{"address": "xyz789"}
GatewayLifecycleState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
GatewayLifecycleStateFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - GatewayLifecycleStateInput
|
|
in - [GatewayLifecycleStateInput]
|
Example
{"eq": "ACTIVE", "in": ["ACTIVE"]}
GatewayLifecycleStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
GatewayModbusKnownFieldsInput
Fields
| Input Field | Description |
|---|---|
knownFieldQuery - [String]
|
Example
{"knownFieldQuery": ["xyz789"]}
GatewayModel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MODEL_UG100"
GatewayModelFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - GatewayModelInput
|
|
in - [GatewayModelInput]
|
Example
{"eq": "MODEL_UG100", "in": ["MODEL_UG100"]}
GatewayModelInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MODEL_UG100"
GatewayNote
GatewayNoteInput
GatewayProtocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BACNET"
GatewayProtocolInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BACNET"
GatewayProtocolKnownFieldsInput
Fields
| Input Field | Description |
|---|---|
modbusKnownFields - GatewayModbusKnownFieldsInput
|
|
protocol - GatewayProtocolInput
|
Example
{
"modbusKnownFields": GatewayModbusKnownFieldsInput,
"protocol": "BACNET"
}
GatewayProvisioningDetails
Fields
| Field Name | Description |
|---|---|
provisionTime - DateTime
|
Example
{"provisionTime": "2007-12-03T10:15:30Z"}
GatewayRMADetails
Fields
| Field Name | Description |
|---|---|
notesCustomer - [GatewayNote]
|
|
reason - GatewayRMAReason
|
|
rmaTime - DateTime
|
Example
{
"notesCustomer": [GatewayNote],
"reason": "RMA_REASON_CONNECTIVITY",
"rmaTime": "2007-12-03T10:15:30Z"
}
GatewayRMAReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RMA_REASON_CONNECTIVITY"
GatewayRegisterContainerRequestInput
GatewayRegisterContainerResponse
GatewayRegistrationDetails
Fields
| Field Name | Description |
|---|---|
imei - String
|
|
lanMac - String
|
|
mappedModel - GatewayModel
|
|
serialNumber - String
|
|
sim - GatewaySIMInfo
|
Example
{
"imei": "xyz789",
"lanMac": "abc123",
"mappedModel": "MODEL_UG100",
"serialNumber": "abc123",
"sim": GatewaySIMInfo
}
GatewaySIMCertificate
GatewaySIMInfo
Fields
| Field Name | Description |
|---|---|
availableCertificate - GatewaySIMCertificate
|
|
iccid - String
|
|
signingCertificate - GatewaySIMCertificate
|
|
simType - GatewaySIMType
|
Example
{
"availableCertificate": GatewaySIMCertificate,
"iccid": "xyz789",
"signingCertificate": GatewaySIMCertificate,
"simType": "SIM_TYPE_CERTS_ONLY"
}
GatewaySIMType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SIM_TYPE_CERTS_ONLY"
GatewayShippingDetails
Fields
| Field Name | Description |
|---|---|
courier - GatewayCourier
|
|
shipTime - DateTime
|
|
status - GatewayShippingStatus
|
|
statusTime - DateTime
|
|
trackingNumber - String
|
Example
{
"courier": "COURIER_DHL",
"shipTime": "2007-12-03T10:15:30Z",
"status": "SHIPPING_STATUS_DELIVERED",
"statusTime": "2007-12-03T10:15:30Z",
"trackingNumber": "xyz789"
}
GatewayShippingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SHIPPING_STATUS_DELIVERED"
GatewaySubtendedDeviceInput
Fields
| Input Field | Description |
|---|---|
applicationSoftwareVersion - String
|
|
credentials - GatewayCredentialsInput
|
|
deviceDescription - String
|
|
deviceId - [String]
|
|
deviceLocation - String
|
|
deviceName - String
|
|
deviceVersion - String
|
|
hostName - String
|
|
ipAddress - GatewayIpAddressInput
|
|
knownFields - [GatewayProtocolKnownFieldsInput]
|
|
macAddress - String
|
|
manufacturerId - String
|
|
manufacturerName - String
|
|
modelName - String
|
|
port - Int
|
|
protocol - GatewayProtocolInput
|
Example
{
"applicationSoftwareVersion": "xyz789",
"credentials": GatewayCredentialsInput,
"deviceDescription": "xyz789",
"deviceId": ["abc123"],
"deviceLocation": "abc123",
"deviceName": "xyz789",
"deviceVersion": "xyz789",
"hostName": "abc123",
"ipAddress": GatewayIpAddressInput,
"knownFields": [GatewayProtocolKnownFieldsInput],
"macAddress": "abc123",
"manufacturerId": "xyz789",
"manufacturerName": "abc123",
"modelName": "xyz789",
"port": 987,
"protocol": "BACNET"
}
GatewaySuspendRequestInput
Description
Contains the input values needed to suspend a gateway.
Fields
| Input Field | Description |
|---|---|
details - GatewaySuspensionDetailsInput
|
|
gatewayId - String
|
Example
{
"details": GatewaySuspensionDetailsInput,
"gatewayId": "abc123"
}
GatewaySuspendResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
GatewaySuspensionDetails
Fields
| Field Name | Description |
|---|---|
notesCustomer - [GatewayNote]
|
|
reason - GatewaySuspensionReason
|
|
suspensionTime - DateTime
|
Example
{
"notesCustomer": [GatewayNote],
"reason": "SUSPENSION_REASON_ACCOUNT_STATE",
"suspensionTime": "2007-12-03T10:15:30Z"
}
GatewaySuspensionDetailsInput
Fields
| Input Field | Description |
|---|---|
notesCustomer - [GatewayNoteInput]
|
|
reason - GatewaySuspensionReasonInput
|
|
suspensionTime - DateTime
|
Example
{
"notesCustomer": [GatewayNoteInput],
"reason": "SUSPENSION_REASON_ACCOUNT_STATE",
"suspensionTime": "2007-12-03T10:15:30Z"
}
GatewaySuspensionReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUSPENSION_REASON_ACCOUNT_STATE"
GatewaySuspensionReasonInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUSPENSION_REASON_ACCOUNT_STATE"
GatewaySystemTypeFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - SystemTypeKeyInput
|
|
in - [SystemTypeKeyInput]
|
Example
{"eq": "AIR_QUALITY_MONITORING_SYSTEM", "in": ["AIR_QUALITY_MONITORING_SYSTEM"]}
GatewayTerminationDetails
Fields
| Field Name | Description |
|---|---|
notesCustomer - [GatewayNote]
|
|
reason - GatewayTerminationReason
|
|
terminationTime - DateTime
|
Example
{
"notesCustomer": [GatewayNote],
"reason": "TERMINATION_DAMAGED",
"terminationTime": "2007-12-03T10:15:30Z"
}
GatewayTerminationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TERMINATION_DAMAGED"
GenericIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "abc123"
}
GenericPlace
Fields
| Field Name | Description |
|---|---|
address - Address
|
|
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
|
Arguments
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
floors - [Floor]
|
|
Arguments
|
|
geoshape - GeoJSON
|
|
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
|
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
|
identities - [GenericPlaceIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
|
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
|
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
points - [Point]
|
|
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
sites - [Site]
|
|
Arguments
|
|
things - [Thing]
|
|
Arguments
|
|
type - [String]
|
|
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Example
{
"address": Address,
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "xyz789",
"floors": [Floor],
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"sites": [Site],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
GenericPlaceIdentityUnion
Example
AccessCredentialIdentity
GeoJSON
Description
Geodata in JSON format
Example
GeoJSON
GeoPoint
GeoPointQuantity
GeoPointQuantityFilter
Fields
| Input Field | Description |
|---|---|
and - [GeoPointQuantityFilter]
|
|
not - GeoPointQuantityFilter
|
|
or - [GeoPointQuantityFilter]
|
Example
{
"and": [GeoPointQuantityFilter],
"not": GeoPointQuantityFilter,
"or": [GeoPointQuantityFilter]
}
GeolocationEdge
Grant
Description
Currently in development; will contain the details about an access grant.
Fields
| Field Name | Description |
|---|---|
approvalTime - DateTime
|
|
grantedPlacesAndTypes - [GrantPlacesAndTypes]
|
|
granteeUserId - String
|
|
grantorNotes - [GrantNote]
|
|
grantorUserId - String
|
|
id - String
|
The unique ID of the grant. |
requestTime - DateTime
|
|
requests - [GrantRequest]
|
|
state - GrantState
|
|
updateTime - DateTime
|
Example
{
"approvalTime": "2007-12-03T10:15:30Z",
"grantedPlacesAndTypes": [GrantPlacesAndTypes],
"granteeUserId": "xyz789",
"grantorNotes": [GrantNote],
"grantorUserId": "xyz789",
"id": "abc123",
"requestTime": "2007-12-03T10:15:30Z",
"requests": [GrantRequest],
"state": "APPROVED",
"updateTime": "2007-12-03T10:15:30Z"
}
GrantCreateRequestInput
Description
Contains the input values needed to create an access grant.
Fields
| Input Field | Description |
|---|---|
requestedAddress - PostalAddressInput
|
|
requests - [GrantRequestInput]
|
Example
{
"requestedAddress": PostalAddressInput,
"requests": [GrantRequestInput]
}
GrantCreateResponse
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
GrantDeleteRequestInput
GrantDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
GrantFilterInput
Description
Contains the input values needed to filter grant queries.
Fields
| Input Field | Description |
|---|---|
and - [GrantFilterInput]
|
Used to combine multiple filter criteria. |
grantedIds - IDFilterExpressionInput
|
|
grantedTypes - SystemTypeFilterExpressionInput
|
|
granteeUserId - IDFilterExpressionInput
|
|
grantorUserId - IDFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
Used to filter for a specific ID or IDs (refer to IDFilterExpressionInput for input options). |
not - [GrantFilterInput]
|
Used to omit a specific result or results from the response. |
or - [GrantFilterInput]
|
Used to return results that match at least one of the defined criteria. |
state - GrantStateFilterExpressionInput
|
Example
{
"and": [GrantFilterInput],
"grantedIds": IDFilterExpressionInput,
"grantedTypes": SystemTypeFilterExpressionInput,
"granteeUserId": IDFilterExpressionInput,
"grantorUserId": IDFilterExpressionInput,
"id": IDFilterExpressionInput,
"not": [GrantFilterInput],
"or": [GrantFilterInput],
"state": GrantStateFilterExpressionInput
}
GrantNote
GrantPlacesAndTypes
Fields
| Field Name | Description |
|---|---|
grantedIds - [String]
|
|
grantedSystemTypes - [SystemTypeKey]
|
Example
{
"grantedIds": ["abc123"],
"grantedSystemTypes": ["AIR_QUALITY_MONITORING_SYSTEM"]
}
GrantPlacesAndTypesInput
Fields
| Input Field | Description |
|---|---|
grantedIds - [String]
|
|
grantedSystemTypes - [SystemTypeKeyInput]
|
Example
{
"grantedIds": ["xyz789"],
"grantedSystemTypes": ["AIR_QUALITY_MONITORING_SYSTEM"]
}
GrantRequest
Fields
| Field Name | Description |
|---|---|
requestNote - String
|
|
requestType - GrantRequestType
|
|
systemTypes - [SystemTypeKey]
|
Example
{
"requestNote": "xyz789",
"requestType": "ENTIRE_BUILDINGS",
"systemTypes": ["AIR_QUALITY_MONITORING_SYSTEM"]
}
GrantRequestInput
Fields
| Input Field | Description |
|---|---|
requestNote - String
|
|
requestType - GrantRequestTypeInput
|
|
systemTypes - [SystemTypeKeyInput]
|
Example
{
"requestNote": "xyz789",
"requestType": "ENTIRE_BUILDINGS",
"systemTypes": ["AIR_QUALITY_MONITORING_SYSTEM"]
}
GrantRequestType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTIRE_BUILDINGS"
GrantRequestTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTIRE_BUILDINGS"
GrantState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
GrantStateFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - GrantStateInput
|
|
in - [GrantStateInput]
|
Example
{"eq": "APPROVED", "in": ["APPROVED"]}
GrantStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
GrantUpdateRequestInput
Description
Contains the input values needed to update an access grant.
Fields
| Input Field | Description |
|---|---|
grantedPlacesAndTypes - [GrantPlacesAndTypesInput]
|
|
grantorNote - String
|
|
id - String
|
|
requests - [GrantRequestInput]
|
|
state - GrantStateInput
|
Example
{
"grantedPlacesAndTypes": [GrantPlacesAndTypesInput],
"grantorNote": "abc123",
"id": "abc123",
"requests": [GrantRequestInput],
"state": "APPROVED"
}
GrantUpdateResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
GranularInput
GraphEdgeDirection
Description
The list of available graph edge directions
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IN"
GraphNode
Example
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"id": "abc123",
"mappingKey": "xyz789",
"name": "abc123",
"type": ["abc123"]
}
GraphQLJSON
Description
GraphQL JSON
Example
GraphQLJSON
GrossAreaEdge
HMAC256
Fields
| Field Name | Description |
|---|---|
signingKeys - [String]
|
Example
{"signingKeys": ["abc123"]}
HMAC256Input
Fields
| Input Field | Description |
|---|---|
signingKeys - [String]
|
Example
{"signingKeys": ["abc123"]}
HTTPMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONNECT"
HTTPMethodInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONNECT"
HTTPMethodWrapperInput
Fields
| Input Field | Description |
|---|---|
value - HTTPMethodInput
|
Example
{"value": "CONNECT"}
HasAccessCredentialEdge
HasAssignedGroupEdge
HasAssigneeEdge
HasBillEdge
HasDeviceModelEdge
HasHeartbeatEdge
HasLocationEdge
HasMemberEdge
HasPartEdge
HasPartUnion
Types
| Union Types |
|---|
Example
Building
HasPointEdge
HasPrimaryContactEdge
HasProviderEdge
Heartbeat
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
hasHeartbeat - Heartbeat
|
|
Arguments
|
|
hasHeartbeatEdges - [HasHeartbeatEdge]
|
|
id - String!
|
|
identities - [HeartbeatIdentityUnion]
|
|
isBilledTo - Account
|
|
Arguments
|
|
isBilledToEdges - [IsBilledToEdge]
|
|
isPointOf - [IsPointOfUnion]
|
|
Arguments
|
|
isPointOfEdges - [IsPointOfEdge]
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"hasHeartbeat": Heartbeat,
"hasHeartbeatEdges": [HasHeartbeatEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isBilledTo": Account,
"isBilledToEdges": [IsBilledToEdge],
"isPointOf": [Building],
"isPointOfEdges": [IsPointOfEdge],
"mappingKey": "xyz789",
"name": "abc123",
"type": ["abc123"]
}
HeartbeatFilter
Fields
| Input Field | Description |
|---|---|
and - [HeartbeatFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - HeartbeatFilter
|
|
or - [HeartbeatFilter]
|
|
type - StringArrayFilterExpressionInput
|
|
unused - SimpleBoolFilterExpressionInput
|
Example
{
"and": [HeartbeatFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": HeartbeatFilter,
"or": [HeartbeatFilter],
"type": StringArrayFilterExpressionInput,
"unused": SimpleBoolFilterExpressionInput
}
HeartbeatIdentityUnion
Example
AccessCredentialIdentity
IDFilterExpressionInput
Description
Used as the input control for the filter, determining if you're looking for a single result or multiple results.
Example
{
"eq": "xyz789",
"in": ["abc123"]
}
IPAllowlistMatch
Fields
| Field Name | Description |
|---|---|
allowedIps - [String]
|
Example
{"allowedIps": ["xyz789"]}
IPAllowlistMatchInput
Fields
| Input Field | Description |
|---|---|
allowedIps - [String]
|
Example
{"allowedIps": ["xyz789"]}
Identity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "abc123"
}
Int
Description
Built-in Int
Example
123
IntFilterExpressionInput
Interval
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INTERVAL_CUSTOM"
Invite
Description
Contains the details about a user invite.
Fields
| Field Name | Description |
|---|---|
created - DateTime
|
This timestamp represents the date the invite was created. |
email - String
|
The email of the user receiving the invite. |
expiration - DateTime
|
The expiration of the invite; once an invite expires, it cannot be accepted any longer. |
id - String
|
The id of the invite itself. |
inviterUserId - String
|
The id of the user that is created after accepting the invite. |
organization - Org
|
The organization the user was invited to join. |
roles - [Role]
|
The role or roles assigned to the user when they accept the invite, such as ADMIN. |
status - InviteStatus
|
The current status of the invite, such as PENDING or ACCEPTED. |
Example
{
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"expiration": "2007-12-03T10:15:30Z",
"id": "xyz789",
"inviterUserId": "abc123",
"organization": Org,
"roles": ["ADMIN"],
"status": "ACCEPTED"
}
InviteCreateRequestInput
Fields
| Input Field | Description |
|---|---|
invite - InviteInput
|
|
skipSendEmail - Boolean
|
Example
{"invite": InviteInput, "skipSendEmail": false}
InviteCreateResponse
InviteDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
InviteDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
InviteFilterInput
Fields
| Input Field | Description |
|---|---|
and - [InviteFilterInput]
|
|
email - StringFilterExpressionInput
|
|
inviteId - IDFilterExpressionInput
|
|
not - [InviteFilterInput]
|
|
or - [InviteFilterInput]
|
|
state - InviteStatusFilterExpressionInput
|
Example
{
"and": [InviteFilterInput],
"email": StringFilterExpressionInput,
"inviteId": IDFilterExpressionInput,
"not": [InviteFilterInput],
"or": [InviteFilterInput],
"state": InviteStatusFilterExpressionInput
}
InviteInput
Description
Contains the details about a user invite.
Fields
| Input Field | Description |
|---|---|
created - DateTime
|
This timestamp represents the date the invite was created. |
email - String
|
The email of the user receiving the invite. |
expiration - DateTime
|
The expiration of the invite; once an invite expires, it cannot be accepted any longer. |
id - String
|
The id of the invite itself. |
inviterUserId - String
|
The id of the user that is created after accepting the invite. |
roles - [RoleInput]
|
The role or roles assigned to the user when they accept the invite, such as ADMIN. |
status - InviteStatusInput
|
The current status of the invite, such as PENDING or ACCEPTED. |
Example
{
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"expiration": "2007-12-03T10:15:30Z",
"id": "xyz789",
"inviterUserId": "xyz789",
"roles": ["ADMIN"],
"status": "ACCEPTED"
}
InviteStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
InviteStatusFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - InviteStatusInput
|
|
in - [InviteStatusInput]
|
Example
{"eq": "ACCEPTED", "in": ["ACCEPTED"]}
InviteStatusInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
InviteUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
invite - InviteInput
|
Example
{"invite": InviteInput}
InviteUpdateResponse
Fields
| Field Name | Description |
|---|---|
invite - Invite
|
Example
{"invite": Invite}
IsAdjacentToEdge
IsBilledToEdge
IsClosedByEdge
IsCreatedByEdge
IsFedByEdge
IsFedByUnion
Types
| Union Types |
|---|
Example
Collection
IsLocationOfEdge
IsLocationOfUnion
Types
| Union Types |
|---|
Example
Collection
IsMemberOfEdge
IsPartOfEdge
IsPointOfEdge
IsPointOfUnion
Types
| Union Types |
|---|
Example
Building
IsReportedByEdge
IsResponsibilityOfEdge
IsResponsibleForEdge
IsServedByEdge
JSONLD
Description
JSON-LD is a lightweight Linked Data format.
Example
JSONLD
JSONSchema
Description
JSON Schema is a powerful type for validating the structure of JSON data
Example
JSONSchema
Lease
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
|
Arguments
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
id - String!
|
|
identities - [LeaseIdentityUnion]
|
|
leaseOf - [Place!]
|
|
Arguments
|
|
leasee - Org
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"leaseOf": [Place],
"leasee": Org,
"mappingKey": "abc123",
"name": "xyz789",
"type": ["xyz789"]
}
LeaseFilter
Fields
| Input Field | Description |
|---|---|
and - [LeaseFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - LeaseFilter
|
|
or - [LeaseFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [LeaseFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": LeaseFilter,
"or": [LeaseFilter],
"type": StringArrayFilterExpressionInput
}
LeaseIdentityUnion
Example
AccessCredentialIdentity
LiveQuery
Description
Contains all the detals about a live query.
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
This timestamp represents the date the live query was created. |
dateUpdated - DateTime
|
This timestamp represents the date the lie query was last updated. |
id - String
|
The unique id of the live query. |
lastErrorDate - DateTime
|
This timestamp represents the last time the live query encountered an error. |
lastResult - GraphQLJSON
|
This returns the last result of the live query, in standard Mapped JSON format. |
lastResultDate - DateTime
|
This timestamp represents the date for the most recent live query result. |
name - String
|
The unique name of the live query. |
organization - Org
|
The organization the live query belongs to. |
query - String
|
The query being run by the live query, i.e. the request being made to the Mapped API. |
status - LiveQueryStatus
|
This identifies whether the live query is currently RUNNING, PAUSED, FAILED or LIVE_QUERY_STATUS_UNSPECIFIED. |
user - User
|
The user the live query belong to. |
variables - GraphQLJSON
|
Example
{
"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": "abc123",
"status": "FAILING",
"user": User,
"variables": GraphQLJSON
}
LiveQueryCreateRequestInput
Fields
| Input Field | Description |
|---|---|
liveQuery - LiveQueryInput
|
Example
{"liveQuery": LiveQueryInput}
LiveQueryCreateResponse
Fields
| Field Name | Description |
|---|---|
liveQuery - LiveQuery
|
Example
{"liveQuery": LiveQuery}
LiveQueryDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
LiveQueryDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
LiveQueryFilterInput
Fields
| Input Field | Description |
|---|---|
and - [LiveQueryFilterInput]
|
|
id - IDFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - [LiveQueryFilterInput]
|
|
or - [LiveQueryFilterInput]
|
|
status - LiveQueryStatusFilterExpressionInput
|
Example
{
"and": [LiveQueryFilterInput],
"id": IDFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": [LiveQueryFilterInput],
"or": [LiveQueryFilterInput],
"status": LiveQueryStatusFilterExpressionInput
}
LiveQueryInput
Description
Contains all the detals about a live query.
Fields
| Input Field | Description |
|---|---|
dateCreated - DateTime
|
This timestamp represents the date the live query was created. |
dateUpdated - DateTime
|
This timestamp represents the date the lie query was last updated. |
id - String
|
The unique id of the live query. |
lastErrorDate - DateTime
|
This timestamp represents the last time the live query encountered an error. |
lastResultDate - DateTime
|
This timestamp represents the date for the most recent live query result. |
name - String
|
The unique name of the live query. |
query - String
|
The query being run by the live query, i.e. the request being made to the Mapped API. |
status - LiveQueryStatusInput
|
This identifies whether the live query is currently RUNNING, PAUSED, FAILED or LIVE_QUERY_STATUS_UNSPECIFIED. |
variables - GraphQLJSON
|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"lastErrorDate": "2007-12-03T10:15:30Z",
"lastResultDate": "2007-12-03T10:15:30Z",
"name": "abc123",
"query": "xyz789",
"status": "FAILING",
"variables": GraphQLJSON
}
LiveQueryPauseRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
LiveQueryPauseResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
LiveQueryResumeRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
LiveQueryResumeResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
LiveQueryStatus
Description
Contains the details about the status field for a live query.
Values
| Enum Value | Description |
|---|---|
|
|
The live query encountered an error and is not running; contact support@mapped.com for help. |
|
|
The live query is returning an uncategorized status; contact support@mapped.com for help. |
|
|
The live query is paused, using pauseLiveQuery. Use resumeLiveQuery to restore it to active. |
|
|
The live query is actively running and monitoring for changes to the defined query. |
Example
"FAILING"
LiveQueryStatusFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - LiveQueryStatusInput
|
|
in - [LiveQueryStatusInput]
|
Example
{"eq": "FAILING", "in": ["FAILING"]}
LiveQueryStatusInput
Description
Contains the details about the status field for a live query.
Values
| Enum Value | Description |
|---|---|
|
|
The live query encountered an error and is not running; contact support@mapped.com for help. |
|
|
The live query is returning an uncategorized status; contact support@mapped.com for help. |
|
|
The live query is paused, using pauseLiveQuery. Use resumeLiveQuery to restore it to active. |
|
|
The live query is actively running and monitoring for changes to the defined query. |
Example
"FAILING"
LiveQueryUpdateInput
LiveQueryUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
liveQuery - LiveQueryUpdateInput
|
Example
{"liveQuery": LiveQueryUpdateInput}
LiveQueryUpdateResponse
Fields
| Field Name | Description |
|---|---|
liveQuery - LiveQuery
|
Example
{"liveQuery": LiveQuery}
Long
Description
A 64-bit signed integer
Example
{}
MTLSMatch
Fields
| Field Name | Description |
|---|---|
clientCert - Certificate
|
|
issuerCert - Certificate
|
|
mappedCert - Boolean
|
|
matchCert - CertMatch
|
Example
{
"clientCert": Certificate,
"issuerCert": Certificate,
"mappedCert": false,
"matchCert": CertMatch
}
MTLSMatchInput
Fields
| Input Field | Description |
|---|---|
clientCert - CertificateInput
|
|
issuerCert - CertificateInput
|
|
mappedCert - Boolean
|
|
matchCert - CertMatchInput
|
Example
{
"clientCert": CertificateInput,
"issuerCert": CertificateInput,
"mappedCert": true,
"matchCert": CertMatchInput
}
ManufacturedByEdge
Map
Example
Map
Match
Fields
| Field Name | Description |
|---|---|
ipAllowlist - IPAllowlistMatch
|
|
mtls - MTLSMatch
|
|
noAuth - Boolean
|
|
regex - RegexMatch
|
|
signature - SignatureMatch
|
|
value - ValueMatch
|
Example
{
"ipAllowlist": IPAllowlistMatch,
"mtls": MTLSMatch,
"noAuth": false,
"regex": RegexMatch,
"signature": SignatureMatch,
"value": ValueMatch
}
MatchInput
Fields
| Input Field | Description |
|---|---|
ipAllowlist - IPAllowlistMatchInput
|
|
mtls - MTLSMatchInput
|
|
noAuth - Boolean
|
|
regex - RegexMatchInput
|
|
signature - SignatureMatchInput
|
|
value - ValueMatchInput
|
Example
{
"ipAllowlist": IPAllowlistMatchInput,
"mtls": MTLSMatchInput,
"noAuth": false,
"regex": RegexMatchInput,
"signature": SignatureMatchInput,
"value": ValueMatchInput
}
MetadataEntry
MetadataRecord
MetadataRecordInput
MetadataUpdateInput
Fields
| Input Field | Description |
|---|---|
granular - GranularInput
|
|
replace - MetadataValueInput
|
Example
{
"granular": GranularInput,
"replace": MetadataValueInput
}
MetadataValueInput
Fields
| Input Field | Description |
|---|---|
values - [MetadataRecordInput]
|
Example
{"values": [MetadataRecordInput]}
NameIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "xyz789"
}
NameIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| NameIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
NodesMapping
OAuth2ClientCredentialsFlow
OAuth2ClientCredentialsFlowInput
OneTimePriceItem
OneTimePriceItems
Fields
| Field Name | Description |
|---|---|
items - [OneTimePriceItem]
|
Example
{"items": [OneTimePriceItem]}
Org
Description
Contains the details about a org.
Fields
| Field Name | Description |
|---|---|
authenticationChallenge - OrgAuthenticationChallenge
|
|
connectors - [Connector]
|
Contains the list of org connectors, across all places in the org. |
Arguments
|
|
created - DateTime
|
Timestamp for the org creation. |
gateways - [Gateway]
|
Contains the list of org gateways, across all places in the org. |
Arguments
|
|
id - String
|
The unique ID of the organization. |
metadata - [MetadataRecord]
|
|
name - String
|
The name of the organization. |
provisioningState - OrgProvisioningState
|
|
sites - [Site]
|
Contains the list of sites in the org. |
Arguments
|
|
state - OrgState
|
|
stripeCustomerId - String
|
|
things - [Thing]
|
Contains the list of things, across all places in the org. |
Arguments
|
|
updated - DateTime
|
|
users - [User]
|
Contains the list of users in the org. |
Arguments
|
|
Example
{
"authenticationChallenge": OrgAuthenticationChallenge,
"connectors": [Connector],
"created": "2007-12-03T10:15:30Z",
"gateways": [Gateway],
"id": "xyz789",
"metadata": [MetadataRecord],
"name": "xyz789",
"provisioningState": "PROVISIONING_STATE_ACCEPTED",
"sites": [Site],
"state": "ACTIVE",
"stripeCustomerId": "xyz789",
"things": [Thing],
"updated": "2007-12-03T10:15:30Z",
"users": [User]
}
OrgAuthenticationChallenge
OrgAuthenticationChallengeGranularInput
OrgAuthenticationChallengeInput
OrgGranularInput
Fields
| Input Field | Description |
|---|---|
authenticationChallenge - OrgAuthenticationChallengeGranularInput
|
|
id - String
|
|
metadata - MetadataUpdateInput
|
|
name - String
|
|
provisioningState - OrgProvisioningStateWrapperInput
|
|
state - OrgStateWrapperInput
|
|
stripeCustomerId - String
|
Example
{
"authenticationChallenge": OrgAuthenticationChallengeGranularInput,
"id": "abc123",
"metadata": MetadataUpdateInput,
"name": "abc123",
"provisioningState": OrgProvisioningStateWrapperInput,
"state": OrgStateWrapperInput,
"stripeCustomerId": "xyz789"
}
OrgInput
Description
Contains the details about a org.
Fields
| Input Field | Description |
|---|---|
authenticationChallenge - OrgAuthenticationChallengeInput
|
|
created - DateTime
|
Timestamp for the org creation. |
id - String
|
The unique ID of the organization. |
metadata - [MetadataRecordInput]
|
|
name - String
|
The name of the organization. |
provisioningState - OrgProvisioningStateInput
|
|
state - OrgStateInput
|
|
stripeCustomerId - String
|
|
updated - DateTime
|
Example
{
"authenticationChallenge": OrgAuthenticationChallengeInput,
"created": "2007-12-03T10:15:30Z",
"id": "xyz789",
"metadata": [MetadataRecordInput],
"name": "xyz789",
"provisioningState": "PROVISIONING_STATE_ACCEPTED",
"state": "ACTIVE",
"stripeCustomerId": "abc123",
"updated": "2007-12-03T10:15:30Z"
}
OrgIsOrgNameAvailableResponse
OrgProvisioningState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PROVISIONING_STATE_ACCEPTED"
OrgProvisioningStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PROVISIONING_STATE_ACCEPTED"
OrgProvisioningStateWrapperInput
Fields
| Input Field | Description |
|---|---|
value - OrgProvisioningStateInput
|
Example
{"value": "PROVISIONING_STATE_ACCEPTED"}
OrgRemoveOrgUserAsyncRequestInput
Fields
| Input Field | Description |
|---|---|
orgUser - OrgUserInput
|
Example
{"orgUser": OrgUserInput}
OrgRemoveOrgUserAsyncResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
OrgRoleGroupCreateRequestInput
Fields
| Input Field | Description |
|---|---|
orgRoleGroup - OrgRoleGroupInput
|
Example
{"orgRoleGroup": OrgRoleGroupInput}
OrgRoleGroupCreateResponse
Fields
| Field Name | Description |
|---|---|
orgRoleGroup - OrgRoleGroupDTO
|
Example
{"orgRoleGroup": OrgRoleGroupDTO}
OrgRoleGroupDTO
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": "xyz789",
"isSynced": false,
"name": "abc123",
"roles": ["xyz789"],
"state": "ORGROLEGROUP_STATE_DISABLED",
"updatedAt": "2007-12-03T10:15:30Z"
}
OrgRoleGroupDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "xyz789"}
OrgRoleGroupDeleteResponse
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": false}
OrgRoleGroupFilterInput
Fields
| Input Field | Description |
|---|---|
and - [OrgRoleGroupFilterInput]
|
|
description - StringFilterExpressionInput
|
|
isSynced - BoolFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - [OrgRoleGroupFilterInput]
|
|
or - [OrgRoleGroupFilterInput]
|
|
roles - StringArrayFilterExpressionInput
|
|
state - OrgRoleGroupStateFilterExpressionInput
|
Example
{
"and": [OrgRoleGroupFilterInput],
"description": StringFilterExpressionInput,
"isSynced": BoolFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": [OrgRoleGroupFilterInput],
"or": [OrgRoleGroupFilterInput],
"roles": StringArrayFilterExpressionInput,
"state": OrgRoleGroupStateFilterExpressionInput
}
OrgRoleGroupInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
isSynced - Boolean
|
|
name - String
|
|
roles - [String]
|
|
state - OrgRoleGroupStateInput
|
Example
{
"description": "abc123",
"isSynced": false,
"name": "abc123",
"roles": ["abc123"],
"state": "ORGROLEGROUP_STATE_DISABLED"
}
OrgRoleGroupState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ORGROLEGROUP_STATE_DISABLED"
OrgRoleGroupStateFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - OrgRoleGroupStateInput
|
|
in - [OrgRoleGroupStateInput]
|
Example
{"eq": "ORGROLEGROUP_STATE_DISABLED", "in": ["ORGROLEGROUP_STATE_DISABLED"]}
OrgRoleGroupStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ORGROLEGROUP_STATE_DISABLED"
OrgRoleGroupStateValueInput
Fields
| Input Field | Description |
|---|---|
value - OrgRoleGroupStateInput
|
Example
{"value": "ORGROLEGROUP_STATE_DISABLED"}
OrgRoleGroupUpdateInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
name - String
|
|
roles - StringArrayUpdateInput
|
|
state - OrgRoleGroupStateValueInput
|
Example
{
"description": "abc123",
"name": "abc123",
"roles": StringArrayUpdateInput,
"state": OrgRoleGroupStateValueInput
}
OrgRoleGroupUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
granular - OrgRoleGroupUpdateInput
|
|
replace - OrgRoleGroupInput
|
Example
{
"granular": OrgRoleGroupUpdateInput,
"replace": OrgRoleGroupInput
}
OrgRoleGroupUpdateResponse
Fields
| Field Name | Description |
|---|---|
orgRoleGroup - OrgRoleGroupDTO
|
Example
{"orgRoleGroup": OrgRoleGroupDTO}
OrgServiceAccountContainer
Fields
| Field Name | Description |
|---|---|
orgServiceAccount - OrgServiceAccountDTO
|
|
secrets - [OrgServiceAccountSecretHint]
|
Example
{
"orgServiceAccount": OrgServiceAccountDTO,
"secrets": [OrgServiceAccountSecretHint]
}
OrgServiceAccountCreateRequestInput
Fields
| Input Field | Description |
|---|---|
orgServiceAccount - OrgServiceAccountInput
|
Example
{"orgServiceAccount": OrgServiceAccountInput}
OrgServiceAccountCreateResponse
Fields
| Field Name | Description |
|---|---|
orgServiceAccount - OrgServiceAccountDTO
|
Example
{"orgServiceAccount": OrgServiceAccountDTO}
OrgServiceAccountCreateSecretRequestInput
OrgServiceAccountCreateSecretResponse
OrgServiceAccountCustomRole
Fields
| Field Name | Description |
|---|---|
permissions - [String]
|
Example
{"permissions": ["xyz789"]}
OrgServiceAccountCustomRoleInput
Fields
| Input Field | Description |
|---|---|
permissions - [String]
|
Example
{"permissions": ["xyz789"]}
OrgServiceAccountCustomRoleUpdateInput
Fields
| Input Field | Description |
|---|---|
permissions - StringArrayUpdateInput
|
Example
{"permissions": StringArrayUpdateInput}
OrgServiceAccountDTO
Fields
| Field Name | Description |
|---|---|
clientId - String
|
|
createdAt - DateTime
|
|
customRole - OrgServiceAccountCustomRole
|
|
description - String
|
|
id - String
|
|
isSynced - Boolean
|
|
name - String
|
|
orgRoleGroups - [String]
|
|
state - OrgServiceAccountState
|
|
updatedAt - DateTime
|
Example
{
"clientId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"customRole": OrgServiceAccountCustomRole,
"description": "xyz789",
"id": "abc123",
"isSynced": true,
"name": "xyz789",
"orgRoleGroups": ["xyz789"],
"state": "ORGSERVICEACCOUNT_STATE_DISABLED",
"updatedAt": "2007-12-03T10:15:30Z"
}
OrgServiceAccountDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "abc123"}
OrgServiceAccountDeleteResponse
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": false}
OrgServiceAccountDeleteSecretsRequestInput
Fields
| Input Field | Description |
|---|---|
all - OrgServiceAccountOneOfAllInput
|
|
granular - OrgServiceAccountOneOfSecretsGranularInput
|
|
serviceAccountName - String
|
Example
{
"all": OrgServiceAccountOneOfAllInput,
"granular": OrgServiceAccountOneOfSecretsGranularInput,
"serviceAccountName": "abc123"
}
OrgServiceAccountDeleteSecretsResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
OrgServiceAccountFilterInput
Fields
| Input Field | Description |
|---|---|
and - [OrgServiceAccountFilterInput]
|
|
description - StringFilterExpressionInput
|
|
isSynced - BoolFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - [OrgServiceAccountFilterInput]
|
|
or - [OrgServiceAccountFilterInput]
|
|
orgRoleGroups - StringArrayFilterExpressionInput
|
|
state - OrgServiceAccountStateFilterExpressionInput
|
Example
{
"and": [OrgServiceAccountFilterInput],
"description": StringFilterExpressionInput,
"isSynced": BoolFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": [OrgServiceAccountFilterInput],
"or": [OrgServiceAccountFilterInput],
"orgRoleGroups": StringArrayFilterExpressionInput,
"state": OrgServiceAccountStateFilterExpressionInput
}
OrgServiceAccountInput
Fields
| Input Field | Description |
|---|---|
customRole - OrgServiceAccountCustomRoleInput
|
|
description - String
|
|
name - String
|
|
orgRoleGroups - [String]
|
|
state - OrgServiceAccountStateInput
|
Example
{
"customRole": OrgServiceAccountCustomRoleInput,
"description": "abc123",
"name": "abc123",
"orgRoleGroups": ["xyz789"],
"state": "ORGSERVICEACCOUNT_STATE_DISABLED"
}
OrgServiceAccountOneOfAllInput
Fields
| Input Field | Description |
|---|---|
_ - String
|
NOT USED |
Example
{"_": "abc123"}
OrgServiceAccountOneOfSecretsGranularInput
Fields
| Input Field | Description |
|---|---|
secretNames - [String]
|
Example
{"secretNames": ["abc123"]}
OrgServiceAccountSecretHint
OrgServiceAccountState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ORGSERVICEACCOUNT_STATE_DISABLED"
OrgServiceAccountStateFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - OrgServiceAccountStateInput
|
|
in - [OrgServiceAccountStateInput]
|
Example
{
"eq": "ORGSERVICEACCOUNT_STATE_DISABLED",
"in": ["ORGSERVICEACCOUNT_STATE_DISABLED"]
}
OrgServiceAccountStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ORGSERVICEACCOUNT_STATE_DISABLED"
OrgServiceAccountStateValueInput
Fields
| Input Field | Description |
|---|---|
value - OrgServiceAccountStateInput
|
Example
{"value": "ORGSERVICEACCOUNT_STATE_DISABLED"}
OrgServiceAccountUpdateInput
Fields
| Input Field | Description |
|---|---|
customRole - OrgServiceAccountCustomRoleUpdateInput
|
|
description - String
|
|
name - String
|
|
orgRoleGroups - StringArrayUpdateInput
|
|
state - OrgServiceAccountStateValueInput
|
Example
{
"customRole": OrgServiceAccountCustomRoleUpdateInput,
"description": "xyz789",
"name": "abc123",
"orgRoleGroups": StringArrayUpdateInput,
"state": OrgServiceAccountStateValueInput
}
OrgServiceAccountUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
granular - OrgServiceAccountUpdateInput
|
|
replace - OrgServiceAccountInput
|
Example
{
"granular": OrgServiceAccountUpdateInput,
"replace": OrgServiceAccountInput
}
OrgServiceAccountUpdateResponse
Fields
| Field Name | Description |
|---|---|
orgServiceAccount - OrgServiceAccountDTO
|
Example
{"orgServiceAccount": OrgServiceAccountDTO}
OrgState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
OrgStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
OrgStateWrapperInput
Fields
| Input Field | Description |
|---|---|
value - OrgStateInput
|
Example
{"value": "ACTIVE"}
OrgUpdateRequestInput
Description
Contains the input values needed to update an organization.
Fields
| Input Field | Description |
|---|---|
org - OrgInput
|
Contains the input values for the org details, such as name and admin contact. |
Example
{"org": OrgInput}
OrgUpdateResponse
Fields
| Field Name | Description |
|---|---|
org - Org
|
Example
{"org": Org}
OrgUpdateV2RequestInput
Fields
| Input Field | Description |
|---|---|
org - OrgGranularInput
|
Example
{"org": OrgGranularInput}
OrgUpdateV2Response
Fields
| Field Name | Description |
|---|---|
org - Org
|
Example
{"org": Org}
OrgUserInput
Organization
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
hasMember - [Person]
|
|
Arguments
|
|
hasMemberEdges - [HasMemberEdge]
|
|
hasPart - [Organization]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPrimaryContact - [Person]
|
|
Arguments
|
|
hasPrimaryContactEdges - [HasPrimaryContactEdge]
|
|
id - String!
|
|
identities - [OrganizationIdentityUnion]
|
|
isProviderOf - [Account]
|
|
Arguments
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"hasMember": [Person],
"hasMemberEdges": [HasMemberEdge],
"hasPart": [Organization],
"hasPartEdges": [HasPartEdge],
"hasPrimaryContact": [Person],
"hasPrimaryContactEdges": [HasPrimaryContactEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isProviderOf": [Account],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "abc123",
"name": "abc123",
"type": ["xyz789"]
}
OrganizationFilter
Fields
| Input Field | Description |
|---|---|
and - [OrganizationFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - OrganizationFilter
|
|
or - [OrganizationFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [OrganizationFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": OrganizationFilter,
"or": [OrganizationFilter],
"type": StringArrayFilterExpressionInput
}
OrganizationIdentityUnion
Example
AccessCredentialIdentity
PeopleGroup
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
hasMember - [Person]
|
|
Arguments
|
|
hasMemberEdges - [HasMemberEdge]
|
|
hasPart - Org
|
|
hasPrimaryContact - [Person]
|
|
Arguments
|
|
hasPrimaryContactEdges - [HasPrimaryContactEdge]
|
|
id - String!
|
|
identities - [PeopleGroupIdentityUnion]
|
|
isProviderOf - [Account]
|
|
Arguments
|
|
isResponsibleFor - [Thing]
|
|
Arguments
|
|
isResponsibleForEdges - [IsResponsibleForEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "abc123",
"hasMember": [Person],
"hasMemberEdges": [HasMemberEdge],
"hasPart": Org,
"hasPrimaryContact": [Person],
"hasPrimaryContactEdges": [HasPrimaryContactEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isProviderOf": [Account],
"isResponsibleFor": [Thing],
"isResponsibleForEdges": [IsResponsibleForEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "abc123",
"name": "abc123",
"type": ["xyz789"]
}
PeopleGroupFilter
Fields
| Input Field | Description |
|---|---|
and - [PeopleGroupFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - PeopleGroupFilter
|
|
or - [PeopleGroupFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [PeopleGroupFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": PeopleGroupFilter,
"or": [PeopleGroupFilter],
"type": StringArrayFilterExpressionInput
}
PeopleGroupIdentityUnion
Example
AccessCredentialIdentity
Permission
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANAXIENRICHMENT_READWRITE_ALL"
PermissionFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - PermissionInput
|
|
in - [PermissionInput]
|
Example
{"eq": "ANAXIENRICHMENT_READWRITE_ALL", "in": ["ANAXIENRICHMENT_READWRITE_ALL"]}
PermissionInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANAXIENRICHMENT_READWRITE_ALL"
Person
Description
Contains the details about a individual detected in the data from a building, such as a conference room booking.
Fields
| Field Name | Description |
|---|---|
additionalName - String
|
|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
emails - [EmailAddress]
|
Any emails associated with the individual. |
Arguments
|
|
exactType - String
|
|
familyName - String
|
Surname or last name of the individual. |
givenName - String
|
Personal name or first name of the individual. |
hasAccessCredential - [AccessCredential]
|
|
Arguments
|
|
hasAccessCredentialEdges - [HasAccessCredentialEdge]
|
|
hasCalendarEvents - [CalendarEvent]
|
|
Arguments
|
|
hasCalendarInvitations - [CalendarInvitation]
|
|
Arguments
|
|
id - String!
|
The unique ID of the individual. |
identities - [PersonIdentityUnion]
|
|
isMemberOf - [Organization]
|
|
Arguments
|
|
isMemberOfEdges - [IsMemberOfEdge]
|
|
mappingKey - String
|
|
name - String
|
|
type - [String]
|
|
Example
{
"additionalName": "xyz789",
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"emails": [EmailAddress],
"exactType": "abc123",
"familyName": "abc123",
"givenName": "abc123",
"hasAccessCredential": [AccessCredential],
"hasAccessCredentialEdges": [HasAccessCredentialEdge],
"hasCalendarEvents": [CalendarEvent],
"hasCalendarInvitations": [CalendarInvitation],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isMemberOf": [Organization],
"isMemberOfEdges": [IsMemberOfEdge],
"mappingKey": "abc123",
"name": "abc123",
"type": ["xyz789"]
}
PersonFilter
Fields
| Input Field | Description |
|---|---|
and - [PersonFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
email - StringFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - PersonFilter
|
|
or - [PersonFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [PersonFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"email": StringFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": PersonFilter,
"or": [PersonFilter],
"type": StringArrayFilterExpressionInput
}
PersonIdentityUnion
Example
AccessCredentialIdentity
PersonalAccessToken
Description
Contains the details about a personal access token.
Fields
| Field Name | Description |
|---|---|
created - DateTime
|
Timestamp of the token creation. |
id - String
|
The unique ID of the access token. |
integrityId - String
|
|
lastExchanged - DateTime
|
The last time the token was used. |
name - String
|
The name assigned to the access token. |
permissions - [Permission]
|
The available permissions / scopes for the token, such as THING_READ_ALL |
updated - DateTime
|
Timestamp the token was last updated, including when permissions were added or removed. |
userId - String
|
The user the token belongs to. |
Example
{
"created": "2007-12-03T10:15:30Z",
"id": "abc123",
"integrityId": "abc123",
"lastExchanged": "2007-12-03T10:15:30Z",
"name": "xyz789",
"permissions": ["ANAXIENRICHMENT_READWRITE_ALL"],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789"
}
PersonalAccessTokenCreateRequestInput
Description
Contains the input values needed to create a token.
Fields
| Input Field | Description |
|---|---|
pat - PersonalAccessTokenInput
|
Contains the input values for the token details, such as name and permissions. |
Example
{"pat": PersonalAccessTokenInput}
PersonalAccessTokenCreateResponse
Fields
| Field Name | Description |
|---|---|
pat - PersonalAccessToken
|
|
token - String
|
Example
{
"pat": PersonalAccessToken,
"token": "xyz789"
}
PersonalAccessTokenDeleteRequestInput
Description
Contains the input values needed to delete a token.
Fields
| Input Field | Description |
|---|---|
id - String
|
Provide the id of the token here. |
Example
{"id": "xyz789"}
PersonalAccessTokenDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
PersonalAccessTokenFilterInput
Description
Contains the input values needed to filter token queries.
Fields
| Input Field | Description |
|---|---|
and - [PersonalAccessTokenFilterInput]
|
Used to combine multiple filter criteria. |
id - IDFilterExpressionInput
|
Used to filter for a specific ID or IDs (refer to IDFilterExpressionInput for input options). |
name - StringFilterExpressionInput
|
|
not - [PersonalAccessTokenFilterInput]
|
Used to omit a specific result or results from the response. |
or - [PersonalAccessTokenFilterInput]
|
Used to return results that match at least one of the defined criteria. |
permissions - PermissionFilterExpressionInput
|
|
userId - IDFilterExpressionInput
|
Example
{
"and": [PersonalAccessTokenFilterInput],
"id": IDFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": [PersonalAccessTokenFilterInput],
"or": [PersonalAccessTokenFilterInput],
"permissions": PermissionFilterExpressionInput,
"userId": IDFilterExpressionInput
}
PersonalAccessTokenGetAccessTokenFromPATRequestInput
Fields
| Input Field | Description |
|---|---|
personalAccessToken - String
|
Example
{"personalAccessToken": "xyz789"}
PersonalAccessTokenInput
Description
Contains the details about a personal access token.
Fields
| Input Field | Description |
|---|---|
created - DateTime
|
Timestamp of the token creation. |
id - String
|
The unique ID of the access token. |
integrityId - String
|
|
lastExchanged - DateTime
|
The last time the token was used. |
name - String
|
The name assigned to the access token. |
permissions - [PermissionInput]
|
The available permissions / scopes for the token, such as THING_READ_ALL |
updated - DateTime
|
Timestamp the token was last updated, including when permissions were added or removed. |
userId - String
|
The user the token belongs to. |
Example
{
"created": "2007-12-03T10:15:30Z",
"id": "xyz789",
"integrityId": "xyz789",
"lastExchanged": "2007-12-03T10:15:30Z",
"name": "abc123",
"permissions": ["ANAXIENRICHMENT_READWRITE_ALL"],
"updated": "2007-12-03T10:15:30Z",
"userId": "xyz789"
}
PersonalAccessTokenIsPatNameAvailableResponse
PersonalAccessTokenUpdateRequestInput
Description
Contains the input values needed to update a token.
Fields
| Input Field | Description |
|---|---|
pat - PersonalAccessTokenInput
|
Contains the input values for the token details, such as name and permissions. |
Example
{"pat": PersonalAccessTokenInput}
PersonalAccessTokenUpdateResponse
Fields
| Field Name | Description |
|---|---|
pat - PersonalAccessToken
|
|
token - String
|
Example
{
"pat": PersonalAccessToken,
"token": "xyz789"
}
Place
Description
Contains all the details of any places associated with a particular thing, such as a space or a floor.
Fields
| Field Name | Description |
|---|---|
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
|
Arguments
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
|
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of the place. |
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
|
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
|
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
The name of the place. |
points - [Point]
|
|
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
things - [Thing]
|
Contains the complete list of things associated with the place. |
Arguments
|
|
type - [String]
|
|
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Possible Types
| Place Types |
|---|
Example
{
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
PlaceFilter
Fields
| Input Field | Description |
|---|---|
and - [PlaceFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - PlaceFilter
|
|
or - [PlaceFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [PlaceFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": PlaceFilter,
"or": [PlaceFilter],
"type": StringArrayFilterExpressionInput
}
Point
Description
Contains the details about the point, such as a thermostat setpoint.
Fields
| Field Name | Description |
|---|---|
aggregation - [TimeseriesAggregateRow]
|
Time series data gathered together to return a new value, such as an average temperature across a set time pe or a min or max value. |
Arguments
|
|
connectedDataSourceId - String
|
|
datatype - DatatypeKey
|
|
dateCreated - DateTime
|
This timestamp represents the date the point was created. |
dateUpdated - DateTime
|
This timestamp represents that date the point was last updated. |
description - String
|
The description of the point, like "Cooling Temperature Setpoint". |
exactType - String
|
This is the most specific type available for the point, i.e. where 'type' may return a list like [Point, Alarm, TemperatureAlarm, HighTemperatureAlarm], exactType will return just HighTemperatureAlarm. |
hasBill - [Point]
|
|
Arguments
|
|
hasHeartbeat - Heartbeat
|
|
Arguments
|
|
hasHeartbeatEdges - [HasHeartbeatEdge]
|
|
id - String!
|
The unique ID of the point. |
identities - [PointIdentityUnion]
|
|
isBilledTo - Account
|
|
Arguments
|
|
isBilledToEdges - [IsBilledToEdge]
|
|
isPointOf - [IsPointOfUnion]
|
|
Arguments
|
|
isPointOfEdges - [IsPointOfEdge]
|
|
mappingKey - String
|
|
name - String
|
The name assigned to the point. |
series - [TimeseriesRow]
|
Time series data for the point, such as what the air temperature setpoint was for a VAV, limited by a defined start and end time. |
stateTexts - [String]
|
Ordered list of additional descriptive data to help explain float values like 0.0, 1.0 and 2.0. |
type - [String]
|
The class or subclass of the point, like "Alarm" and "TemperatureAlarm". |
unit - Unit
|
The unit of measurement associated with this point, such as "Degrees". |
unused - Boolean
|
|
valueMap - Map
|
|
Example
{
"aggregation": [TimeseriesAggregateRow],
"connectedDataSourceId": "abc123",
"datatype": "DATATYPE_KEY_UNSPECIFIED",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"hasBill": [Point],
"hasHeartbeat": Heartbeat,
"hasHeartbeatEdges": [HasHeartbeatEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isBilledTo": Account,
"isBilledToEdges": [IsBilledToEdge],
"isPointOf": [Building],
"isPointOfEdges": [IsPointOfEdge],
"mappingKey": "abc123",
"name": "xyz789",
"series": [TimeseriesRow],
"stateTexts": ["abc123"],
"type": ["xyz789"],
"unit": Unit,
"unused": true,
"valueMap": Map
}
PointFilter
Description
Contains the input values needed to filter point queries.
Fields
| Input Field | Description |
|---|---|
and - [PointFilter]
|
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 - PointFilter
|
Used to omit a specific result or results from the response. |
or - [PointFilter]
|
Used to return results that match at least one of the defined criteria. |
type - StringArrayFilterExpressionInput
|
Used to filter on a class or subclass of the point, like "Alarm" and "TemperatureAlarm". |
unused - SimpleBoolFilterExpressionInput
|
Example
{
"and": [PointFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": PointFilter,
"or": [PointFilter],
"type": StringArrayFilterExpressionInput,
"unused": SimpleBoolFilterExpressionInput
}
PointIdentityUnion
Example
AccessCredentialIdentity
PostalAddressIdentity
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "abc123",
"value": "abc123"
}
PostalAddressIdentityModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| PostalAddressIdentityModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "xyz789",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "xyz789"
}
PostalAddressInput
Example
{
"addressLines": ["xyz789"],
"administrativeArea": "xyz789",
"languageCode": "abc123",
"locality": "abc123",
"organization": "xyz789",
"postalCode": "xyz789",
"recipients": ["abc123"],
"regionCode": "xyz789",
"revision": 123,
"sortingCode": "abc123",
"sublocality": "abc123"
}
PriceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRICE_TYPE_METERED"
ProductBundleResponse
Fields
| Field Name | Description |
|---|---|
archived_at - DateTime
|
|
created_at - DateTime
|
|
description - String
|
|
interval - Interval
|
|
items - [ProductPriceItemResponse]
|
|
metadata - [MetadataEntry]
|
|
plan - String
|
|
productType - ProductType
|
|
sku - String
|
|
slug - String
|
|
state - BundleState
|
|
title - String
|
|
updated_at - DateTime
|
Example
{
"archived_at": "2007-12-03T10:15:30Z",
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"interval": "INTERVAL_CUSTOM",
"items": [ProductPriceItemResponse],
"metadata": [MetadataEntry],
"plan": "abc123",
"productType": "PRODUCT_TYPE_ONE_TIME",
"sku": "abc123",
"slug": "xyz789",
"state": "BUNDLE_STATE_ACTIVE",
"title": "abc123",
"updated_at": "2007-12-03T10:15:30Z"
}
ProductPriceItemResponse
Fields
| Field Name | Description |
|---|---|
lookupKey - String
|
|
metadata - [MetadataEntry]
|
|
oneTimePriceItems - OneTimePriceItems
|
|
priceId - String
|
|
quantityEnabled - Boolean
|
|
quantityRange - QuantityRange
|
|
slug - String
|
|
tiers - [Tier]
|
|
tiersMode - String
|
|
type - PriceType
|
|
unitAmount - Long
|
|
unitAmountDecimal - String
|
Example
{
"lookupKey": "abc123",
"metadata": [MetadataEntry],
"oneTimePriceItems": OneTimePriceItems,
"priceId": "abc123",
"quantityEnabled": true,
"quantityRange": QuantityRange,
"slug": "abc123",
"tiers": [Tier],
"tiersMode": "xyz789",
"type": "PRICE_TYPE_METERED",
"unitAmount": {},
"unitAmountDecimal": "xyz789"
}
ProductType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PRODUCT_TYPE_ONE_TIME"
QuantityRange
RegexMatch
Fields
| Field Name | Description |
|---|---|
location - ValueLocation
|
|
regex - String
|
Example
{
"location": ValueLocation,
"regex": "abc123"
}
RegexMatchInput
Fields
| Input Field | Description |
|---|---|
location - ValueLocationInput
|
|
regex - String
|
Example
{
"location": ValueLocationInput,
"regex": "abc123"
}
RelatesToEdge
RelatesToUnion
Types
| Union Types |
|---|
Example
Building
RentableAreaEdge
Role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADMIN"
RoleInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADMIN"
RoleManagerFilterInput
Fields
| Input Field | Description |
|---|---|
and - [RoleManagerFilterInput]
|
|
description - StringFilterExpressionInput
|
|
isSynced - BoolFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - [RoleManagerFilterInput]
|
|
or - [RoleManagerFilterInput]
|
|
permissions - StringArrayFilterExpressionInput
|
|
roleType - RoleManagerRoleTypeFilterExpressionInput
|
|
state - RoleManagerRoleStateFilterExpressionInput
|
Example
{
"and": [RoleManagerFilterInput],
"description": StringFilterExpressionInput,
"isSynced": BoolFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": [RoleManagerFilterInput],
"or": [RoleManagerFilterInput],
"permissions": StringArrayFilterExpressionInput,
"roleType": RoleManagerRoleTypeFilterExpressionInput,
"state": RoleManagerRoleStateFilterExpressionInput
}
RoleManagerRoleDTO
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime
|
|
description - String
|
|
id - String
|
|
isSynced - Boolean
|
|
metadata - [MetadataRecord]
|
|
name - String
|
|
permissions - [String]
|
|
roleType - RoleManagerRoleType
|
|
state - RoleManagerRoleState
|
|
updatedAt - DateTime
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "xyz789",
"isSynced": true,
"metadata": [MetadataRecord],
"name": "abc123",
"permissions": ["xyz789"],
"roleType": "ROLE_TYPE_COMMON",
"state": "ROLE_STATE_DISABLED",
"updatedAt": "2007-12-03T10:15:30Z"
}
RoleManagerRoleState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ROLE_STATE_DISABLED"
RoleManagerRoleStateFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - RoleManagerRoleStateInput
|
|
in - [RoleManagerRoleStateInput]
|
Example
{"eq": "ROLE_STATE_DISABLED", "in": ["ROLE_STATE_DISABLED"]}
RoleManagerRoleStateInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ROLE_STATE_DISABLED"
RoleManagerRoleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ROLE_TYPE_COMMON"
RoleManagerRoleTypeFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - RoleManagerRoleTypeInput
|
|
in - [RoleManagerRoleTypeInput]
|
Example
{"eq": "ROLE_TYPE_COMMON", "in": ["ROLE_TYPE_COMMON"]}
RoleManagerRoleTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ROLE_TYPE_COMMON"
ScopeKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUILDING"
ServesEdge
ServesUnion
Types
| Union Types |
|---|
Example
Building
ServiceRequest
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
hasAssignee - [Person]
|
|
Arguments
|
|
hasAssigneeEdges - [HasAssigneeEdge]
|
|
id - String!
|
|
identities - [ServiceRequestIdentityUnion]
|
|
isReportedBy - Person
|
|
Arguments
|
|
isReportedByEdges - [IsReportedByEdge]
|
|
isResponsibilityOf - [PeopleGroup]
|
|
Arguments
|
|
isResponsibilityOfEdges - [IsResponsibilityOfEdge]
|
|
jobPriority - String
|
|
mappingKey - String
|
|
name - String
|
|
origin - String
|
|
referenceUrl - String
|
|
relatesTo - [RelatesToUnion]
|
|
Arguments
|
|
relatesToEdges - [RelatesToEdge]
|
|
requestStatus - String
|
|
sector - String
|
|
summary - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "xyz789",
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "xyz789",
"hasAssignee": [Person],
"hasAssigneeEdges": [HasAssigneeEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isReportedBy": Person,
"isReportedByEdges": [IsReportedByEdge],
"isResponsibilityOf": [PeopleGroup],
"isResponsibilityOfEdges": [IsResponsibilityOfEdge],
"jobPriority": "xyz789",
"mappingKey": "abc123",
"name": "xyz789",
"origin": "xyz789",
"referenceUrl": "xyz789",
"relatesTo": [Building],
"relatesToEdges": [RelatesToEdge],
"requestStatus": "xyz789",
"sector": "abc123",
"summary": "abc123",
"type": ["abc123"]
}
ServiceRequestFilter
Fields
| Input Field | Description |
|---|---|
and - [ServiceRequestFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - ServiceRequestFilter
|
|
or - [ServiceRequestFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [ServiceRequestFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": ServiceRequestFilter,
"or": [ServiceRequestFilter],
"type": StringArrayFilterExpressionInput
}
ServiceRequestIdentityUnion
Example
AccessCredentialIdentity
SignatureMatch
Fields
| Field Name | Description |
|---|---|
asymmetricKey - Certificate
|
|
location - ValueLocation
|
|
symmetricKey - String
|
|
type - SignatureType
|
Example
{
"asymmetricKey": Certificate,
"location": ValueLocation,
"symmetricKey": "xyz789",
"type": "ECDSA_SHA1"
}
SignatureMatchInput
Fields
| Input Field | Description |
|---|---|
asymmetricKey - CertificateInput
|
|
location - ValueLocationInput
|
|
symmetricKey - String
|
|
type - SignatureTypeInput
|
Example
{
"asymmetricKey": CertificateInput,
"location": ValueLocationInput,
"symmetricKey": "abc123",
"type": "ECDSA_SHA1"
}
SignatureType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ECDSA_SHA1"
SignatureTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ECDSA_SHA1"
SimpleBoolFilterExpressionInput
Site
Description
Contains the details about a site.
Fields
| Field Name | Description |
|---|---|
buildings - [Building]
|
All the buildings in a site will be listed here. |
Arguments
|
|
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
Any connectors configured for a site will be listed here. |
Arguments
|
|
dateCreated - DateTime
|
This timestamp represents the date the site was created. |
dateUpdated - DateTime
|
This timestamp represents that date the site was last updated. |
description - String
|
The description of a site; often left blank, especially if the site name is already descriptive. |
exactType - String
|
|
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
|
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of the site. |
identities - [SiteIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
|
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
|
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
The name assigned to the site, like the name of a campus containing multiple buildings. |
organization - Org
|
The organization a site belongs to; this field will be restricted by access rights. |
points - [Point]
|
|
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
things - [Thing]
|
All the things associated with a site, or any sublevels of the site (building, floor or space), will show here. |
Arguments
|
|
type - [String]
|
|
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Example
{
"buildings": [Building],
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"name": "abc123",
"organization": Org,
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
SiteCreateRequestInput
Fields
| Input Field | Description |
|---|---|
site - SiteMutationInput
|
Example
{"site": SiteMutationInput}
SiteCreateResponse
Fields
| Field Name | Description |
|---|---|
site - SiteMutation
|
Example
{"site": SiteMutation}
SiteDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
SiteDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
SiteFilter
Description
Contains the input values needed to filter site queries.
Fields
| Input Field | Description |
|---|---|
and - [SiteFilter]
|
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 - SiteFilter
|
Used to omit a specific result or results from the response. |
or - [SiteFilter]
|
Used to return results that match at least one of the defined criteria. |
type - StringArrayFilterExpressionInput
|
Example
{
"and": [SiteFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": SiteFilter,
"or": [SiteFilter],
"type": StringArrayFilterExpressionInput
}
SiteIdentityUnion
Example
AccessCredentialIdentity
SiteMutation
SiteMutationInput
SiteUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
site - SiteMutationInput
|
Example
{"site": SiteMutationInput}
SiteUpdateResponse
Fields
| Field Name | Description |
|---|---|
site - SiteMutation
|
Example
{"site": SiteMutation}
Space
Description
Contains the details about the space.
Fields
| Field Name | Description |
|---|---|
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
Any connectors configured for the space will be listed here. |
Arguments
|
|
dateCreated - DateTime
|
This timestamp represents the date the space was created. |
dateUpdated - DateTime
|
This timestamp represents that date the space was last updated. |
description - String
|
The description of the space; often left blank, especially if the space name is already descriptive. |
exactType - String
|
This is the most specific type available for the space, i.e. where 'type' may return a list like [Place, Space, Room, Office], exactType will return just Office. |
floor - Floor!
|
Contains the details of the floor where the space is present. |
geoshape - GeoJSON
|
The geographic shape of the space, represented by latitude/longitude coordinate pairs. |
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
_ |
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of the space. |
identities - [SpaceIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
_ |
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
_ |
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
|
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
maxOccupancy - Int
|
|
name - String
|
The name assigned to the space, like "breakroom" or "rm101". |
parentSpaceId - String
|
_ |
points - [Point]
|
|
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
things - [Thing]
|
All the things associated with a space will show here. |
Arguments
|
|
type - [String]
|
The class or subclass of a space, like Room and Office. |
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Example
{
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "xyz789",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "abc123",
"floor": Floor,
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "xyz789",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "xyz789",
"maxOccupancy": 123,
"name": "abc123",
"parentSpaceId": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["xyz789"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
SpaceCode
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
SpaceCodeModel
Fields
| Field Name | Description |
|---|---|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
id - String
|
|
scope - ScopeKey
|
|
scopeId - String
|
|
value - String
|
Possible Types
| SpaceCodeModel Types |
|---|
Example
{
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"id": "abc123",
"scope": "BUILDING",
"scopeId": "xyz789",
"value": "abc123"
}
SpaceCreateRequestInput
Fields
| Input Field | Description |
|---|---|
space - SpaceMutationInput
|
Example
{"space": SpaceMutationInput}
SpaceCreateResponse
Fields
| Field Name | Description |
|---|---|
space - SpaceMutation
|
Example
{"space": SpaceMutation}
SpaceDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
SpaceDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
SpaceFilter
Description
Contains the input values needed to filter space queries.
Fields
| Input Field | Description |
|---|---|
and - [SpaceFilter]
|
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 - SpaceFilter
|
Used to omit a specific result or results from the response. |
or - [SpaceFilter]
|
Used to return results that match at least one of the defined criteria. |
type - StringArrayFilterExpressionInput
|
Example
{
"and": [SpaceFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": SpaceFilter,
"or": [SpaceFilter],
"type": StringArrayFilterExpressionInput
}
SpaceIdentityUnion
Example
AccessCredentialIdentity
SpaceMappingEquivalentSpaceSuggestion
Fields
| Field Name | Description |
|---|---|
confidence - Float
|
|
space - SpaceMutation
|
Example
{"confidence": 123.45, "space": SpaceMutation}
SpaceMappingFloorLevelSuggestion
SpaceMappingSpaceCodeSuggestion
SpaceMappingSuggestEquivalentSpacesRequestInput
Fields
| Input Field | Description |
|---|---|
buildingId - String
|
|
spaces - [SpaceMutationInput]
|
Example
{
"buildingId": "abc123",
"spaces": [SpaceMutationInput]
}
SpaceMappingSuggestFloorLevelsRequestInput
Fields
| Input Field | Description |
|---|---|
buildingId - String
|
|
groundFloorLevel - Int
|
|
spaces - [SpaceMutationInput]
|
Example
{
"buildingId": "xyz789",
"groundFloorLevel": 987,
"spaces": [SpaceMutationInput]
}
SpaceMappingSuggestSpaceCodesRequestInput
Fields
| Input Field | Description |
|---|---|
buildingId - String
|
|
spaces - [SpaceMutationInput]
|
Example
{
"buildingId": "xyz789",
"spaces": [SpaceMutationInput]
}
SpaceMappingSuggestedEquivalentSpaces
Fields
| Field Name | Description |
|---|---|
spaces - [SpaceMappingEquivalentSpaceSuggestion]
|
Example
{"spaces": [SpaceMappingEquivalentSpaceSuggestion]}
SpaceMutation
SpaceMutationInput
SpaceUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
space - SpaceMutationInput
|
Example
{"space": SpaceMutationInput}
SpaceUpdateResponse
Fields
| Field Name | Description |
|---|---|
space - SpaceMutation
|
Example
{"space": SpaceMutation}
String
Description
Built-in String
Example
"abc123"
StringArrayFilterExpressionInput
StringArrayUpdateInput
Fields
| Input Field | Description |
|---|---|
granular - GranularInput
|
|
replace - StringArrayValueInput
|
Example
{
"granular": GranularInput,
"replace": StringArrayValueInput
}
StringArrayValueInput
Fields
| Input Field | Description |
|---|---|
values - [String]
|
Example
{"values": ["abc123"]}
StringFilterExpressionInput
SubBuilding
Fields
| Field Name | Description |
|---|---|
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
|
Arguments
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
|
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
|
identities - [SubBuildingIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
|
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
|
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
points - [Point]
|
|
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
things - [Thing]
|
|
Arguments
|
|
type - [String]
|
|
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Example
{
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "xyz789",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "xyz789",
"exactType": "xyz789",
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "abc123",
"name": "xyz789",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
SubBuildingIdentityUnion
Example
AccessCredentialIdentity
SystemTypeFilterExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - SystemTypeKeyInput
|
|
in - [SystemTypeKeyInput]
|
Example
{"eq": "AIR_QUALITY_MONITORING_SYSTEM", "in": ["AIR_QUALITY_MONITORING_SYSTEM"]}
SystemTypeKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AIR_QUALITY_MONITORING_SYSTEM"
SystemTypeKeyInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AIR_QUALITY_MONITORING_SYSTEM"
Thing
Description
Contains the details about a thing.
Fields
| Field Name | Description |
|---|---|
assetTrackingID - String
|
|
connectedDataSourceId - String
|
|
dateCreated - DateTime
|
|
dateInstalled - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
The description of a thing, like Rooftop Air Handler. |
exactType - String
|
This is the most specific type available for a thing, i.e. where 'type' may return a list like [Device, HVAC, Damper], exactType will return just Damper. |
feeds - [FeedsUnion]
|
|
Arguments
|
|
feedsEdges - [FeedsEdge]
|
|
firmwareVersion - String
|
This is primarily a Building Automation System field; when available, it will provide the firmware version for a device. |
geoshape - GeoJSON
|
The geographic shape of a thing, represented by latitude/longitude coordinate pairs. |
hasDeviceModel - DeviceModel
|
|
Arguments
|
|
hasDeviceModelEdges - [HasDeviceModelEdge]
|
|
hasLocation - Place
|
This represents the location of a thing, such as a space name. |
Arguments
|
|
hasLocationEdges - [HasLocationEdge]
|
|
hasPart - [Thing]
|
If a thing has any additional parts, like a VAV with a damper, the damper will be referenced here. |
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
_ |
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
The unique ID of a thing. |
identities - [ThingIdentityUnion]
|
|
isFedBy - [IsFedByUnion]
|
_ |
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isPartOf - [Thing]
|
If a thing is 'a part of' a different device, like a damper that's part of a VAV, the VAV will be referenced here. |
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isResponsibilityOf - [PeopleGroup]
|
|
Arguments
|
|
isResponsibilityOfEdges - [IsResponsibilityOfEdge]
|
|
isVirtual - Boolean
|
|
manufacturedBy - Agent
|
|
Arguments
|
|
manufacturedByEdges - [ManufacturedByEdge]
|
|
mappingKey - String
|
_ |
model - DeviceLibraryModel
|
If available, the model - along with manufacturer information - of a thing will be outlined here. No longer supported. Scheduled for removal on 02/21/2024. Use hasDeviceModel and manufacturedBy query as an alternative. |
name - String
|
The name of a thing, usually abbreviations of the thing's description along with location details and/or BAS information. |
organization - Org
|
The organization a thing belongs to; this field will be restricted by access rights. |
places - [Place]
|
The details of the place(s) where a thing is located, such as a specific building, floor, or space. |
Arguments
|
|
points - [Point]
|
A list of points associated with a thing, such as a temperature setting for a thermostat. Not all things will have points. |
Arguments
|
|
seeAlso - String
|
|
serialNumber - String
|
|
serves - [ServesUnion]
|
|
Arguments
|
|
servesEdges - [ServesEdge]
|
|
type - [String]
|
The class or subclass of a thing, like HVAC and AHU. |
Example
{
"assetTrackingID": "abc123",
"connectedDataSourceId": "abc123",
"dateCreated": "2007-12-03T10:15:30Z",
"dateInstalled": "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": [Collection],
"isFedByEdges": [IsFedByEdge],
"isPartOf": [Thing],
"isPartOfEdges": [IsPartOfEdge],
"isResponsibilityOf": [PeopleGroup],
"isResponsibilityOfEdges": [IsResponsibilityOfEdge],
"isVirtual": false,
"manufacturedBy": Agent,
"manufacturedByEdges": [ManufacturedByEdge],
"mappingKey": "xyz789",
"model": DeviceLibraryModel,
"name": "xyz789",
"organization": Org,
"places": [Place],
"points": [Point],
"seeAlso": "abc123",
"serialNumber": "xyz789",
"serves": [Building],
"servesEdges": [ServesEdge],
"type": ["abc123"]
}
ThingContainer
Fields
| Field Name | Description |
|---|---|
things - [Thing]
|
|
Arguments
|
|
Possible Types
| ThingContainer Types |
|---|
Example
{"things": [Thing]}
ThingFilter
Description
Contains the input values needed to filter thing queries.
Fields
| Input Field | Description |
|---|---|
and - [ThingFilter]
|
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). |
isVirtual - SimpleBoolFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - ThingFilter
|
Used to omit a specific result or results from the response. |
or - [ThingFilter]
|
Used to return results that match at least one of the defined criteria. |
type - StringArrayFilterExpressionInput
|
Used to filter on a specific class or subclass of a thing, like HVAC and AHU. |
Example
{
"and": [ThingFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"isVirtual": SimpleBoolFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": ThingFilter,
"or": [ThingFilter],
"type": StringArrayFilterExpressionInput
}
ThingIdentityUnion
Example
AccessCredentialIdentity
Tier
TimeseriesAggPeriodInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AGG_PERIOD_UNSPECIFIED"
TimeseriesAggregateRow
TimeseriesNumericalException
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INFINITY"
TimeseriesRow
Fields
| Field Name | Description |
|---|---|
ingestionTime - DateTime
|
|
timestamp - DateTime
|
|
value - TimeseriesRowValue
|
Example
{
"ingestionTime": "2007-12-03T10:15:30Z",
"timestamp": "2007-12-03T10:15:30Z",
"value": TimeseriesRowValue
}
TimeseriesRowValue
Example
{
"boolValue": true,
"byteArrayValue": "abc123",
"float32Value": 987.65,
"float64Value": 123.45,
"geopointValue": GeoPoint,
"int32Value": 123,
"int64Value": {},
"json": JSONLD,
"numericalException": "INFINITY",
"stringValue": "abc123",
"uint32Value": 987,
"uint64Value": {}
}
TimestampFilterExpressionInput
Unit
Description
Contains the details about a unit of measurement for point data.
Example
{
"description": "xyz789",
"id": "xyz789",
"name": "xyz789"
}
UnitFilterInput
Description
Contains the input values needed to filter unit queries.
Fields
| Input Field | Description |
|---|---|
id - IDFilterExpressionInput
|
Used to filter for a specific ID or IDs (refer to IDFilterExpressionInput for input options). |
Example
{"id": IDFilterExpressionInput}
UsableAreaEdge
User
Description
Contains the details about a user.
Fields
| Field Name | Description |
|---|---|
created - DateTime
|
The timestamp of the user creation. |
email - String
|
The user's email. |
emailVerified - Boolean
|
True or False, whether the user has verified their email yet. |
id - String
|
The unique ID of the user. |
lastLogin - DateTime
|
|
loginsCount - Long
|
|
name - String
|
The name of a user - this will be the full name, first and last. |
nickname - String
|
The user's nickname (often just the first name of the user). No longer supported |
orgRoles - [String]
|
|
organization - Org
|
The details for the user's organization. |
roles - [Role]
|
Lists the user's roles, such as ADMIN or EXPLORER. |
tokens - [PersonalAccessToken]
|
Lists the tokens for the user - will not return the actual PAT, but will show name, permissions/scopes, when the token was last used. |
Arguments
|
|
updated - DateTime
|
Timestamp when one or more user details were last updated. |
Example
{
"created": "2007-12-03T10:15:30Z",
"email": "abc123",
"emailVerified": true,
"id": "abc123",
"lastLogin": "2007-12-03T10:15:30Z",
"loginsCount": {},
"name": "xyz789",
"nickname": "abc123",
"orgRoles": ["xyz789"],
"organization": Org,
"roles": ["ADMIN"],
"tokens": [PersonalAccessToken],
"updated": "2007-12-03T10:15:30Z"
}
UserAssignRoleRequestInput
UserAssignRoleResponse
Fields
| Field Name | Description |
|---|---|
user - User
|
Example
{"user": User}
UserCreateRequestInput
Description
Contains the input values needed to create a new user.
Fields
| Input Field | Description |
|---|---|
skipInviteEmail - Boolean
|
Accepts 'true' or 'false' - when set to true, the user will not receive the invite email, which is best practice if you intend to verify their email programmatically in the 'user' field. |
temporaryPassword - String
|
Define a temporary password for the user; once they log in with the temp password, they will be prompted to change it. |
user - UserInput
|
Contains the input values for the user details, such as name, email and role. |
Example
{
"skipInviteEmail": true,
"temporaryPassword": "abc123",
"user": UserInput
}
UserCreateResponse
Fields
| Field Name | Description |
|---|---|
user - User
|
Example
{"user": User}
UserFilterInput
Description
Contains the input values needed to filter user queries.
Fields
| Input Field | Description |
|---|---|
email - StringFilterExpressionInput
|
Used to filter on the user's email, either an exact match, in a defined set or by a partial match. |
name - StringFilterExpressionInput
|
Search by the user's name, either an exact match, in a defined set or by a partial match. |
userId - IDFilterExpressionInput
|
Used to filter for a specific ID or IDs (refer to IDFilterExpressionInput for input options). |
Example
{
"email": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"userId": IDFilterExpressionInput
}
UserInput
Description
Contains the details about a user.
Fields
| Input Field | Description |
|---|---|
created - DateTime
|
The timestamp of the user creation. |
email - String
|
The user's email. |
emailVerified - Boolean
|
True or False, whether the user has verified their email yet. |
id - String
|
The unique ID of the user. |
lastLogin - DateTime
|
|
loginsCount - Long
|
|
name - String
|
The name of a user - this will be the full name, first and last. |
orgRoles - [String]
|
|
roles - [RoleInput]
|
Lists the user's roles, such as ADMIN or EXPLORER. |
updated - DateTime
|
Timestamp when one or more user details were last updated. |
Example
{
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"emailVerified": true,
"id": "xyz789",
"lastLogin": "2007-12-03T10:15:30Z",
"loginsCount": {},
"name": "xyz789",
"orgRoles": ["abc123"],
"roles": ["ADMIN"],
"updated": "2007-12-03T10:15:30Z"
}
UserOrgDetail
UserRemoveOrgMembershipRequestInput
UserRemoveOrgMembershipResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
UserRemoveRoleRequestInput
UserRemoveRoleResponse
Fields
| Field Name | Description |
|---|---|
user - User
|
Example
{"user": User}
UserUpdateRequestInput
Description
Contains the input values needed to update a user.
Fields
| Input Field | Description |
|---|---|
user - UserInput
|
Contains the input values for the user details, such as name, email and role. |
Example
{"user": UserInput}
UserUpdateResponse
Fields
| Field Name | Description |
|---|---|
user - User
|
Example
{"user": User}
ValueLocation
Fields
| Field Name | Description |
|---|---|
encoding - EncodingType
|
|
form - BodyValueLocation
|
|
header - String
|
|
json - BodyValueLocation
|
|
mappedDefault - Boolean
|
|
queryParameter - String
|
Example
{
"encoding": "BASE64",
"form": BodyValueLocation,
"header": "abc123",
"json": BodyValueLocation,
"mappedDefault": false,
"queryParameter": "xyz789"
}
ValueLocationInput
Fields
| Input Field | Description |
|---|---|
encoding - EncodingTypeInput
|
|
form - BodyValueLocationInput
|
|
header - String
|
|
json - BodyValueLocationInput
|
|
mappedDefault - Boolean
|
|
queryParameter - String
|
Example
{
"encoding": "BASE64",
"form": BodyValueLocationInput,
"header": "abc123",
"json": BodyValueLocationInput,
"mappedDefault": true,
"queryParameter": "xyz789"
}
ValueMatch
Fields
| Field Name | Description |
|---|---|
location - ValueLocation
|
|
value - String
|
Example
{
"location": ValueLocation,
"value": "xyz789"
}
ValueMatchInput
Fields
| Input Field | Description |
|---|---|
location - ValueLocationInput
|
|
value - String
|
Example
{
"location": ValueLocationInput,
"value": "xyz789"
}
WebhookReceiver
Fields
| Field Name | Description |
|---|---|
auth - Auth
|
|
baseUri - String
|
|
corsOptions - WebhookReceiverCORSOptions
|
|
created - DateTime
|
|
destination - WebhookReceiverDestination
|
|
id - String
|
|
incomingPayloadContentType - String
|
|
metadata - [MetadataRecord]
|
|
methods - [HTTPMethod]
|
|
name - String
|
|
ownerId - String
|
|
responseHeaders - [WebhookReceiverResponseHeadersEntry]
|
|
responseMessage - String
|
|
responseReflectedQueryParameter - String
|
|
runId - String
|
|
signalName - String
|
|
sourceId - String
|
|
successHttpResponseCode - Int
|
|
updated - DateTime
|
|
workflowId - String
|
Example
{
"auth": Auth,
"baseUri": "xyz789",
"corsOptions": WebhookReceiverCORSOptions,
"created": "2007-12-03T10:15:30Z",
"destination": WebhookReceiverDestination,
"id": "abc123",
"incomingPayloadContentType": "abc123",
"metadata": [MetadataRecord],
"methods": ["CONNECT"],
"name": "abc123",
"ownerId": "abc123",
"responseHeaders": [
WebhookReceiverResponseHeadersEntry
],
"responseMessage": "xyz789",
"responseReflectedQueryParameter": "abc123",
"runId": "xyz789",
"signalName": "abc123",
"sourceId": "abc123",
"successHttpResponseCode": 987,
"updated": "2007-12-03T10:15:30Z",
"workflowId": "abc123"
}
WebhookReceiverCORSOptions
Example
{
"allowCredentials": false,
"allowedHeaders": ["abc123"],
"allowedMethods": ["CONNECT"],
"allowedOrigins": ["xyz789"],
"exposedHeaders": ["xyz789"],
"maxAge": 123
}
WebhookReceiverCORSOptionsInput
Example
{
"allowCredentials": true,
"allowedHeaders": ["xyz789"],
"allowedMethods": ["CONNECT"],
"allowedOrigins": ["xyz789"],
"exposedHeaders": ["abc123"],
"maxAge": 123
}
WebhookReceiverCentrifugoDestination
Fields
| Field Name | Description |
|---|---|
channel - String
|
Example
{"channel": "xyz789"}
WebhookReceiverCentrifugoDestinationInput
Fields
| Input Field | Description |
|---|---|
channel - String
|
Example
{"channel": "xyz789"}
WebhookReceiverDeleteRequestInput
WebhookReceiverDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "abc123"}
WebhookReceiverDestination
Fields
| Field Name | Description |
|---|---|
centrifugoDestination - WebhookReceiverCentrifugoDestination
|
|
executeWorkflowDestination - WebhookReceiverTemporalExecuteWorkflowDestination
|
|
kafkaDestination - WebhookReceiverKafkaDestination
|
|
signalWorkflowDestination - WebhookReceiverTemporalSignalWorkfowDestination
|
Example
{
"centrifugoDestination": WebhookReceiverCentrifugoDestination,
"executeWorkflowDestination": WebhookReceiverTemporalExecuteWorkflowDestination,
"kafkaDestination": WebhookReceiverKafkaDestination,
"signalWorkflowDestination": WebhookReceiverTemporalSignalWorkfowDestination
}
WebhookReceiverDestinationInput
Fields
| Input Field | Description |
|---|---|
centrifugoDestination - WebhookReceiverCentrifugoDestinationInput
|
|
executeWorkflowDestination - WebhookReceiverTemporalExecuteWorkflowDestinationInput
|
|
kafkaDestination - WebhookReceiverKafkaDestinationInput
|
|
signalWorkflowDestination - WebhookReceiverTemporalSignalWorkfowDestinationInput
|
Example
{
"centrifugoDestination": WebhookReceiverCentrifugoDestinationInput,
"executeWorkflowDestination": WebhookReceiverTemporalExecuteWorkflowDestinationInput,
"kafkaDestination": WebhookReceiverKafkaDestinationInput,
"signalWorkflowDestination": WebhookReceiverTemporalSignalWorkfowDestinationInput
}
WebhookReceiverInput
Fields
| Input Field | Description |
|---|---|
auth - AuthInput
|
|
baseUri - String
|
|
corsOptions - WebhookReceiverCORSOptionsInput
|
|
created - DateTime
|
|
destination - WebhookReceiverDestinationInput
|
|
id - String
|
|
incomingPayloadContentType - String
|
|
metadata - [MetadataRecordInput]
|
|
methods - [HTTPMethodInput]
|
|
name - String
|
|
ownerId - String
|
|
responseHeaders - [WebhookReceiverResponseHeadersEntryInput]
|
|
responseMessage - String
|
|
responseReflectedQueryParameter - String
|
|
runId - String
|
|
signalName - String
|
|
sourceId - String
|
|
successHttpResponseCode - Int
|
|
updated - DateTime
|
|
workflowId - String
|
Example
{
"auth": AuthInput,
"baseUri": "xyz789",
"corsOptions": WebhookReceiverCORSOptionsInput,
"created": "2007-12-03T10:15:30Z",
"destination": WebhookReceiverDestinationInput,
"id": "abc123",
"incomingPayloadContentType": "abc123",
"metadata": [MetadataRecordInput],
"methods": ["CONNECT"],
"name": "xyz789",
"ownerId": "abc123",
"responseHeaders": [
WebhookReceiverResponseHeadersEntryInput
],
"responseMessage": "abc123",
"responseReflectedQueryParameter": "abc123",
"runId": "xyz789",
"signalName": "xyz789",
"sourceId": "xyz789",
"successHttpResponseCode": 123,
"updated": "2007-12-03T10:15:30Z",
"workflowId": "xyz789"
}
WebhookReceiverKafkaDestination
WebhookReceiverKafkaDestinationInput
WebhookReceiverResponseHeadersEntry
WebhookReceiverResponseHeadersEntryInput
WebhookReceiverTemporalExecuteWorkflowDestination
WebhookReceiverTemporalExecuteWorkflowDestinationInput
WebhookReceiverTemporalSignalWorkfowDestination
WebhookReceiverTemporalSignalWorkfowDestinationInput
WebhookReceiverUpsertRequestInput
Fields
| Input Field | Description |
|---|---|
receiver - WebhookReceiverInput
|
Example
{"receiver": WebhookReceiverInput}
WebhookReceiverUpsertResponse
Fields
| Field Name | Description |
|---|---|
receiver - WebhookReceiver
|
Example
{"receiver": WebhookReceiver}
WebhookTarget
Description
Contains the input values needed to create a webhook target.
Fields
| Field Name | Description |
|---|---|
batchedContentModeConfig - WebhookTargetCloudEventBatchedContentModeConfig
|
|
contentMode - WebhookTargetCloudEventContentMode
|
|
enabled - Boolean
|
True/False Boolean field used to enable or disable a webhook. |
eventExtensions - GraphQLJSON
|
|
eventFilters - WebhookTargetEventFilter
|
Fields for eventFilters define what you data you want the webhook to send to your endpoint. |
httpTarget - WebhookTargetHTTPTarget
|
Fields for httpTarget define the details of the endpoint where data will be sent. |
id - String
|
The unique ID of the webhook. |
maxRetry - Long
|
This defines how many times we will attempt to send a webhook payload before giving up if we don't get a 200 OK response. |
metadata - [WebhookTargetMetadataEntry]
|
|
name - String
|
This is the unique name of the webhook; this should include details about the data being sent, to differentiate it from other webhooks. |
organization - Org
|
The organization the webhook belongs to; this is automatically defined by the user creating the webhook. |
user - User
|
The details of the user creating the webhook; this is also automatically defined during the webhook creation. |
Example
{
"batchedContentModeConfig": WebhookTargetCloudEventBatchedContentModeConfig,
"contentMode": "BATCHED",
"enabled": true,
"eventExtensions": GraphQLJSON,
"eventFilters": WebhookTargetEventFilter,
"httpTarget": WebhookTargetHTTPTarget,
"id": "abc123",
"maxRetry": {},
"metadata": [WebhookTargetMetadataEntry],
"name": "abc123",
"organization": Org,
"user": User
}
WebhookTargetAuth
Fields
| Field Name | Description |
|---|---|
apiKey - APIKey
|
|
basicAuth - BasicAuth
|
|
noAuth - Boolean
|
|
oauth2ClientCredentialsFlow - OAuth2ClientCredentialsFlow
|
Example
{
"apiKey": APIKey,
"basicAuth": BasicAuth,
"noAuth": false,
"oauth2ClientCredentialsFlow": OAuth2ClientCredentialsFlow
}
WebhookTargetAuthInput
Fields
| Input Field | Description |
|---|---|
apiKey - APIKeyInput
|
|
basicAuth - BasicAuthInput
|
|
noAuth - Boolean
|
|
oauth2ClientCredentialsFlow - OAuth2ClientCredentialsFlowInput
|
Example
{
"apiKey": APIKeyInput,
"basicAuth": BasicAuthInput,
"noAuth": true,
"oauth2ClientCredentialsFlow": OAuth2ClientCredentialsFlowInput
}
WebhookTargetCloudEventBatchedContentModeConfig
WebhookTargetCloudEventBatchedContentModeConfigInput
Fields
| Input Field | Description |
|---|---|
gracePeriod - DurationInput
|
|
maxDelay - DurationInput
|
|
maxSize - Long
|
Example
{
"gracePeriod": DurationInput,
"maxDelay": DurationInput,
"maxSize": {}
}
WebhookTargetCloudEventContentMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BATCHED"
WebhookTargetCloudEventContentModeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BATCHED"
WebhookTargetCloudEventContentModeWrapperInput
Fields
| Input Field | Description |
|---|---|
value - WebhookTargetCloudEventContentModeInput
|
Example
{"value": "BATCHED"}
WebhookTargetCloudEventFilter
Fields
| Field Name | Description |
|---|---|
and - [WebhookTargetCloudEventFilter]
|
|
not - [WebhookTargetCloudEventFilter]
|
|
or - [WebhookTargetCloudEventFilter]
|
|
sources - [String]
|
|
types - [CloudEventSourceType]
|
Example
{
"and": [WebhookTargetCloudEventFilter],
"not": [WebhookTargetCloudEventFilter],
"or": [WebhookTargetCloudEventFilter],
"sources": ["abc123"],
"types": ["CLOUDEVENTSOURCETYPE_UNSPECIFIED"]
}
WebhookTargetCloudEventFilterInput
Fields
| Input Field | Description |
|---|---|
and - [WebhookTargetCloudEventFilterInput]
|
|
not - [WebhookTargetCloudEventFilterInput]
|
|
or - [WebhookTargetCloudEventFilterInput]
|
|
sources - [String]
|
|
types - [CloudEventSourceTypeInput]
|
Example
{
"and": [WebhookTargetCloudEventFilterInput],
"not": [WebhookTargetCloudEventFilterInput],
"or": [WebhookTargetCloudEventFilterInput],
"sources": ["abc123"],
"types": ["CLOUDEVENTSOURCETYPE_UNSPECIFIED"]
}
WebhookTargetCreateInput
Fields
| Input Field | Description |
|---|---|
batchedContentModeConfig - WebhookTargetCloudEventBatchedContentModeConfigInput
|
|
contentMode - WebhookTargetCloudEventContentModeInput
|
|
enabled - Boolean
|
|
eventExtensions - GraphQLJSON
|
|
eventFilters - WebhookTargetEventFilterInput
|
|
httpTarget - WebhookTargetHTTPTargetInput
|
|
maxRetry - Long
|
|
name - String
|
Example
{
"batchedContentModeConfig": WebhookTargetCloudEventBatchedContentModeConfigInput,
"contentMode": "BATCHED",
"enabled": false,
"eventExtensions": GraphQLJSON,
"eventFilters": WebhookTargetEventFilterInput,
"httpTarget": WebhookTargetHTTPTargetInput,
"maxRetry": {},
"name": "abc123"
}
WebhookTargetCreateRequestInput
Fields
| Input Field | Description |
|---|---|
target - WebhookTargetCreateInput
|
Example
{"target": WebhookTargetCreateInput}
WebhookTargetCreateResponse
Fields
| Field Name | Description |
|---|---|
target - WebhookTarget
|
Example
{"target": WebhookTarget}
WebhookTargetDeleteRequestInput
Fields
| Input Field | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
WebhookTargetDeleteResponse
Fields
| Field Name | Description |
|---|---|
_ - String
|
Example
{"_": "xyz789"}
WebhookTargetEnableRequestInput
WebhookTargetEnableResponse
WebhookTargetEventFilter
Fields
| Field Name | Description |
|---|---|
cloudEventFilter - WebhookTargetCloudEventFilter
|
Currently in development. |
jsonExpressionFilter - WebhookTargetJsonExpressionFilter
|
Input the JSON Expression for the filter input you want here. |
timeseriesFilter - WebhookTargetTimeseriesFilter
|
Currently in development. |
Example
{
"cloudEventFilter": WebhookTargetCloudEventFilter,
"jsonExpressionFilter": WebhookTargetJsonExpressionFilter,
"timeseriesFilter": WebhookTargetTimeseriesFilter
}
WebhookTargetEventFilterInput
Fields
| Input Field | Description |
|---|---|
cloudEventFilter - WebhookTargetCloudEventFilterInput
|
Currently in development. |
jsonExpressionFilter - WebhookTargetJsonExpressionFilterInput
|
Input the JSON Expression for the filter input you want here. |
timeseriesFilter - WebhookTargetTimeseriesFilterInput
|
Currently in development. |
Example
{
"cloudEventFilter": WebhookTargetCloudEventFilterInput,
"jsonExpressionFilter": WebhookTargetJsonExpressionFilterInput,
"timeseriesFilter": WebhookTargetTimeseriesFilterInput
}
WebhookTargetEventFilterTypeExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - WebhookTargetEventFilterTypeInput
|
|
in - [WebhookTargetEventFilterTypeInput]
|
Example
{"eq": "CLOUDEVENT", "in": ["CLOUDEVENT"]}
WebhookTargetEventFilterTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOUDEVENT"
WebhookTargetFilterInput
Fields
| Input Field | Description |
|---|---|
and - [WebhookTargetFilterInput]
|
|
contentMode - WebhookTargetCloudEventContentModeInput
|
|
enabled - BoolFilterExpressionInput
|
|
eventFilterType - WebhookTargetEventFilterTypeExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - [WebhookTargetFilterInput]
|
|
or - [WebhookTargetFilterInput]
|
|
targetId - IDFilterExpressionInput
|
|
targetType - WebhookTargetTargetTypeExpressionInput
|
|
userId - IDFilterExpressionInput
|
Example
{
"and": [WebhookTargetFilterInput],
"contentMode": "BATCHED",
"enabled": BoolFilterExpressionInput,
"eventFilterType": WebhookTargetEventFilterTypeExpressionInput,
"name": StringFilterExpressionInput,
"not": [WebhookTargetFilterInput],
"or": [WebhookTargetFilterInput],
"targetId": IDFilterExpressionInput,
"targetType": WebhookTargetTargetTypeExpressionInput,
"userId": IDFilterExpressionInput
}
WebhookTargetHTTPTarget
Fields
| Field Name | Description |
|---|---|
auth - WebhookTargetAuth
|
|
hmac256 - HMAC256
|
|
method - HTTPMethod
|
|
targetUri - String
|
Example
{
"auth": WebhookTargetAuth,
"hmac256": HMAC256,
"method": "CONNECT",
"targetUri": "xyz789"
}
WebhookTargetHTTPTargetGranularInput
Fields
| Input Field | Description |
|---|---|
auth - WebhookTargetAuthInput
|
|
hmac256 - StringArrayUpdateInput
|
|
method - HTTPMethodWrapperInput
|
|
targetUri - String
|
Example
{
"auth": WebhookTargetAuthInput,
"hmac256": StringArrayUpdateInput,
"method": HTTPMethodWrapperInput,
"targetUri": "xyz789"
}
WebhookTargetHTTPTargetInput
Fields
| Input Field | Description |
|---|---|
auth - WebhookTargetAuthInput
|
|
hmac256 - HMAC256Input
|
|
method - HTTPMethodInput
|
|
targetUri - String
|
Example
{
"auth": WebhookTargetAuthInput,
"hmac256": HMAC256Input,
"method": "CONNECT",
"targetUri": "abc123"
}
WebhookTargetHTTPTargetUpdateInput
Fields
| Input Field | Description |
|---|---|
granular - WebhookTargetHTTPTargetGranularInput
|
|
replace - WebhookTargetHTTPTargetInput
|
Example
{
"granular": WebhookTargetHTTPTargetGranularInput,
"replace": WebhookTargetHTTPTargetInput
}
WebhookTargetJsonExpressionFilter
Fields
| Field Name | Description |
|---|---|
jsonPathExpression - String
|
Example
{"jsonPathExpression": "abc123"}
WebhookTargetJsonExpressionFilterInput
Fields
| Input Field | Description |
|---|---|
jsonPathExpression - String
|
Example
{"jsonPathExpression": "xyz789"}
WebhookTargetMetadataEntry
WebhookTargetTargetTypeExpressionInput
Fields
| Input Field | Description |
|---|---|
eq - WebhookTargetTargetTypeInput
|
|
in - [WebhookTargetTargetTypeInput]
|
Example
{"eq": "HTTP", "in": ["HTTP"]}
WebhookTargetTargetTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HTTP"
WebhookTargetTimeseriesFilter
Fields
| Field Name | Description |
|---|---|
points - [String]
|
Example
{"points": ["xyz789"]}
WebhookTargetTimeseriesFilterInput
Fields
| Input Field | Description |
|---|---|
points - [String]
|
Example
{"points": ["abc123"]}
WebhookTargetUpdateInput
Fields
| Input Field | Description |
|---|---|
batchedContentModeConfig - WebhookTargetCloudEventBatchedContentModeConfigInput
|
|
contentMode - WebhookTargetCloudEventContentModeWrapperInput
|
|
enabled - Boolean
|
|
eventExtensions - GraphQLJSON
|
|
eventFilters - WebhookTargetEventFilterInput
|
|
httpTarget - WebhookTargetHTTPTargetUpdateInput
|
|
id - String
|
|
maxRetry - Long
|
|
metadata - MetadataUpdateInput
|
|
name - String
|
Example
{
"batchedContentModeConfig": WebhookTargetCloudEventBatchedContentModeConfigInput,
"contentMode": WebhookTargetCloudEventContentModeWrapperInput,
"enabled": false,
"eventExtensions": GraphQLJSON,
"eventFilters": WebhookTargetEventFilterInput,
"httpTarget": WebhookTargetHTTPTargetUpdateInput,
"id": "xyz789",
"maxRetry": {},
"metadata": MetadataUpdateInput,
"name": "xyz789"
}
WebhookTargetUpdateRequestInput
Fields
| Input Field | Description |
|---|---|
target - WebhookTargetUpdateInput
|
Example
{"target": WebhookTargetUpdateInput}
WebhookTargetUpdateResponse
Fields
| Field Name | Description |
|---|---|
target - WebhookTarget
|
Example
{"target": WebhookTarget}
WorkOrder
Fields
| Field Name | Description |
|---|---|
connectedDataSourceId - String
|
|
dateClosed - DateTime
|
|
dateCompleted - DateTime
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
dueDate - DateTime
|
|
exactType - String
|
|
externalDateCreated - DateTime
|
|
externalDateUpdated - DateTime
|
|
hasAssignedGroup - PeopleGroup
|
|
Arguments
|
|
hasAssignedGroupEdges - [HasAssignedGroupEdge]
|
|
hasAssignee - [Person]
|
|
Arguments
|
|
hasAssigneeEdges - [HasAssigneeEdge]
|
|
id - String!
|
|
identities - [WorkOrderIdentityUnion]
|
|
isClosedBy - Person
|
|
Arguments
|
|
isClosedByEdges - [IsClosedByEdge]
|
|
isCreatedBy - Person
|
|
Arguments
|
|
isCreatedByEdges - [IsCreatedByEdge]
|
|
isReportedBy - Person
|
|
Arguments
|
|
isReportedByEdges - [IsReportedByEdge]
|
|
jobPriority - String
|
|
jobStatus - String
|
|
jobSubStatus - String
|
|
jobType - String
|
|
mappingKey - String
|
|
name - String
|
|
problemDescription - String
|
|
referenceUrl - String
|
|
relatesTo - [RelatesToUnion]
|
|
Arguments
|
|
relatesToEdges - [RelatesToEdge]
|
|
resolutionDescription - String
|
|
sector - String
|
|
subject - String
|
|
summary - String
|
|
type - [String]
|
|
Example
{
"connectedDataSourceId": "abc123",
"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": "xyz789",
"jobSubStatus": "xyz789",
"jobType": "abc123",
"mappingKey": "abc123",
"name": "abc123",
"problemDescription": "xyz789",
"referenceUrl": "xyz789",
"relatesTo": [Building],
"relatesToEdges": [RelatesToEdge],
"resolutionDescription": "xyz789",
"sector": "abc123",
"subject": "abc123",
"summary": "abc123",
"type": ["xyz789"]
}
WorkOrderFilter
Fields
| Input Field | Description |
|---|---|
and - [WorkOrderFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - WorkOrderFilter
|
|
or - [WorkOrderFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [WorkOrderFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": WorkOrderFilter,
"or": [WorkOrderFilter],
"type": StringArrayFilterExpressionInput
}
WorkOrderIdentityUnion
Example
AccessCredentialIdentity
Zone
Fields
| Field Name | Description |
|---|---|
calendarEvents - [CalendarEvent]
|
|
Arguments
|
|
collections - [Collection]
|
|
Arguments
|
|
connectedDataSourceId - String
|
|
connectors - [Connector]
|
|
Arguments
|
|
dateCreated - DateTime
|
|
dateUpdated - DateTime
|
|
description - String
|
|
exactType - String
|
|
geoshape - GeoJSON
|
|
grossArea - AreaQuantity
|
|
Arguments
|
|
grossAreaEdges - [GrossAreaEdge]
|
|
hasPart - [Place]
|
|
Arguments
|
|
hasPartEdges - [HasPartEdge]
|
|
hasPoint - [Point]
|
|
Arguments
|
|
hasPointEdges - [HasPointEdge]
|
|
id - String!
|
|
identities - [ZoneIdentityUnion]
|
|
isAdjacentTo - [Place]
|
|
Arguments
|
|
isAdjacentToEdges - [IsAdjacentToEdge]
|
|
isFedBy - [Thing]
|
|
Arguments
|
|
isFedByEdges - [IsFedByEdge]
|
|
isLocationOf - [IsLocationOfUnion]
|
|
Arguments
|
|
isLocationOfEdges - [IsLocationOfEdge]
|
|
isPartOf - [Place]
|
|
Arguments
|
|
isPartOfEdges - [IsPartOfEdge]
|
|
isServedBy - [Thing]
|
|
Arguments
|
|
isServedByEdges - [IsServedByEdge]
|
|
mappingKey - String
|
|
name - String
|
|
points - [Point]
|
|
Arguments
|
|
rentableArea - AreaQuantity
|
|
Arguments
|
|
rentableAreaEdges - [RentableAreaEdge]
|
|
things - [Thing]
|
|
Arguments
|
|
type - [String]
|
|
usableArea - AreaQuantity
|
|
Arguments
|
|
usableAreaEdges - [UsableAreaEdge]
|
|
Example
{
"calendarEvents": [CalendarEvent],
"collections": [Collection],
"connectedDataSourceId": "abc123",
"connectors": [Connector],
"dateCreated": "2007-12-03T10:15:30Z",
"dateUpdated": "2007-12-03T10:15:30Z",
"description": "abc123",
"exactType": "xyz789",
"geoshape": GeoJSON,
"grossArea": AreaQuantity,
"grossAreaEdges": [GrossAreaEdge],
"hasPart": [Place],
"hasPartEdges": [HasPartEdge],
"hasPoint": [Point],
"hasPointEdges": [HasPointEdge],
"id": "abc123",
"identities": [AccessCredentialIdentity],
"isAdjacentTo": [Place],
"isAdjacentToEdges": [IsAdjacentToEdge],
"isFedBy": [Thing],
"isFedByEdges": [IsFedByEdge],
"isLocationOf": [Collection],
"isLocationOfEdges": [IsLocationOfEdge],
"isPartOf": [Place],
"isPartOfEdges": [IsPartOfEdge],
"isServedBy": [Thing],
"isServedByEdges": [IsServedByEdge],
"mappingKey": "abc123",
"name": "abc123",
"points": [Point],
"rentableArea": AreaQuantity,
"rentableAreaEdges": [RentableAreaEdge],
"things": [Thing],
"type": ["abc123"],
"usableArea": AreaQuantity,
"usableAreaEdges": [UsableAreaEdge]
}
ZoneFilter
Fields
| Input Field | Description |
|---|---|
and - [ZoneFilter]
|
|
connectedDataSourceId - StringFilterExpressionInput
|
|
dateCreated - TimestampFilterExpressionInput
|
|
dateUpdated - TimestampFilterExpressionInput
|
|
exactType - StringFilterExpressionInput
|
|
id - IDFilterExpressionInput
|
|
mappingKey - StringFilterExpressionInput
|
|
name - StringFilterExpressionInput
|
|
not - ZoneFilter
|
|
or - [ZoneFilter]
|
|
type - StringArrayFilterExpressionInput
|
Example
{
"and": [ZoneFilter],
"connectedDataSourceId": StringFilterExpressionInput,
"dateCreated": TimestampFilterExpressionInput,
"dateUpdated": TimestampFilterExpressionInput,
"exactType": StringFilterExpressionInput,
"id": IDFilterExpressionInput,
"mappingKey": StringFilterExpressionInput,
"name": StringFilterExpressionInput,
"not": ZoneFilter,
"or": [ZoneFilter],
"type": StringArrayFilterExpressionInput
}
ZoneIdentityUnion
Example
AccessCredentialIdentity