Abra GraphQL APIs
/Users
/- deviceGroupSetArmed
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
hubRegisterDeviceWithQrCode
hubScanDevices
hubKeepDevices
updateNotificationDeviceGroupCommand
deviceUpdatedNotification
hubRegisteredDevicesNotification
hubScanFoundDevicesNotification
hubKeepDevicesFinishedNotification
updateNotificationDevice
updateNotificationDeviceGroup
deviceSetAccessPolicyForUser
deviceGroupCreate
deviceGroupUpdate
deviceGroupDelete
deviceGroupSetBrightness
deviceGroupSetColor
deviceGroupSetOnOff
deviceGroupSetOpenPercent
deviceGroupSetUnlocked
deviceGroupSetChildLock
deviceGroupSetTemperature
deviceGroupSetTemperaturePercentage
deviceGroupSetClimateMode
deviceGroupSetMaximumFloorTemperature
deviceGroupSetFrostGuard
deviceGroupSetNightSwitch
deviceGroupSetRegulatorMode
smartEnergyEnableDevice
smartEnergyDisableDevice
deviceGroupSetArmed
Download GraphQL schema
Home
Users
Arguments
party
I
home
I
action
device
I
Return type
UpdatedMutation sample
mutation updateNotificationDeviceGroup(
$partyId: ID
$homeId: ID!
$action: UpdatedAction!
$deviceGroupId: ID!
) {
updateNotificationDeviceGroup(
partyId: $partyId
homeId: $homeId
action: $action
deviceGroupId: $deviceGroupId
) {
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
{ "partyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "action": "ADDED", "deviceGroupId": "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
device
I
user
I
device
Return type
Deviceaccess
errors
Mutation sample
mutation deviceSetAccessPolicyForUser(
$deviceId: ID!
$userId: ID!
$deviceAccessPolicy: DeviceAccessPolicyInput!
) {
deviceSetAccessPolicyForUser(
deviceId: $deviceId
userId: $userId
deviceAccessPolicy: $deviceAccessPolicy
) {
accessPolicy {
read
write
delete
expiresAt
}
errors {
message
path
}
}
}Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceAccessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } }
Response sample
{ "data": { "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
data
Return type
Devicedevice
errors
Mutation sample
mutation deviceGroupCreate($homeId: ID!, $data: DeviceGroupCreateInput!) {
deviceGroupCreate(homeId: $homeId, data: $data) {
deviceGroup {
id
devices {
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
}
}
name
favorite {
isFavorite
changedAt
}
}
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "name": "Example String", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] } }
Response sample
{ "data": { "deviceGroup": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "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" } } ], "name": "Example String", "favorite": { "isFavorite": true, "changedAt": "Example String" } }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
data
Return type
Devicedevice
errors
Mutation sample
mutation deviceGroupUpdate($deviceGroupId: ID!, $data: DeviceGroupUpdateInput!) {
deviceGroupUpdate(deviceGroupId: $deviceGroupId, data: $data) {
deviceGroup {
id
devices {
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
}
}
name
favorite {
isFavorite
changedAt
}
}
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "name": "Example String", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] } }
Response sample
{ "data": { "deviceGroup": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "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" } } ], "name": "Example String", "favorite": { "isFavorite": true, "changedAt": "Example String" } }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
Return type
Deviceerrors
Mutation sample
mutation deviceGroupDelete($deviceGroupId: ID!) {
deviceGroupDelete(deviceGroupId: $deviceGroupId) {
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
is
Boolean!,non-nullrequired
disarm
Int
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceGroupSetArmed(
$deviceGroupId: ID!
$isArmed: Boolean!
$disarmTimeout: Int
) {
deviceGroupSetArmed(
deviceGroupId: $deviceGroupId
isArmed: $isArmed
disarmTimeout: $disarmTimeout
) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isArmed": true, "disarmTimeout": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
brightness
Float!,non-nullrequired
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceGroupSetBrightness($deviceGroupId: ID!, $brightness: Float!) {
deviceGroupSetBrightness(deviceGroupId: $deviceGroupId, brightness: $brightness) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "brightness": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
color
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceGroupSetColor($deviceGroupId: ID!, $color: DeviceSetColorInput!) {
deviceGroupSetColor(deviceGroupId: $deviceGroupId, color: $color) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "color": { "hue": 40, "saturation": 40 } }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
is
Boolean!,non-nullrequired
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceGroupSetOnOff($deviceGroupId: ID!, $isOn: Boolean!) {
deviceGroupSetOnOff(deviceGroupId: $deviceGroupId, isOn: $isOn) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isOn": true }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
open
Float!,non-nullrequired
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceGroupSetOpenPercent($deviceGroupId: ID!, $openPercent: Float!) {
deviceGroupSetOpenPercent(deviceGroupId: $deviceGroupId, openPercent: $openPercent) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "openPercent": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
device
I
is
Boolean!,non-nullrequired
Return type
Devicecommand
I
errors
Mutation sample
mutation deviceGroupSetUnlocked($deviceGroupId: ID!, $isUnlocked: Boolean!) {
deviceGroupSetUnlocked(deviceGroupId: $deviceGroupId, isUnlocked: $isUnlocked) {
commandId
errors {
message
path
}
}
}Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isUnlocked": true }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Fire
Water
Access
Energy
Misc
Other