Abra GraphQL APIs
/Other
/- commandRevert
areaCreate
areaDelete
areaUpdate
areaAddHub
areaRemoveHub
cloudConnectionDisconnect
cloudConnectionElhubConnect
hubSetGatewayConnected
hubSetNetworkSsid
hubSetNetworkCredentials
invokeHubCommand
hubSetArmed
hubProvisioning
hubProvisioningQrGeneration
hubProvisioningRegistryUpdate
hubProvisioningAcceptance
hubProvisioningDecomission
hubProvisioningManufacturingUpdate
homeCreate
homeWithoutOwnerCreate
homeDelete
homeUpdate
homeSetInsuranceInfo
homeMemberAcceptInvitation
homeMemberRejectInvitation
homeMemberRevokeInvitation
homeMemberUpdateInvitation
homeMemberInvite
homeMemberInvitationSend
homeMemberUpdate
homeMemberUpdateRole
homeMemberDelete
hubUnregister
hubRegister
hubUpdateName
hubResolveWaterGuardTamperMode
hubResolveWaterGuardTamperWarningNotification
userMyAccountUpdate
userMyAccountUpdateLocale
userMyAccountVerifyEmail
userMyAccountResendPostRegistrationPasswordResetEmail
userInvite
userAcceptInvitation
userAccountSetRole
userDelete
commandUpdateNotification
updateNotificationCommand
hubUpdatedNotification
userMyAccountVerifyEmailNotification
userMyAccountAvatarUpdateNotification
updateNotificationUserSubscription
homeAvatarUpdateNotification
updateNotificationProject
updateNotification
updateNotificationInvitation
updateNotificationHomeMember
updateNotificationCloudConnection
updateNotificationFreezeProtection
updateNotificationRoutine
updateNotificationSmartEnergy
updateNotificationDemandResponse
updateNotificationAccount
areaSetActionAccessPolicyForUser
installerCreateProject
installerUpdateProject
installerProjectUpdateStatus
claimHome
installerDeleteProject
installerCreateHome
installerOrganizationAddInstaller
installerOrganizationRemoveInstaller
installerCreateOrganizationWithOwner
installerOrganizationCreateProject
installerOrganizationCreateProjectOnExistingHome
projectOnExistingHomeCreate
homeMemberSetEmergencyNotifications
emergencyContactDelete
emergencyContactAdd
emergencyContactUpdate
updateUserSubscriptions
userUpdatePreferences
userUpdateNotificationPreferences
updateUserMarketingPreferences
favoritesAdd
favoritesRemove
freezeProtectionConfigure
routineCreate
routineCreateInternal
routineUpdateDescription
routineActivate
routineDeactivate
routineDelete
routineUpdate
pushNotificationEndpointSet
notificationInboxMarkAsRead
demandResponseEnroll
demandResponseUnenroll
smartEnergyEnable
smartEnergyDisable
smartEnergySetHourlyLimit
housingAssociationBuildingAddFacilityTemp
housingAssociationBuildingRemoveFacilityTemp
activateGeofence
deactivateGeofence
setMOBCountdown
sendMOBEmergencyMessage
cancelMOBEmergency
commandRevert
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Arguments
area Id
I D!,non-nullrequired
data
Return type
Areaarea
errors
Mutation sample
mutation areaUpdate($areaId: ID!, $data: AreaUpdateInput!) {
areaUpdate(areaId: $areaId, data: $data) {
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
errors {
message
path
}
}
}Variables
{ "areaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true } }
Response sample
{ "data": { "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
area Id
I D!,non-nullrequired
hub Id
I D!,non-nullrequired
Return type
Areaarea
errors
Mutation sample
mutation areaAddHub($areaId: ID!, $hubId: ID!) {
areaAddHub(areaId: $areaId, hubId: $hubId) {
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
errors {
message
path
}
}
}Variables
{ "areaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
area Id
I D!,non-nullrequired
hub Id
I D!,non-nullrequired
Return type
Areaarea
errors
Mutation sample
mutation areaRemoveHub($areaId: ID!, $hubId: ID!) {
areaRemoveHub(areaId: $areaId, hubId: $hubId) {
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
errors {
message
path
}
}
}Variables
{ "areaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home Id
I D!,non-nullrequired
provider Id
I D!,non-nullrequired
Return type
Clouderrors
Mutation sample
mutation cloudConnectionDisconnect($homeId: ID!, $providerId: ID!) {
cloudConnectionDisconnect(homeId: $homeId, providerId: $providerId) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "providerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home Id
I D!,non-nullrequired
energy Meter Ids
[String!]!,non-nullrequired
Return type
Elhuberrors
Mutation sample
mutation cloudConnectionElhubConnect($homeId: ID!, $energyMeterIds: [String!]!) {
cloudConnectionElhubConnect(homeId: $homeId, energyMeterIds: $energyMeterIds) {
errors {
message
path
invalidEnergyMeterIds
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "energyMeterIds": [ "Example String" ] }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String", "invalidEnergyMeterIds": [ "Example String" ] } ] } }
Arguments
command Id
I D!,non-nullrequired
Return type
Commanderrors
Mutation sample
mutation commandRevert($commandId: ID!) {
commandRevert(commandId: $commandId) {
errors {
message
path
}
}
}Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
hub Id
I D!,non-nullrequired
gateway Connected
Return type
HubMutation sample
mutation hubSetGatewayConnected($hubId: ID!, $gatewayConnected: HubSetGatewayConnectedInput!) {
hubSetGatewayConnected(hubId: $hubId, gatewayConnected: $gatewayConnected) {
hub {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
__typename
# ...HubWaterGuardFragment
}
hubTemplate {
__typename
# ...HubTemplateFragment
}
area {
__typename
# ...AreaFragment
}
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
repeaters {
__typename
# ...HubFragment
}
traits {
__typename
# ...TraitFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
}
command {
id
homeId
commandType
commandState
triggeredAt
source
target
deviceIds
}
errors {
message
path
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "gatewayConnected": { "ethernetConnected": true, "wifiConnected": true, "cellularConnected": true } }
Response sample
{ "data": { "hub": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "__typename": "HubWaterGuard" }, "hubTemplate": { "__typename": "HubTemplate" }, "area": { "__typename": "Area" }, "devices": [ { "__typename": "Device" } ], "repeaters": [ { "__typename": "Hub" } ], "traits": [ { "__typename": "Trait" } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ] }, "command": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandType": "ALARM", "commandState": "FAILED", "triggeredAt": "Example String", "source": "CUSTOMER", "target": "DEVICE", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
hub Id
I D!,non-nullrequired
network Ssid
String!,non-nullrequired
Return type
HubMutation sample
mutation hubSetNetworkSsid($hubId: ID!, $networkSsid: String!) {
hubSetNetworkSsid(hubId: $hubId, networkSsid: $networkSsid) {
hub {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
__typename
# ...HubWaterGuardFragment
}
hubTemplate {
__typename
# ...HubTemplateFragment
}
area {
__typename
# ...AreaFragment
}
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
repeaters {
__typename
# ...HubFragment
}
traits {
__typename
# ...TraitFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
}
command {
id
homeId
commandType
commandState
triggeredAt
source
target
deviceIds
}
errors {
message
path
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "networkSsid": "Example String" }
Response sample
{ "data": { "hub": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "__typename": "HubWaterGuard" }, "hubTemplate": { "__typename": "HubTemplate" }, "area": { "__typename": "Area" }, "devices": [ { "__typename": "Device" } ], "repeaters": [ { "__typename": "Hub" } ], "traits": [ { "__typename": "Trait" } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ] }, "command": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandType": "ALARM", "commandState": "FAILED", "triggeredAt": "Example String", "source": "CUSTOMER", "target": "DEVICE", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
hub Id
I D!,non-nullrequired
network Credentials
String!,non-nullrequired
Return type
HubMutation sample
mutation hubSetNetworkCredentials($hubId: ID!, $networkCredentials: String!) {
hubSetNetworkCredentials(hubId: $hubId, networkCredentials: $networkCredentials) {
hub {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
__typename
# ...HubWaterGuardFragment
}
hubTemplate {
__typename
# ...HubTemplateFragment
}
area {
__typename
# ...AreaFragment
}
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
repeaters {
__typename
# ...HubFragment
}
traits {
__typename
# ...TraitFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
}
command {
id
homeId
commandType
commandState
triggeredAt
source
target
deviceIds
}
errors {
message
path
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "networkCredentials": "Example String" }
Response sample
{ "data": { "hub": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "__typename": "HubWaterGuard" }, "hubTemplate": { "__typename": "HubTemplate" }, "area": { "__typename": "Area" }, "devices": [ { "__typename": "Device" } ], "repeaters": [ { "__typename": "Hub" } ], "traits": [ { "__typename": "Trait" } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ] }, "command": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandType": "ALARM", "commandState": "FAILED", "triggeredAt": "Example String", "source": "CUSTOMER", "target": "DEVICE", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
hub Id
I D!,non-nullrequired
payload
Return type
Huberrors
Mutation sample
mutation invokeHubCommand($hubId: ID!, $payload: HubCommandPayloadInput!) {
invokeHubCommand(hubId: $hubId, payload: $payload) {
errors {
path
message
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "payload": { "topic": "Example String", "commandBody": "Example String" } }
Response sample
{ "data": { "errors": [ { "path": "Example String", "message": "Example String" } ] } }
Arguments
hub Id
I D!,non-nullrequired
is Armed
Boolean!,non-nullrequired
disarm Timeout
Int
Return type
HubMutation sample
mutation hubSetArmed(
$hubId: ID!
$isArmed: Boolean!
$disarmTimeout: Int
) {
hubSetArmed(
hubId: $hubId
isArmed: $isArmed
disarmTimeout: $disarmTimeout
) {
hub {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
__typename
# ...HubWaterGuardFragment
}
hubTemplate {
__typename
# ...HubTemplateFragment
}
area {
__typename
# ...AreaFragment
}
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
repeaters {
__typename
# ...HubFragment
}
traits {
__typename
# ...TraitFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
}
command {
id
homeId
commandType
commandState
triggeredAt
source
target
deviceIds
}
errors {
message
path
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isArmed": true, "disarmTimeout": 40 }
Response sample
{ "data": { "hub": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "__typename": "HubWaterGuard" }, "hubTemplate": { "__typename": "HubTemplate" }, "area": { "__typename": "Area" }, "devices": [ { "__typename": "Device" } ], "repeaters": [ { "__typename": "Hub" } ], "traits": [ { "__typename": "Trait" } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ] }, "command": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandType": "ALARM", "commandState": "FAILED", "triggeredAt": "Example String", "source": "CUSTOMER", "target": "DEVICE", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }