Skip to content
Abra GraphQL APIs
/
Misc
/
/
hubRegisteredDevicesNotif...

GraphQL Overview

Download GraphQL schema
schema.graphql
Home

Queries

Overview

Mutations

Overview
Users

Queries

Overview

Mutations

Overview
Fire

Queries

Overview

Mutations

Overview
Water

Queries

Overview

Mutations

Overview
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview

hubRegisterDeviceWithQrCode

(...args)
HubRegisterDeviceWithQrCodePayload

Arguments

qrCode
String!,non-nullrequired
hubId
ID!,non-nullrequired
deviceType
DeviceType!,non-nullrequired
deviceManufacturer
ID!,non-nullrequired

Return type

HubRegisterDeviceWithQrCodePayload
commandId
ID
timeoutSeconds
Int
errors
[HubRegisterDeviceWithQrError!]!,non-null
Mutation 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"
      }
    ]
  }
}

hubScanDevices

(...args)
HubScanDevicesPayload

Arguments

hubId
ID!,non-nullrequired
deviceType
DeviceType!,non-nullrequired
deviceManufacturerId
ID!,non-nullrequired

Return type

HubScanDevicesPayload
commandId
String
timeoutSeconds
Int
errors
[HubScanDevicesError!]!,non-null
Mutation 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"
      }
    ]
  }
}

hubKeepDevices

(...args)
HubKeepDevicesPayload

Arguments

hubId
ID!,non-nullrequired
devices
[String!]!,non-nullrequired

Return type

HubKeepDevicesPayload
commandId
String
timeoutSeconds
Int
errors
[HubKeepDevicesError!]!,non-null
Mutation 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"
      }
    ]
  }
}

updateNotificationDeviceGroupCommand

(...args)
DeviceGroupCommandUpdatedPayload

Arguments

commandId
ID!,non-nullrequired
commandState
CommandState!,non-nullrequired

Return type

DeviceGroupCommandUpdatedPayload
commandId
ID!,non-null
commandState
CommandState!,non-null
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"
  }
}

deviceUpdatedNotification

(...args)
DeviceUpdatedPayload

Arguments

homeId
ID!,non-nullrequired
deviceId
ID!,non-nullrequired

Return type

DeviceUpdatedPayload
partyId
ID
homeId
ID!,non-null
action
UpdatedAction
deviceId
ID!,non-null
device
Device!,non-null
Mutation 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"
      }
    }
  }
}

hubRegisteredDevicesNotification

(...args)
HubRegisteredDevicesPayload

Arguments

commandId
ID!,non-nullrequired
commandStatus
String
devices
HubRegisteredDevicesInput!,non-nullrequired

Return type

HubRegisteredDevicesPayload
commandId
ID!,non-null
deviceIds
[ID!]!,non-null
errors
[HubRegistrationDevicesError!]!,non-null
Mutation 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"
      }
    ]
  }
}

hubScanFoundDevicesNotification

(...args)
HubScanFoundDevicesPayload

Arguments

commandId
ID!,non-nullrequired
commandStatus
String
foundDevices
HubScanFoundDevicesInput!,non-nullrequired

Return type

HubScanFoundDevicesPayload
commandId
String!,non-null
devices
[HubScanFoundDevice!]!,non-null
errors
[HubScanFoundDevicesError!]!,non-null
Mutation sample
mutation hubScanFoundDevicesNotification(
  $commandId: ID!
  $commandStatus: String
  $foundDevices: HubScanFoundDevicesInput!
) {
  hubScanFoundDevicesNotification(
    commandId: $commandId
    commandStatus: $commandStatus
    foundDevices: $foundDevices
  ) {
    commandId 
    devices {
      hubDeviceId 
      deviceName 
      deviceManufacturerName 
      deviceImageSmallUrl 
      serialNumber 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "commandStatus": "Example String",
  "foundDevices": {
    "devices": [
      {
        "hubDeviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "hubDeviceManufacturerName": "Example String",
        "hubDeviceModel": "Example String",
        "hubDeviceMacAddress": "Example String"
      }
    ],
    "errors": [
      {
        "message": "Example String"
      }
    ]
  }
}
Response sample
{
  "data": {
    "commandId": "Example String",
    "devices": [
      {
        "hubDeviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceName": "Example String",
        "deviceManufacturerName": "Example String",
        "deviceImageSmallUrl": "Example String",
        "serialNumber": "Example String"
      }
    ],
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubKeepDevicesFinishedNotification

(...args)
HubKeepDevicesFinishedPayload

Arguments

commandId
ID!,non-nullrequired
commandStatus
String
keepDevices
HubKeepDevicesFinishedInput!,non-nullrequired

Return type

HubKeepDevicesFinishedPayload
commandId
String!,non-null
deviceIds
[ID!]!,non-null
errors
[HubKeepDevicesFinishedError!]!,non-null
Mutation sample
mutation hubKeepDevicesFinishedNotification(
  $commandId: ID!
  $commandStatus: String
  $keepDevices: HubKeepDevicesFinishedInput!
) {
  hubKeepDevicesFinishedNotification(
    commandId: $commandId
    commandStatus: $commandStatus
    keepDevices: $keepDevices
  ) {
    commandId 
    deviceIds 
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "commandStatus": "Example String",
  "keepDevices": {
    "errors": [
      {
        "message": "Example String"
      }
    ]
  }
}
Response sample
{
  "data": {
    "commandId": "Example String",
    "deviceIds": [
      "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
    ],
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

updateNotificationDevice

(...args)
UpdatedPayload

Arguments

partyId
ID
homeId
ID!,non-nullrequired
action
UpdatedAction!,non-nullrequired
deviceId
ID!,non-nullrequired

Return type

UpdatedPayload
DeviceUpdatePayload
DeviceUpdatedPayload
AreaUpdatedPayload
MemberUpdatedPayload
MemberInvitationUpdatedPayload
CloudConnectionUpdatedPayload
AlarmStationInfoUpdatePayload
DeviceGroupUpdatedPayload
FreezeProtectionUpdatedPayload
DemandResponseUpdatedPayload
RoutineUpdatedPayload
SmartEnergyUpdatedPayload
CollectiveAlarmUpdatedPayload
Mutation sample
mutation updateNotificationDevice(
  $partyId: ID
  $homeId: ID!
  $action: UpdatedAction!
  $deviceId: ID!
) {
  updateNotificationDevice(
    partyId: $partyId
    homeId: $homeId
    action: $action
    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
{
  "partyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "action": "ADDED",
  "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"
      }
    }
  }
}

updateNotificationDeviceGroup

(...args)
UpdatedPayload

Arguments

partyId
ID
homeId
ID!,non-nullrequired
action
UpdatedAction!,non-nullrequired
deviceGroupId
ID!,non-nullrequired

Return type

UpdatedPayload
DeviceUpdatePayload
DeviceUpdatedPayload
AreaUpdatedPayload
MemberUpdatedPayload
MemberInvitationUpdatedPayload
CloudConnectionUpdatedPayload
AlarmStationInfoUpdatePayload
DeviceGroupUpdatedPayload
FreezeProtectionUpdatedPayload
DemandResponseUpdatedPayload
RoutineUpdatedPayload
SmartEnergyUpdatedPayload
CollectiveAlarmUpdatedPayload
Mutation 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"
      }
    }
  }
}

deviceSetAccessPolicyForUser

(...args)
DeviceSetAccessPolicyForUserPayload

Arguments

deviceId
ID!,non-nullrequired
userId
ID!,non-nullrequired
deviceAccessPolicy
DeviceAccessPolicyInput!,non-nullrequired

Return type

DeviceSetAccessPolicyForUserPayload
accessPolicy
DeviceAccessPolicy
errors
[DeviceSetAccessPolicyForUserError!]!,non-null
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"
      }
    ]
  }
}
Other

Queries

Overview

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview