Skip to content
Abra GraphQL APIs
/
Other
/
/
routineUpdate

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

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

routineUpdate

(...args)
RoutineUpdatePayload

Arguments

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

Return type

RoutineUpdatePayload
routine
Routine
errors
[RoutineUpdateError!]!,non-null
Mutation sample
mutation routineUpdate($routineId: ID!, $data: RoutineUpdateInput!) {
  routineUpdate(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": {
    "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"
      }
    }
  }
}
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"
      }
    ]
  }
}

pushNotificationEndpointSet

(data)
PushNotificationEndpointSetPayload

Arguments

data
PushNotificationEndpointInput!,non-nullrequired

Return type

PushNotificationEndpointSetPayload
errors
[PushNotificationEndpointSetError!]!,non-null
Mutation sample
mutation pushNotificationEndpointSet($data: PushNotificationEndpointInput!) {
  pushNotificationEndpointSet(data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "data": {
    "address": "Example String",
    "channel": "GCM"
  }
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

notificationInboxMarkAsRead

(notificationIds)
NotificationInboxMarkAsReadPayload

Arguments

notificationIds
[ID!]!,non-nullrequired

Return type

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

demandResponseEnroll

DemandResponseEnrollPayload

Return type

DemandResponseEnrollPayload
errors
[DemandResponseEnrollError!]!,non-null
Mutation sample
mutation demandResponseEnroll {
  demandResponseEnroll {
    errors {
      message 
      path 
    }
  }
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

demandResponseUnenroll

DemandResponseUnenrollPayload

Return type

DemandResponseUnenrollPayload
errors
[DemandResponseUnenrollError!]!,non-null
Mutation sample
mutation demandResponseUnenroll {
  demandResponseUnenroll {
    errors {
      message 
      path 
    }
  }
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

smartEnergyEnable

(...args)
SmartEnergyEnablePayload

Arguments

homeId
ID!,non-nullrequired
hourlyLimitWatts
Int!,non-nullrequired

Return type

SmartEnergyEnablePayload
errors
[SmartEnergyEnableError!]!,non-null
Mutation sample
mutation smartEnergyEnable($homeId: ID!, $hourlyLimitWatts: Int!) {
  smartEnergyEnable(homeId: $homeId, hourlyLimitWatts: $hourlyLimitWatts) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "hourlyLimitWatts": 40
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview