Viviot.Api

<back to all web services

UpdateAutomation

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, WorkflowAdmin
The following routes are available for this service:
PUT/automationUpdates automation configuration.
UpdateAutomation Parameters:
NameParameterData TypeRequiredDescription
IdbodystringYesAutomation Id (GUID)
NamebodystringYesAutomation name
EventbodyEventTypeYesAutomation event type

Allowable Values

  • AccessExpired
  • PaymentDeclined
  • ServiceRating
  • ServiceProblemReport
  • SensorValue
  • TaskListCompleted
  • Access
  • TaskListNotStarted
  • ReservationCheckout
  • TaskListExpiring
  • ReservationCheckin
EventParametersbodystringYesAutomation event parameters
ActionParametersbodystringYesAutomation action parameters
ActionbodyActionTypeYesAutomation action type

Allowable Values

  • TaskList
  • Alarm
  • IoT
  • DeactivateAlarm
  • Email
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
EventType Enum:
NameValue
AccessExpired1
PaymentDeclined2
ServiceRating3
ServiceProblemReport4
SensorValue5
TaskListCompleted6
Access7
TaskListNotStarted8
ReservationCheckout9
TaskListExpiring10
ReservationCheckin11
ActionType Enum:
NameValue
TaskList1
Alarm2
IoT3
DeactivateAlarm4
Email5
AutomationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAutomationViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AutomationView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
EventformEventTypeNo
EventParametersformstringNo
ActionParametersformstringNo
ActionformActionTypeNo
AlarmConfigIdformGuid?No
TaskListTemplateIdformGuid?No
TaskListAllottedTimeformTimeSpan?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /automation HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"00000000000000000000000000000000","name":"String","event":1,"eventParameters":"String","actionParameters":"String","action":1,"version":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","event":1,"eventParameters":"String","actionParameters":"String","action":1,"alarmConfigId":"00000000000000000000000000000000","taskListTemplateId":"00000000000000000000000000000000","taskListAllottedTime":"00:00:00"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}