Abra GraphQL APIs
/Fire
/- alarmStationDisable
alarmResolve
alarmSetArm
alarmAcknowledge
alarmAlertEmergencyContactsNotificationRequest
alarmAlertEmergencyContactsNotificationDismiss
alarmImOkEmergencyContactsNotificationRequest
alarmImOkEmergencyContactsNotificationDismiss
setCollectiveAlarmForHomeHubs
alarmUpdatedNotification
updateNotificationAlarmStationInfo
updateNotificationCollectiveAlarm
alarmStationEnable
alarmStationAddEmergencyContact
alarmStationUpdateEmergencyContact
alarmStationDeleteEmergencyContact
housingAssociationCollectiveAlarmCreateZone
housingAssociationCollectiveAlarmDeleteZone
housingAssociationCollectiveAlarmConfigureZone
housingAssociationCollectiveAlarmZoneAddFacility
housingAssociationCollectiveAlarmZoneRemoveFacility
collectiveAlarmCreate
collectiveAlarmDelete
collectiveAlarmSetTenants
alarmStationDisable
Download GraphQL schema
Home
Users
Fire
Arguments
home
I
active
Boolean!,non-nullrequired
alarm
Return type
Seterrors
Mutation sample
mutation setCollectiveAlarmForHomeHubs(
$homeId: ID!
$active: Boolean!
$alarmType: AlarmType!
) {
setCollectiveAlarmForHomeHubs(
homeId: $homeId
active: $active
alarmType: $alarmType
) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "active": true, "alarmType": "FIRE" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
alarm
I
alarm
Return type
AlarmMutation sample
mutation alarmUpdatedNotification(
$homeId: ID!
$alarmId: ID
$alarm: alarmUpdatedNotificationInput!
) {
alarmUpdatedNotification(
homeId: $homeId
alarmId: $alarmId
alarm: $alarm
) {
homeId
alarmId
alarm {
id
state
triggeredAt
snoozeExpiresAt
areas {
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
}
}
notificationLifecycle {
id
notifications {
reason
}
}
alarmStationNotificationLifecycle {
deviceEvents {
deviceId
events {
triggeredAt
eventType
status
}
}
}
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarmId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarm": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "state": "ALARM", "stateId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "triggeredAt": "Example String", "snoozeExpiresAt": "Example String", "isArmed": true, "typename__": "Example String", "areaIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] } }
Response sample
{ "data": { "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarmId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarm": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "state": "ALARM", "triggeredAt": "Example String", "snoozeExpiresAt": "Example String", "areas": [ { "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 } ] } ], "notificationLifecycle": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "notifications": [ { "reason": "Example String" } ] }, "alarmStationNotificationLifecycle": { "deviceEvents": [ { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "events": [ { "triggeredAt": "Example String", "eventType": "ACTIVATED", "status": "DELIVERED" } ] } ] } } } }
Arguments
party
I
home
I
action
alarm
Return type
UpdatedMutation sample
mutation updateNotificationAlarmStationInfo(
$partyId: ID
$homeId: ID!
$action: UpdatedAction!
$alarmStationInfo: AlarmStationInfoInput!
) {
updateNotificationAlarmStationInfo(
partyId: $partyId
homeId: $homeId
action: $action
alarmStationInfo: $alarmStationInfo
) {
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", "alarmStationInfo": { "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "status": "Example String", "contacts": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" } } ] } }
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
party
I
home
I
action
alarm
Return type
UpdatedMutation sample
mutation updateNotificationCollectiveAlarm(
$partyId: ID
$homeId: ID!
$action: UpdatedAction!
$alarmType: AlarmType!
) {
updateNotificationCollectiveAlarm(
partyId: $partyId
homeId: $homeId
action: $action
alarmType: $alarmType
) {
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", "alarmType": "FIRE" }
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
home
I
override
String
Return type
Alarmerrors
Mutation sample
mutation alarmStationEnable($homeId: ID!, $overrideName: String) {
alarmStationEnable(homeId: $homeId, overrideName: $overrideName) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "overrideName": "Example String" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
Return type
Alarmerrors
Mutation sample
mutation alarmStationDisable($homeId: ID!) {
alarmStationDisable(homeId: $homeId) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
data
Return type
Alarmerrors
Mutation sample
mutation alarmStationAddEmergencyContact($homeId: ID!, $data: AlarmStationAddEmergencyContactInput!) {
alarmStationAddEmergencyContact(homeId: $homeId, data: $data) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "fixedPriority": 40 } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
id
I
data
Return type
Alarmerrors
Mutation sample
mutation alarmStationUpdateEmergencyContact(
$homeId: ID!
$id: ID!
$data: AlarmStationUpdateEmergencyContactInput!
) {
alarmStationUpdateEmergencyContact(
homeId: $homeId
id: $id
data: $data
) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" } } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
id
I
Return type
Alarmerrors
Mutation sample
mutation alarmStationDeleteEmergencyContact($homeId: ID!, $id: ID!) {
alarmStationDeleteEmergencyContact(homeId: $homeId, id: $id) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
housing
I
Return type
Housingcollective
errors
Mutation sample
mutation housingAssociationCollectiveAlarmCreateZone($housingAssociationId: ID!) {
housingAssociationCollectiveAlarmCreateZone(housingAssociationId: $housingAssociationId) {
collectiveAlarmZone {
id
facilities {
id
units {
id
unitNumber
}
commonAreas {
id
nickname
}
}
configurations {
propagationDelaySeconds
meetingPointMap(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
}
}
errors {
message
path
}
}
}Variables
{ "housingAssociationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "collectiveAlarmZone": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "facilities": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "units": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "unitNumber": "Example String" } ], "commonAreas": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "nickname": "Example String" } ] } ], "configurations": [ { "propagationDelaySeconds": 40, "meetingPointMap": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" } } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
zone
I
Return type
Housingerrors
Mutation sample
mutation housingAssociationCollectiveAlarmDeleteZone($zoneId: ID!) {
housingAssociationCollectiveAlarmDeleteZone(zoneId: $zoneId) {
errors {
message
path
}
}
}Variables
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Water
Access
Energy
Misc
Other