Skip to content
Home
Overview
Overview
Users
Overview
Overview
Fire
Overview
Overview
Water
Overview
Overview
Access
Overview

Arguments

deviceId
ID!,non-nullrequired

Return type

Device
id
ID!,non-null
deviceType
name
String
serialNumber
String!,non-null
imei
String
macAddress
String
ipAddress
String
roomPlacement
String
manufacturer
deviceTemplate
language
favorite
Boolean
favoriteChangedAt
String
registeredAt
String
canBeUnregistered
Boolean!,non-null
firmwareVersion
String
latestFirmware
relayConfiguration
ioModuleConfiguration
area
traits
[Trait!]!,non-null
accessPolicy
Query sample
query device($deviceId: ID!) {
  device(deviceId: $deviceId) {
    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 {
            description 
            additionalInfo 
          }
          assetUrl 
        }
        configuration {
          description {
            description 
            additionalInfo 
          }
          assetUrl 
        }
        help {
          description {
            description 
            additionalInfo 
          }
          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 {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        deviceTemplate(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          primaryPairingMode 
          secondaryPairingModes 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          imageWithBg {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          instructions {
            installation {
              __typename
              # ...DeviceInstructionItemFragment
            }
            configuration {
              __typename
              # ...DeviceInstructionItemFragment
            }
            help {
              __typename
              # ...DeviceInstructionItemFragment
            }
            connectionAssetUrl 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        favorite 
        favoriteChangedAt 
        registeredAt 
        canBeUnregistered 
        firmwareVersion 
        latestFirmware {
          variant 
          version 
          downloadUrl 
        }
        relayConfiguration {
          supportedDeviceTypes 
          endDeviceType 
        }
        ioModuleConfiguration {
          supportedConfigurations 
          configuration 
        }
        area {
          id 
          areaName 
          areaType 
          size 
          floor 
          children 
          devices(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            serialNumber 
            imei 
            macAddress 
            ipAddress 
            roomPlacement 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            deviceTemplate(
              # Arguments Here
            ) {
              __typename
              # ...DeviceTemplateFragment
            }
            image {
              __typename
              # ...DeviceImageFragment
            }
            favorite 
            favoriteChangedAt 
            registeredAt 
            canBeUnregistered 
            firmwareVersion 
            latestFirmware {
              __typename
              # ...DeviceFirmwareFragment
            }
            relayConfiguration {
              __typename
              # ...DeviceRelayConfigurationFragment
            }
            ioModuleConfiguration {
              __typename
              # ...DeviceIoModuleConfigurationFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
            accessPolicy {
              __typename
              # ...DeviceAccessPolicyFragment
            }
          }
          accessPolicies {
            actionType 
            create 
            update 
            delete 
            read 
          }
        }
        traits {
          traitType 
          commands 
          attributes {
            name 
            dataType 
            editable 
            availableArmLevels {
              __typename
              # ...ArmLevelFragment
            }
          }
        }
        accessPolicy {
          read 
          write 
          delete 
          expiresAt 
        }
      }
      accessPolicies {
        actionType 
        create 
        update 
        delete 
        read 
      }
    }
    traits {
      traitType 
      commands 
      attributes {
        name 
        dataType 
        editable 
        availableArmLevels {
          id 
          description 
        }
      }
    }
    accessPolicy {
      read 
      write 
      delete 
      expiresAt 
    }
  }
}
Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "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": { "description": "Example String", "additionalInfo": "Example String" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "description": "Example String", "additionalInfo": "Example String" }, "assetUrl": "Example String" } ], "help": [ { "description": { "description": "Example String", "additionalInfo": "Example String" }, "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": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } }

Arguments

serialNumber
String!,non-nullrequired

Return type

DeviceIdentifyPayload
deviceInfo
Query sample
query deviceIdentifyBySerialNumber($serialNumber: String!) {
  deviceIdentifyBySerialNumber(serialNumber: $serialNumber) {
    deviceInfo {
      id 
      macAddress 
      firmwareVersion 
      serialNumber 
      registered 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "serialNumber": "Example String" }
Response sample
{ "data": { "deviceInfo": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "macAddress": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "registered": true }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

qrCode
String!,non-nullrequired

Return type

DeviceIdentifyPayload
deviceInfo
Query sample
query deviceIdentifyByQRCode($qrCode: String!) {
  deviceIdentifyByQRCode(qrCode: $qrCode) {
    deviceInfo {
      id 
      macAddress 
      firmwareVersion 
      serialNumber 
      registered 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "qrCode": "Example String" }
Response sample
{ "data": { "deviceInfo": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "macAddress": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "registered": true }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Return type

[DeviceManufacturer!]!
id
ID!,non-null
name
String!,non-null
Query sample
query deviceManufacturers {
  deviceManufacturers {
    id 
    name 
    logo {
      url 
      urlSmall 
      urlMedium 
      urlLarge 
    }
  }
}
Response sample
{ "data": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } } ] }

Arguments

manufacturerId
ID
deviceType
language
String

Return type

[DeviceTemplate!]!
id
ID!,non-null
deviceType
DeviceType!,non-null
name
String
primaryPairingMode
PairingMode!,non-null
secondaryPairingModes
manufacturer
instructions
Query sample
query deviceTemplates(
  $manufacturerId: ID
  $deviceType: DeviceType
  $language: String
) {
  deviceTemplates(
    manufacturerId: $manufacturerId
    deviceType: $deviceType
    language: $language
  ) {
    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 {
          description 
          additionalInfo 
        }
        assetUrl 
      }
      configuration {
        description {
          description 
          additionalInfo 
        }
        assetUrl 
      }
      help {
        description {
          description 
          additionalInfo 
        }
        assetUrl 
      }
      connectionAssetUrl 
    }
  }
}
Variables
{ "manufacturerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "language": "Example String" }
Response sample
{ "data": [ { "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": { "description": "Example String", "additionalInfo": "Example String" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "description": "Example String", "additionalInfo": "Example String" }, "assetUrl": "Example String" } ], "help": [ { "description": { "description": "Example String", "additionalInfo": "Example String" }, "assetUrl": "Example String" } ], "connectionAssetUrl": "Example String" } } ] }

Arguments

commandId
ID!,non-nullrequired

Return type

[HubScanFoundDevice!]!
hubDeviceId
ID!,non-null
deviceName
String!,non-null
deviceManufacturerName
String!,non-null
deviceImageSmallUrl
String!,non-null
serialNumber
String!,non-null
Query sample
query hubScanFoundDevices($commandId: ID!) {
  hubScanFoundDevices(commandId: $commandId) {
    hubDeviceId 
    deviceName 
    deviceManufacturerName 
    deviceImageSmallUrl 
    serialNumber 
  }
}
Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": [ { "hubDeviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceName": "Example String", "deviceManufacturerName": "Example String", "deviceImageSmallUrl": "Example String", "serialNumber": "Example String" } ] }

Arguments

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

Return type

DeviceAccessPolicy
read
Boolean!,non-null
write
Boolean!,non-null
delete
Boolean!,non-null
expiresAt
String
Query sample
query deviceAccessPolicyForUser($deviceId: ID!, $userId: ID!) {
  deviceAccessPolicyForUser(deviceId: $deviceId, userId: $userId) {
    read 
    write 
    delete 
    expiresAt 
  }
}
Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } }

Arguments

deviceId
ID!,non-nullrequired

Return type

[HomeMember!]!
Query sample
query deviceUsersWithAccess($deviceId: ID!) {
  deviceUsersWithAccess(deviceId: $deviceId) {
    id 
    firstName 
    lastName 
    phoneNumber {
      countryCode 
      nationalNumber 
    }
    account {
      id 
      email 
      avatar {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
        uploadUrl 
      }
    }
    isEmergencyContact 
    isAlarmStationContact 
  }
}
Variables
{ "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "account": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" } }, "isEmergencyContact": true, "isAlarmStationContact": true } ] }

Arguments

homeId
ID!,non-nullrequired

Return type

DeviceGroupCollection
deviceGroups
Query sample
query deviceGroups($homeId: ID!) {
  deviceGroups(homeId: $homeId) {
    deviceGroups {
      id 
      devices {
        id 
        deviceType 
        name 
        serialNumber 
        imei 
        macAddress 
        ipAddress 
        roomPlacement 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        deviceTemplate(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          primaryPairingMode 
          secondaryPairingModes 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          imageWithBg {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          instructions {
            installation {
              __typename
              # ...DeviceInstructionItemFragment
            }
            configuration {
              __typename
              # ...DeviceInstructionItemFragment
            }
            help {
              __typename
              # ...DeviceInstructionItemFragment
            }
            connectionAssetUrl 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        favorite 
        favoriteChangedAt 
        registeredAt 
        canBeUnregistered 
        firmwareVersion 
        latestFirmware {
          variant 
          version 
          downloadUrl 
        }
        relayConfiguration {
          supportedDeviceTypes 
          endDeviceType 
        }
        ioModuleConfiguration {
          supportedConfigurations 
          configuration 
        }
        area {
          id 
          areaName 
          areaType 
          size 
          floor 
          children 
          devices(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            serialNumber 
            imei 
            macAddress 
            ipAddress 
            roomPlacement 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            deviceTemplate(
              # Arguments Here
            ) {
              __typename
              # ...DeviceTemplateFragment
            }
            image {
              __typename
              # ...DeviceImageFragment
            }
            favorite 
            favoriteChangedAt 
            registeredAt 
            canBeUnregistered 
            firmwareVersion 
            latestFirmware {
              __typename
              # ...DeviceFirmwareFragment
            }
            relayConfiguration {
              __typename
              # ...DeviceRelayConfigurationFragment
            }
            ioModuleConfiguration {
              __typename
              # ...DeviceIoModuleConfigurationFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
            accessPolicy {
              __typename
              # ...DeviceAccessPolicyFragment
            }
          }
          accessPolicies {
            actionType 
            create 
            update 
            delete 
            read 
          }
        }
        traits {
          traitType 
          commands 
          attributes {
            name 
            dataType 
            editable 
            availableArmLevels {
              __typename
              # ...ArmLevelFragment
            }
          }
        }
        accessPolicy {
          read 
          write 
          delete 
          expiresAt 
        }
      }
      name 
      favorite {
        isFavorite 
        changedAt 
      }
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "deviceGroups": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "name": "Example String", "favorite": { "isFavorite": true, "changedAt": "Example String" } } ] } }

deviceFirmwareUploadUrl

(...args)
String

Arguments

model
String!,non-nullrequired
version
String!,non-nullrequired
transportMedium

Return type

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query deviceFirmwareUploadUrl(
  $model: String!
  $version: String!
  $transportMedium: DeviceFirmwareTransportMedium!
  $variant: DeviceFirmwareVariant
) {
  deviceFirmwareUploadUrl(
    model: $model
    version: $version
    transportMedium: $transportMedium
    variant: $variant
  ) 
}
Variables
{ "model": "Example String", "version": "Example String", "transportMedium": "BLE", "variant": "ROUTER" }
Response sample
{ "data": "Example String" }
Overview
Energy
Overview
Overview
Misc
Overview
Overview
Other
Overview
Overview
Overview
Overview
Overview
Overview
Overview
Overview