Abra GraphQL APIs
/Users
/- hubRegisterDeviceWithQrCode
areaAddDevice
areaRemoveDevice
deviceRegisterByQrCode
deviceUnregister
deviceUnregisterV2
deviceSetRelayDeviceType
deviceSetIoModuleConfiguration
deviceSetArmed
deviceSetBrightness
deviceSetColor
deviceSetOnOff
deviceSetOpenPercent
deviceSetUnlocked
deviceSetChildLock
deviceSetTemperatureSetpoint
deviceSetTemperatureSetpointPercentage
deviceSetTemperature
deviceSetTemperaturePercentage
deviceSetClimateMode
deviceSetMaximumFloorTemperature
deviceSetFrostGuard
deviceSetNightSwitch
deviceSetRegulatorMode
deviceSetEvCharging
deviceInvokeCommand
deviceWaterSensorProvisioning
deviceUpdateName
deviceToggleFavorite
hubScanDevices
hubKeepDevices
updateNotificationDeviceGroupCommand
deviceUpdatedNotification
hubRegisteredDevicesNotification
hubScanFoundDevicesNotification
hubKeepDevicesFinishedNotification
updateNotificationDevice
updateNotificationDeviceGroup
deviceSetAccessPolicyForUser
deviceGroupCreate
deviceGroupUpdate
deviceGroupDelete
deviceGroupSetArmed
deviceGroupSetBrightness
deviceGroupSetColor
deviceGroupSetOnOff
deviceGroupSetOpenPercent
deviceGroupSetUnlocked
deviceGroupSetChildLock
deviceGroupSetTemperature
deviceGroupSetTemperaturePercentage
deviceGroupSetClimateMode
deviceGroupSetMaximumFloorTemperature
deviceGroupSetFrostGuard
deviceGroupSetNightSwitch
deviceGroupSetRegulatorMode
smartEnergyEnableDevice
smartEnergyDisableDevice
hubRegisterDeviceWithQrCo...
Download GraphQL schema
Home
Users
Arguments
device
I
charging
Boolean!,non-nullrequired
command
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceSetEvCharging(
$deviceId: ID!
$chargingOn: Boolean!
$commandSource: CommandSource
) {
deviceSetEvCharging(
deviceId: $deviceId
chargingOn: $chargingOn
commandSource: $commandSource
) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "chargingOn": true, "commandSource": "CUSTOMER" }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
data
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceInvokeCommand($deviceId: ID!, $data: DeviceCommandInput!) {
deviceInvokeCommand(deviceId: $deviceId, data: $data) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandType": "EV_CHARGE", "source": "CUSTOMER", "triggerMeta": "OVERRIDE", "evChargingSpeed": { "amperage": 40 }, "evCharge": { "chargingOn": true }, "turnOn": { "isOn": true } } }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
data
Return type
Devicedevice
String!,non-null
Mutation sample
mutation deviceWaterSensorProvisioning($data: DeviceWaterSensorProvisioningInput!) {
deviceWaterSensorProvisioning(data: $data) {
deviceId
}
}Variables
{ "data": { "serialNumber": "Example String", "macAddress": "Example String" } }
Response sample
{ "data": { "deviceId": "Example String" } }
Arguments
device
I
name
String!,non-nullrequired
Return type
Devicedevice
errors
Mutation sample
mutation deviceUpdateName($deviceId: ID!, $name: String!) {
deviceUpdateName(deviceId: $deviceId, name: $name) {
device {
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 {
url
urlSmall
urlMedium
urlLarge
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
configuration {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
help {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
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 {
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
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
errors {
message
path
}
}
}Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String" }
Response sample
{ "data": { "device": { "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": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "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": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "help": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "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": { "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 } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
Return type
DeviceMutation sample
mutation deviceToggleFavorite($deviceId: ID!) {
deviceToggleFavorite(deviceId: $deviceId) {
deviceId
device {
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 {
url
urlSmall
urlMedium
urlLarge
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
configuration {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
help {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
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 {
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
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
errors {
message
path
}
}
}Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "device": { "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": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "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": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "help": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "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": { "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 } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
qr
String!,non-nullrequired
hub
I
device
device
I
Return type
HubMutation sample
mutation hubRegisterDeviceWithQrCode(
$qrCode: String!
$hubId: ID!
$deviceType: DeviceType!
$deviceManufacturer: ID!
) {
hubRegisterDeviceWithQrCode(
qrCode: $qrCode
hubId: $hubId
deviceType: $deviceType
deviceManufacturer: $deviceManufacturer
) {
commandId
timeoutSeconds
errors {
message
path
}
}
}Variables
{ "qrCode": "Example String", "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "deviceManufacturer": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "timeoutSeconds": 40, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
hub
I
device
device
I
Return type
HubMutation sample
mutation hubScanDevices(
$hubId: ID!
$deviceType: DeviceType!
$deviceManufacturerId: ID!
) {
hubScanDevices(
hubId: $hubId
deviceType: $deviceType
deviceManufacturerId: $deviceManufacturerId
) {
commandId
timeoutSeconds
errors {
message
path
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "deviceManufacturerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "commandId": "Example String", "timeoutSeconds": 40, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
hub
I
devices
[String!]!,non-nullrequired
Return type
HubMutation sample
mutation hubKeepDevices($hubId: ID!, $devices: [String!]!) {
hubKeepDevices(hubId: $hubId, devices: $devices) {
commandId
timeoutSeconds
errors {
message
path
}
}
}Variables
{ "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "devices": [ "Example String" ] }
Response sample
{ "data": { "commandId": "Example String", "timeoutSeconds": 40, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
command
I
command
Return type
Devicecommand
I
command
Mutation sample
mutation updateNotificationDeviceGroupCommand($commandId: ID!, $commandState: CommandState!) {
updateNotificationDeviceGroupCommand(commandId: $commandId, commandState: $commandState) {
commandId
commandState
}
}Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandState": "FAILED" }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandState": "FAILED" } }
Arguments
home
I
device
I
Return type
DeviceMutation sample
mutation deviceUpdatedNotification($homeId: ID!, $deviceId: ID!) {
deviceUpdatedNotification(homeId: $homeId, deviceId: $deviceId) {
partyId
homeId
action
deviceId
device {
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 {
url
urlSmall
urlMedium
urlLarge
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
configuration {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
help {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
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 {
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
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "partyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "action": "ADDED", "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "device": { "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": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "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": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "help": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "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": { "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 } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } } }
Arguments
command
I
command
String
devices
Return type
HubMutation sample
mutation hubRegisteredDevicesNotification(
$commandId: ID!
$commandStatus: String
$devices: HubRegisteredDevicesInput!
) {
hubRegisteredDevicesNotification(
commandId: $commandId
commandStatus: $commandStatus
devices: $devices
) {
commandId
deviceIds
errors {
message
path
}
}
}Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandStatus": "Example String", "devices": { "devices": [ { "hubDeviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "hubDeviceManufacturerName": "Example String", "hubDeviceModel": "Example String", "hubDeviceMacAddress": "Example String" } ], "errors": [ { "message": "Example String" } ] } }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ], "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Fire
Water
Access
Energy
Misc
Other