Skip to content
Abra GraphQL APIs
/
Other
/
/
routineCreate

GraphQL Overview

Download GraphQL schema
schema.graphql
Home

Queries

Overview

Mutations

Overview
Users

Queries

Overview

Mutations

Overview
Fire

Queries

Overview

Mutations

Overview
Water

Queries

Overview

Mutations

Overview
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview
Other

Queries

Overview

Mutations

Overview

userUpdateNotificationPreferences

(data)
UserUpdateNotificationPreferencesPayload

Arguments

data
NotificationPreferencesInput!,non-nullrequired

Return type

UserUpdateNotificationPreferencesPayload
errors
[UserUpdateNotificationPreferencesError!],non-null
Mutation sample
mutation userUpdateNotificationPreferences($data: NotificationPreferencesInput!) {
  userUpdateNotificationPreferences(data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "data": {
    "notificationsEnabled": true
  }
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

updateUserMarketingPreferences

(...args)
UpdateUserMarketingPreferencesPayload

Arguments

userId
ID!,non-nullrequired
data
MarketingPreferencesInput!,non-nullrequired

Return type

UpdateUserMarketingPreferencesPayload
errors
[UpdateUserMarketingPreferencesError!],non-null
Mutation sample
mutation updateUserMarketingPreferences($userId: ID!, $data: MarketingPreferencesInput!) {
  updateUserMarketingPreferences(userId: $userId, data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "marketingConsent": true,
    "registrationSource": "ABRA"
  }
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

favoritesAdd

(...args)
FavoritesAddPayload

Arguments

subjectId
ID!,non-nullrequired
subjectType
FavoriteSupportedType!,non-nullrequired

Return type

FavoritesAddPayload
errors
[FavoritesAddError!]!,non-null
Mutation sample
mutation favoritesAdd($subjectId: ID!, $subjectType: FavoriteSupportedType!) {
  favoritesAdd(subjectId: $subjectId, subjectType: $subjectType) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "subjectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "subjectType": "DEVICE_GROUP"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

favoritesRemove

(...args)
FavoritesRemovePayload

Arguments

subjectId
ID!,non-nullrequired
subjectType
FavoriteSupportedType!,non-nullrequired

Return type

FavoritesRemovePayload
errors
[FavoritesRemoveError!]!,non-null
Mutation sample
mutation favoritesRemove($subjectId: ID!, $subjectType: FavoriteSupportedType!) {
  favoritesRemove(subjectId: $subjectId, subjectType: $subjectType) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "subjectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "subjectType": "DEVICE_GROUP"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

freezeProtectionConfigure

(...args)
FreezeProtectionConfigurePayload

Arguments

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

Return type

FreezeProtectionConfigurePayload
freezeProtection
FreezeProtection
errors
[FreezeProtectionConfigureError!]!,non-null
Mutation sample
mutation freezeProtectionConfigure($homeId: ID!, $data: FreezeProtectionConfigureInput!) {
  freezeProtectionConfigure(homeId: $homeId, data: $data) {
    freezeProtection {
      enabled 
      thresholdTemperature 
      temperatureSensors {
        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 
        }
      }
      activation {
        triggeredAt 
        canSafelyOpenValve 
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "enabled": true,
    "thresholdTemperature": 40,
    "temperatureSensors": [
      "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
    ]
  }
}
Response sample
{
  "data": {
    "freezeProtection": {
      "enabled": true,
      "thresholdTemperature": 40,
      "temperatureSensors": [
        {
          "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"
          }
        }
      ],
      "activation": {
        "triggeredAt": "Example String",
        "canSafelyOpenValve": true
      }
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

routineCreate

(...args)
RoutineCreatePayload

Arguments

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

Return type

RoutineCreatePayload
routineId
ID
errors
[RoutineCreateError!]!,non-null
Mutation sample
mutation routineCreate($homeId: ID!, $data: RoutineCreateInput!) {
  routineCreate(homeId: $homeId, data: $data) {
    routineId 
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "logic": {
      "trigger": {
        "triggerType": "SINGLE_CONDITION",
        "conditions": [
          {
            "type": "SPECIFIC_TIME_CONDITION",
            "specificTimeCondition": {
              "at": "Example String"
            },
            "specificTimePeriodCondition": {
              "startAt": "Example String",
              "endAt": "Example String"
            },
            "timeOfDayPeriodCondition": {
              "startTime": {
                "__typename": "TimeOfDayInput"
              },
              "endTime": {
                "__typename": "TimeOfDayInput"
              },
              "onDays": [
                "MONDAY"
              ]
            },
            "timeOfDayCondition": {
              "atTime": {
                "__typename": "TimeOfDayInput"
              },
              "onDays": [
                "MONDAY"
              ]
            }
          }
        ]
      },
      "action": {
        "actionType": "DEVICE_COMMAND_REVERT",
        "commandType": "ALARM",
        "commandPayload": "Example String"
      },
      "compensatingAction": {
        "actionType": "DEVICE_COMMAND_REVERT",
        "commandType": "ALARM",
        "commandPayload": "Example String"
      }
    },
    "description": {
      "name": "Example String",
      "description": "Example String"
    }
  }
}
Response sample
{
  "data": {
    "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

routineCreateInternal

(...args)
RoutineCreatePayload

Arguments

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

Return type

RoutineCreatePayload
routineId
ID
errors
[RoutineCreateError!]!,non-null
Mutation sample
mutation routineCreateInternal($homeId: ID!, $data: RoutineCreateInternalInput!) {
  routineCreateInternal(homeId: $homeId, data: $data) {
    routineId 
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "logic": {
      "trigger": {
        "triggerType": "SINGLE_CONDITION",
        "conditions": [
          {
            "type": "SPECIFIC_TIME_CONDITION",
            "specificTimeCondition": {
              "at": "Example String"
            },
            "specificTimePeriodCondition": {
              "startAt": "Example String",
              "endAt": "Example String"
            },
            "timeOfDayPeriodCondition": {
              "startTime": {
                "__typename": "TimeOfDayInput"
              },
              "endTime": {
                "__typename": "TimeOfDayInput"
              },
              "onDays": [
                "MONDAY"
              ]
            },
            "timeOfDayCondition": {
              "atTime": {
                "__typename": "TimeOfDayInput"
              },
              "onDays": [
                "MONDAY"
              ]
            }
          }
        ]
      },
      "action": {
        "actionType": "DEVICE_COMMAND_REVERT",
        "commandType": "ALARM",
        "commandPayload": "Example String"
      },
      "compensatingAction": {
        "actionType": "DEVICE_COMMAND_REVERT",
        "commandType": "ALARM",
        "commandPayload": "Example String"
      }
    },
    "origin": {
      "type": "CUSTOM",
      "source": "DEMAND_RESPONSE"
    }
  }
}
Response sample
{
  "data": {
    "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

routineUpdateDescription

(...args)
RoutineUpdateDescriptionPayload

Arguments

routineId
ID!,non-nullrequired
data
RoutineUpdateDescriptionInput!,non-nullrequired

Return type

RoutineUpdateDescriptionPayload
routine
Routine
errors
[RoutineUpdateDescriptionError!]!,non-null
Mutation sample
mutation routineUpdateDescription($routineId: ID!, $data: RoutineUpdateDescriptionInput!) {
  routineUpdateDescription(routineId: $routineId, data: $data) {
    routine {
      id 
      logic {
        trigger {
          condition {
            at 
          }
        }
        action {
          deviceId 
          chargingOn 
        }
        compensatingAction {
          deviceId 
          chargingOn 
        }
      }
      state 
      origin {
        type 
        source 
      }
      description {
        name 
        description 
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "name": "Example String",
    "description": "Example String"
  }
}
Response sample
{
  "data": {
    "routine": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "logic": {
        "trigger": {
          "condition": {
            "at": "Example String"
          }
        },
        "action": {
          "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "chargingOn": true
        },
        "compensatingAction": {
          "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "chargingOn": true
        }
      },
      "state": "ACTIVE",
      "origin": {
        "type": "CUSTOM",
        "source": "DEMAND_RESPONSE"
      },
      "description": {
        "name": "Example String",
        "description": "Example String"
      }
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

routineActivate

(routineId)
RoutineActivatePayload

Arguments

routineId
ID!,non-nullrequired

Return type

RoutineActivatePayload
errors
[RoutineActivateError!]!,non-null
Mutation sample
mutation routineActivate($routineId: ID!) {
  routineActivate(routineId: $routineId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

routineDeactivate

(routineId)
RoutineDeactivatePayload

Arguments

routineId
ID!,non-nullrequired

Return type

RoutineDeactivatePayload
errors
[RoutineDeactivateError!]!,non-null
Mutation sample
mutation routineDeactivate($routineId: ID!) {
  routineDeactivate(routineId: $routineId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

routineDelete

(routineId)
RoutineDeletePayload

Arguments

routineId
ID!,non-nullrequired

Return type

RoutineDeletePayload
errors
[RoutineDeleteError!]!,non-null
Mutation sample
mutation routineDelete($routineId: ID!) {
  routineDelete(routineId: $routineId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview