Viviot.Api

<back to all web services

GetAutomation

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, WorkflowAdmin
The following routes are available for this service:
GET/automationGets single automation details.
GetAutomation Parameters:
NameParameterData TypeRequiredDescription
AutomationIdquerystringYesAutomation Id.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
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
EventType Enum:
NameValue
AccessExpired1
PaymentDeclined2
ServiceRating3
ServiceProblemReport4
SensorValue5
TaskListCompleted6
Access7
TaskListNotStarted8
ReservationCheckout9
TaskListExpiring10
ReservationCheckin11
ActionType Enum:
NameValue
TaskList1
Alarm2
IoT3
DeactivateAlarm4
Email5

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.

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

{Unable to show example output for type 'AutomationResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)