Abra GraphQL APIs
/Energy
/- housingAssociationCollectiveAlarmCreateZone
alarmResolve
alarmSetArm
alarmAcknowledge
alarmAlertEmergencyContactsNotificationRequest
alarmAlertEmergencyContactsNotificationDismiss
alarmImOkEmergencyContactsNotificationRequest
alarmImOkEmergencyContactsNotificationDismiss
setCollectiveAlarmForHomeHubs
alarmUpdatedNotification
updateNotificationAlarmStationInfo
updateNotificationCollectiveAlarm
alarmStationEnable
alarmStationDisable
alarmStationAddEmergencyContact
alarmStationUpdateEmergencyContact
alarmStationDeleteEmergencyContact
housingAssociationCollectiveAlarmDeleteZone
housingAssociationCollectiveAlarmConfigureZone
housingAssociationCollectiveAlarmZoneAddFacility
housingAssociationCollectiveAlarmZoneRemoveFacility
collectiveAlarmCreate
collectiveAlarmDelete
collectiveAlarmSetTenants
housingAssociationCollect...
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Arguments
home Id
I D!,non-nullrequired
override Name
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 Id
I D!,non-nullrequired
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 Id
I D!,non-nullrequired
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 Id
I D!,non-nullrequired
id
I D!,non-nullrequired
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 Id
I D!,non-nullrequired
id
I D!,non-nullrequired
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 Association Id
I D!,non-nullrequired
Return type
Housingcollective Alarm Zone
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 Id
I D!,non-nullrequired
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" } ] } }
Arguments
zone Id
I D!,non-nullrequired
data
Return type
Housingcollective Alarm Zone
errors
Mutation sample
mutation housingAssociationCollectiveAlarmConfigureZone($zoneId: ID!, $data: CollectiveAlarmZoneConfigurationInput!) {
housingAssociationCollectiveAlarmConfigureZone(zoneId: $zoneId, data: $data) {
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
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "fireAlarmZoneConfigurationInput": { "propagationDelaySeconds": 40 } } }
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 Id
I D!,non-nullrequired
data
Return type
Housingcollective Alarm Zone
errors
Mutation sample
mutation housingAssociationCollectiveAlarmZoneAddFacility($zoneId: ID!, $data: ZoneAddFacilityInput!) {
housingAssociationCollectiveAlarmZoneAddFacility(zoneId: $zoneId, data: $data) {
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
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "facilityType": "BUILDING", "facilityId": "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 Id
I D!,non-nullrequired
facility Id
I D!,non-nullrequired
Return type
Housingcollective Alarm Zone
errors
Mutation sample
mutation housingAssociationCollectiveAlarmZoneRemoveFacility($zoneId: ID!, $facilityId: ID!) {
housingAssociationCollectiveAlarmZoneRemoveFacility(zoneId: $zoneId, facilityId: $facilityId) {
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
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "facilityId": "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
collective Alarm Id
I D!,non-nullrequired
Return type
Collectiveerrors
Mutation sample
mutation collectiveAlarmCreate($collectiveAlarmId: ID!) {
collectiveAlarmCreate(collectiveAlarmId: $collectiveAlarmId) {
errors {
message
path
}
}
}Variables
{ "collectiveAlarmId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Misc
Other