Skip to content
Home
Overview
Overview
Users
Overview
Overview
Fire
Overview
Overview
Water
Overview
Overview
Access
Overview
Overview
Energy
Overview
Overview
Misc
Overview
Overview
Other
Overview
Overview

Arguments

projectId
ID!,non-nullrequired

Return type

ProjectDeletePayload
projectId
ID
errors
Mutation sample
mutation installerDeleteProject($projectId: ID!) {
  installerDeleteProject(projectId: $projectId) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired

Return type

HomeCreatePayload
home
errors
Mutation sample
mutation installerCreateHome($homeId: ID!) {
  installerCreateHome(homeId: $homeId) {
    home {
      id 
      locationInfo {
        country 
        city 
        postalCode 
        street 
        streetNumber 
        unitNumber 
        geoLocation {
          latitude 
          longitude 
        }
        apartmentNumber 
        associationId 
      }
      systemCountry 
      homeInfo {
        nickname 
        avatarUrl 
        size 
        ageOfBuilding 
        numberOfFloors 
        numberOfAdults 
        numberOfChildren 
        homeType 
        dwellingUnit 
        heatingType 
        cooling 
        ventilation 
        propertyManagerName 
        constructionType 
        buildingYear 
      }
      avatar(
        # Arguments Here
      ) {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
        uploadUrl 
      }
      insuranceInfo {
        insuranceCompany {
          id 
          name 
        }
      }
      areas {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      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 
        }
      }
      hubs {
        id 
        name 
        hubType 
        productType 
        brandName 
        firmwareVersion 
        serialNumber 
        macAddress 
        manufacturerInformation 
        wasWaterSensorTapePreviouslyConnected 
        waterGuard {
          wasWaterSensorTapePreviouslyConnected 
          mode 
          tamperModeWarningTriggeredAt 
          tamperModeTriggersAt 
          overrideModeTriggeredAt 
          showLevel1Warning 
          showLevel2Warning 
        }
        hubTemplate {
          id 
          name 
          hubAssetUrl 
          hubWithBgAssetUrl 
          hubQrCodeAssetUrl 
          hubConnectionAssetUrl 
          hubSearchAssetUrl 
          waterLeakDetectorAssetUrl 
          waterLeakDetectorInstructionsAssetUrl 
          waterLeakDetectorHelpAssetUrl 
          waterSensorTapeAssetUrl 
          waterSensorTapeInstructionsAssetUrl 
          waterLeakSystemPressHubButtonAssetUrl 
          sintefLogoAssetUrl 
        }
        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 
          }
        }
        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 
          }
        }
        repeaters {
          id 
          name 
          hubType 
          productType 
          brandName 
          firmwareVersion 
          serialNumber 
          macAddress 
          manufacturerInformation 
          wasWaterSensorTapePreviouslyConnected 
          waterGuard {
            wasWaterSensorTapePreviouslyConnected 
            mode 
            tamperModeWarningTriggeredAt 
            tamperModeTriggersAt 
            overrideModeTriggeredAt 
            showLevel1Warning 
            showLevel2Warning 
          }
          hubTemplate {
            id 
            name 
            hubAssetUrl 
            hubWithBgAssetUrl 
            hubQrCodeAssetUrl 
            hubConnectionAssetUrl 
            hubSearchAssetUrl 
            waterLeakDetectorAssetUrl 
            waterLeakDetectorInstructionsAssetUrl 
            waterLeakDetectorHelpAssetUrl 
            waterSensorTapeAssetUrl 
            waterSensorTapeInstructionsAssetUrl 
            waterLeakSystemPressHubButtonAssetUrl 
            sintefLogoAssetUrl 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          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
            }
          }
          repeaters {
            id 
            name 
            hubType 
            productType 
            brandName 
            firmwareVersion 
            serialNumber 
            macAddress 
            manufacturerInformation 
            wasWaterSensorTapePreviouslyConnected 
            waterGuard {
              __typename
              # ...HubWaterGuardFragment
            }
            hubTemplate {
              __typename
              # ...HubTemplateFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            repeaters {
              __typename
              # ...HubFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
        }
        traits {
          traitType 
          commands 
          attributes {
            name 
            dataType 
            editable 
            availableArmLevels {
              __typename
              # ...ArmLevelFragment
            }
          }
        }
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "home": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "locationInfo": { "country": "Example String", "city": "Example String", "postalCode": "Example String", "street": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "systemCountry": "NO", "homeInfo": { "nickname": "Example String", "avatarUrl": "Example String", "size": 40, "ageOfBuilding": 40, "numberOfFloors": 40, "numberOfAdults": 40, "numberOfChildren": 40, "homeType": "APARTMENT", "dwellingUnit": "SDU", "heatingType": "AIR_TO_AIR_HEATPUMP", "cooling": "AC", "ventilation": true, "propertyManagerName": "Example String", "constructionType": "CONCRETE", "buildingYear": 40 }, "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "insuranceInfo": { "insuranceCompany": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String" } }, "areas": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] } ], "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" } } ], "hubs": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "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 } ] }, "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" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "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" } } ], "repeaters": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "__typename": "HubWaterGuard" }, "hubTemplate": { "__typename": "HubTemplate" }, "area": { "__typename": "Area" }, "devices": [ { "__typename": "Device" } ], "repeaters": [ { "__typename": "Hub" } ], "traits": [ { "__typename": "Trait" } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ] } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

organizationId
ID!,non-nullrequired
email
String!,non-nullrequired

Return type

InstallerOrganizationAddInstallerPayload
Mutation sample
mutation installerOrganizationAddInstaller($organizationId: ID!, $email: String!) {
  installerOrganizationAddInstaller(organizationId: $organizationId, email: $email) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

userId
ID!,non-nullrequired
organizationId
ID!,non-nullrequired

Return type

InstallerOrganizationRemoveInstallerPayload
Mutation sample
mutation installerOrganizationRemoveInstaller($userId: ID!, $organizationId: ID!) {
  installerOrganizationRemoveInstaller(userId: $userId, organizationId: $organizationId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

Return type

InstallerCreateOrganizationWithOwnerPayload
organizationId
ID
Mutation sample
mutation installerCreateOrganizationWithOwner($data: InstallerCreateOrganizationWithOwnerInput!) {
  installerCreateOrganizationWithOwner(data: $data) {
    organizationId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "organizationName": "Example String", "ownerEmail": "Example String" } }
Response sample
{ "data": { "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

organizationId
ID!,non-nullrequired
data
ProjectCreateInput!,non-nullrequired

Return type

InstallerOrganizationCreateProjectPayload
projectId
ID
Mutation sample
mutation installerOrganizationCreateProject($organizationId: ID!, $data: ProjectCreateInput!) {
  installerOrganizationCreateProject(organizationId: $organizationId, data: $data) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "location": { "country": "Example String", "city": "Example String", "street": "Example String", "postalCode": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationPk": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "buildingType": "APARTMENT", "constructionType": "CONCRETE", "buildingYear": 40, "projectNumber": "Example String", "sizeOfHousehold": 40, "buildingTitle": "Example String", "orderReferenceNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

Return type

InstallerOrganizationCreateProjectOnExistingHomePayload
projectId
ID
Mutation sample
mutation installerOrganizationCreateProjectOnExistingHome($data: OrganizationProjectOnExistingHomeCreateInput!) {
  installerOrganizationCreateProjectOnExistingHome(data: $data) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "orderReferenceNumber": "Example String", "buildingTitle": "Example String", "projectNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

Return type

ProjectOnExistingHomeCreatePayload
projectId
ID
errors
Mutation sample
mutation projectOnExistingHomeCreate($data: ProjectOnExistingHomeCreateInput!) {
  projectOnExistingHomeCreate(data: $data) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "orderReferenceNumber": "Example String", "buildingTitle": "Example String", "projectNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

memberId
ID!,non-nullrequired

Return type

HomeMemberToggleEmergencyNotificationsPayload
memberId
ID!,non-null
Mutation sample
mutation homeMemberSetEmergencyNotifications($memberId: ID!, $data: HomeMemberSetEmergencyNotificationsInput!) {
  homeMemberSetEmergencyNotifications(memberId: $memberId, data: $data) {
    memberId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "memberId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "enabled": true } }
Response sample
{ "data": { "memberId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

emergencyContactId
ID!,non-nullrequired

Return type

EmergencyContactDeletePayload
id
ID
Mutation sample
mutation emergencyContactDelete($emergencyContactId: ID!) {
  emergencyContactDelete(emergencyContactId: $emergencyContactId) {
    id 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "emergencyContactId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
data
EmergencyContactAddInput!,non-nullrequired

Return type

EmergencyContactAddPayload
emergencyContact
Mutation sample
mutation emergencyContactAdd($homeId: ID!, $data: EmergencyContactAddInput!) {
  emergencyContactAdd(homeId: $homeId, data: $data) {
    emergencyContact {
      id 
      firstName 
      lastName 
      phoneNumber {
        countryCode 
        nationalNumber 
      }
      isAlarmStationContact 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "language": "Example String" } }
Response sample
{ "data": { "emergencyContact": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "isAlarmStationContact": true }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Overview
Overview
Overview
Overview
Overview
Overview