Skip to content
Abra GraphQL APIs
/
Water
/
/
deviceSetColor

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

deviceUnregisterV2

(deviceId)
DeviceUnregisterV2Payload

Arguments

deviceId
ID!,non-nullrequired

Return type

DeviceUnregisterV2Payload
commandId
ID
errors
[DeviceUnregisterError!]!,non-null
Mutation sample
mutation deviceUnregisterV2($deviceId: ID!) {
  deviceUnregisterV2(deviceId: $deviceId) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetRelayDeviceType

(...args)
DeviceSetRelayDeviceTypePayload

Arguments

deviceId
ID!,non-nullrequired
deviceType
DeviceType

Return type

DeviceSetRelayDeviceTypePayload
errors
[DeviceSetRelayDeviceTypeError!]!,non-null
Mutation sample
mutation deviceSetRelayDeviceType($deviceId: ID!, $deviceType: DeviceType) {
  deviceSetRelayDeviceType(deviceId: $deviceId, deviceType: $deviceType) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "deviceType": "AIR_QUALITY_SENSOR"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetIoModuleConfiguration

(...args)
DeviceSetIoModuleConfigurationPayload

Arguments

deviceId
ID!,non-nullrequired
configuration
IoModuleConfiguration

Return type

DeviceSetIoModuleConfigurationPayload
errors
[DeviceSetIoModuleConfigurationError!]!,non-null
Mutation sample
mutation deviceSetIoModuleConfiguration($deviceId: ID!, $configuration: IoModuleConfiguration) {
  deviceSetIoModuleConfiguration(deviceId: $deviceId, configuration: $configuration) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "configuration": "BMS"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetArmed

(...args)
DeviceSetArmedPayload

Arguments

deviceId
ID!,non-nullrequired
isArmed
Boolean!,non-nullrequired
disarmTimeout
Int
commandSource
CommandSource

Return type

DeviceSetArmedPayload
device
Device
command
Command
errors
[DeviceSetArmedError!]!,non-null
Mutation sample
mutation deviceSetArmed(
  $deviceId: ID!
  $isArmed: Boolean!
  $disarmTimeout: Int
  $commandSource: CommandSource
) {
  deviceSetArmed(
    deviceId: $deviceId
    isArmed: $isArmed
    disarmTimeout: $disarmTimeout
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "isArmed": true,
  "disarmTimeout": 40,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetBrightness

(...args)
DeviceSetBrightnessPayload

Arguments

deviceId
ID!,non-nullrequired
brightness
Float!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetBrightnessPayload
device
Device
command
Command
errors
[DeviceSetBrightnessError!]!,non-null
Mutation sample
mutation deviceSetBrightness(
  $deviceId: ID!
  $brightness: Float!
  $commandSource: CommandSource
) {
  deviceSetBrightness(
    deviceId: $deviceId
    brightness: $brightness
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "brightness": 40,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetColor

(...args)
DeviceSetColorPayload

Arguments

deviceId
ID!,non-nullrequired
color
DeviceSetColorInput!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetColorPayload
device
Device
command
Command
errors
[DeviceSetColorError!]!,non-null
Mutation sample
mutation deviceSetColor(
  $deviceId: ID!
  $color: DeviceSetColorInput!
  $commandSource: CommandSource
) {
  deviceSetColor(
    deviceId: $deviceId
    color: $color
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "color": {
    "hue": 40,
    "saturation": 40
  },
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetOnOff

(...args)
DeviceSetOnOffPayload

Arguments

deviceId
ID!,non-nullrequired
isOn
Boolean!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetOnOffPayload
device
Device
command
Command
errors
[DeviceSetOnOffError!]!,non-null
Mutation sample
mutation deviceSetOnOff(
  $deviceId: ID!
  $isOn: Boolean!
  $commandSource: CommandSource
) {
  deviceSetOnOff(
    deviceId: $deviceId
    isOn: $isOn
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "isOn": true,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetOpenPercent

(...args)
DeviceSetOpenPercentPayload

Arguments

deviceId
ID!,non-nullrequired
openPercent
Float!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetOpenPercentPayload
device
Device
command
Command
errors
[DeviceSetOpenPercentError!]!,non-null
Mutation sample
mutation deviceSetOpenPercent(
  $deviceId: ID!
  $openPercent: Float!
  $commandSource: CommandSource
) {
  deviceSetOpenPercent(
    deviceId: $deviceId
    openPercent: $openPercent
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "openPercent": 40,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetUnlocked

(...args)
DeviceSetUnlockedPayload

Arguments

deviceId
ID!,non-nullrequired
isUnlocked
Boolean!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetUnlockedPayload
device
Device
command
Command
errors
[DeviceSetUnlockedError!]!,non-null
Mutation sample
mutation deviceSetUnlocked(
  $deviceId: ID!
  $isUnlocked: Boolean!
  $commandSource: CommandSource
) {
  deviceSetUnlocked(
    deviceId: $deviceId
    isUnlocked: $isUnlocked
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "isUnlocked": true,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetChildLock

(...args)
DeviceSetChildLockPayload

Arguments

deviceId
ID!,non-nullrequired
childLock
Boolean!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetChildLockPayload
device
Device
command
Command
errors
[DeviceSetChildLockError!]!,non-null
Mutation sample
mutation deviceSetChildLock(
  $deviceId: ID!
  $childLock: Boolean!
  $commandSource: CommandSource
) {
  deviceSetChildLock(
    deviceId: $deviceId
    childLock: $childLock
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "childLock": true,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

deviceSetTemperatureSetpoint

(...args)
DeviceSetTemperatureSetpointPayload

Arguments

deviceId
ID!,non-nullrequired
delta
Float!,non-nullrequired
commandSource
CommandSource

Return type

DeviceSetTemperatureSetpointPayload
device
Device
command
Command
errors
[DeviceSetTemperatureSetpointError!]!,non-null
Mutation sample
mutation deviceSetTemperatureSetpoint(
  $deviceId: ID!
  $delta: Float!
  $commandSource: CommandSource
) {
  deviceSetTemperatureSetpoint(
    deviceId: $deviceId
    delta: $delta
    commandSource: $commandSource
  ) {
    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 
      }
    }
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "delta": 40,
  "commandSource": "CUSTOMER"
}
Response sample
{
  "data": {
    "device": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "deviceType": "AIR_QUALITY_SENSOR",
      "name": "Example String",
      "serialNumber": "Example String",
      "imei": "Example String",
      "macAddress": "Example String",
      "ipAddress": "Example String",
      "roomPlacement": "Example String",
      "manufacturer": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "logo": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        }
      },
      "deviceTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "deviceType": "AIR_QUALITY_SENSOR",
        "name": "Example String",
        "primaryPairingMode": "PLUG",
        "secondaryPairingModes": [
          "PLUG"
        ],
        "manufacturer": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "logo": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          }
        },
        "image": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "imageWithBg": {
          "url": "Example String",
          "urlSmall": "Example String",
          "urlMedium": "Example String",
          "urlLarge": "Example String"
        },
        "instructions": {
          "installation": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "configuration": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "help": [
            {
              "description": {
                "__typename": "DeviceInstructionDescriptionItem"
              },
              "assetUrl": "Example String"
            }
          ],
          "connectionAssetUrl": "Example String"
        }
      },
      "image": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String"
      },
      "favorite": true,
      "favoriteChangedAt": "Example String",
      "registeredAt": "Example String",
      "canBeUnregistered": true,
      "firmwareVersion": "Example String",
      "latestFirmware": [
        {
          "variant": "ROUTER",
          "version": "Example String",
          "downloadUrl": "Example String"
        }
      ],
      "relayConfiguration": {
        "supportedDeviceTypes": [
          "AIR_QUALITY_SENSOR"
        ],
        "endDeviceType": "AIR_QUALITY_SENSOR"
      },
      "ioModuleConfiguration": {
        "supportedConfigurations": [
          "BMS"
        ],
        "configuration": "BMS"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ],
      "accessPolicy": {
        "read": true,
        "write": true,
        "delete": true,
        "expiresAt": "Example String"
      }
    },
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview
Other

Queries

Overview

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview