GraphQL Overview

mutation updateNotificationRoutine(
  $partyId: ID
  $homeId: ID!
  $action: UpdatedAction!
  $routineId: ID!
) {
  updateNotificationRoutine(
    partyId: $partyId
    homeId: $homeId
    action: $action
    routineId: $routineId
  ) {
    partyId 
    homeId 
    action 
    deviceId 
    device {
      id 
      deviceType 
      name 
      serialNumber 
      imei 
      macAddress 
      ipAddress 
      roomPlacement 
      manufacturer {
        id 
        name 
        logo {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
      }
      deviceTemplate(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        primaryPairingMode 
        secondaryPairingModes 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        imageWithBg {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        instructions {
          installation {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          configuration {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          help {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          connectionAssetUrl 
        }
      }
      image {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
      }
      favorite 
      favoriteChangedAt 
      registeredAt 
      canBeUnregistered 
      firmwareVersion 
      latestFirmware {
        variant 
        version 
        downloadUrl 
      }
      relayConfiguration {
        supportedDeviceTypes 
        endDeviceType 
      }
      ioModuleConfiguration {
        supportedConfigurations 
        configuration 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
      accessPolicy {
        read 
        write 
        delete 
        expiresAt 
      }
    }
  }
}

mutation updateNotificationSmartEnergy(
  $partyId: ID
  $homeId: ID!
  $action: UpdatedAction!
) {
  updateNotificationSmartEnergy(
    partyId: $partyId
    homeId: $homeId
    action: $action
  ) {
    partyId 
    homeId 
    action 
    deviceId 
    device {
      id 
      deviceType 
      name 
      serialNumber 
      imei 
      macAddress 
      ipAddress 
      roomPlacement 
      manufacturer {
        id 
        name 
        logo {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
      }
      deviceTemplate(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        primaryPairingMode 
        secondaryPairingModes 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        imageWithBg {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        instructions {
          installation {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          configuration {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          help {
            description {
              __typename
              # ...DeviceInstructionDescriptionItemFragment
            }
            assetUrl 
          }
          connectionAssetUrl 
        }
      }
      image {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
      }
      favorite 
      favoriteChangedAt 
      registeredAt 
      canBeUnregistered 
      firmwareVersion 
      latestFirmware {
        variant 
        version 
        downloadUrl 
      }
      relayConfiguration {
        supportedDeviceTypes 
        endDeviceType 
      }
      ioModuleConfiguration {
        supportedConfigurations 
        configuration 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
      accessPolicy {
        read 
        write 
        delete 
        expiresAt 
      }
    }
  }
}

mutation updateNotificationDemandResponse($userId: ID!, $action: UpdatedAction!) {
  updateNotificationDemandResponse(userId: $userId, action: $action) {
    userId 
    action 
    demandResponse {
      eligible 
      enrolled 
    }
  }
}

mutation updateNotificationAccount($userId: ID!, $action: UpdatedAction!) {
  updateNotificationAccount(userId: $userId, action: $action) {
    userId 
    action 
    demandResponse {
      eligible 
      enrolled 
    }
  }
}

mutation areaSetActionAccessPolicyForUser(
  $areaId: ID!
  $userId: ID!
  $accessInput: ChangeActionAccessesInput!
) {
  areaSetActionAccessPolicyForUser(
    areaId: $areaId
    userId: $userId
    accessInput: $accessInput
  ) {
    actionAccesses {
      actionType 
      create 
      update 
      delete 
      read 
    }
    errors {
      message 
      path 
    }
  }
}

mutation installerCreateProject($data: ProjectCreateInput!) {
  installerCreateProject(data: $data) {
    projectId 
    homeId 
    errors {
      message 
      path 
    }
  }
}

mutation installerUpdateProject($projectId: ID!, $data: ProjectUpdateInput!) {
  installerUpdateProject(projectId: $projectId, data: $data) {
    project {
      id 
      installerId 
      status 
      avatar(
        # Arguments Here
      ) {
        url {
          original 
          small 
          medium 
          large 
        }
        uploadUrl 
      }
      buildingType 
      buildingYear 
      buildingSize 
      locationInfo {
        country 
        city 
        postalCode 
        street 
        streetNumber 
        unitNumber 
        geoLocation {
          latitude 
          longitude 
        }
        apartmentNumber 
        associationId 
      }
      constructionType 
      description {
        projectNumber 
        orderReferenceNumber 
        buildingTitle 
      }
      hubs {
        area {
          areaName 
          areaType 
        }
      }
      devices {
        area {
          areaName 
          areaType 
        }
        deviceType 
      }
    }
    errors {
      message 
      path 
    }
  }
}

mutation installerProjectUpdateStatus($projectId: ID!, $status: ProjectStatus!) {
  installerProjectUpdateStatus(projectId: $projectId, status: $status) {
    errors {
      message 
      path 
    }
  }
}

mutation claimHome($homeId: ID!) {
  claimHome(homeId: $homeId) {
    errors {
      message 
      path 
    }
  }
}

mutation installerDeleteProject($projectId: ID!) {
  installerDeleteProject(projectId: $projectId) {
    projectId 
    errors {
      message 
      path 
    }
  }
}

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 
    }
  }
}