Viviot.Api

GetAutomation

**Requires Authentication**
Requires any of the roles:	Admin, TenantAdmin, WorkflowAdmin

The following routes are available for this service:
GET	/automation	Gets single automation details.

**GetAutomation** Parameters:
Name	Parameter	Data Type	Required	Description
AutomationId	query	string	Yes	Automation Id.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**AutomationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	AutomationView	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**AutomationView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
Name	form	string	No
Event	form	EventType	No
EventParameters	form	string	No
ActionParameters	form	string	No
Action	form	ActionType	No
AlarmConfigId	form	Guid?	No
TaskListTemplateId	form	Guid?	No
TaskListAllottedTime	form	TimeSpan?	No

**EventType** Enum:
Name	Value
AccessExpired	1
PaymentDeclined	2
ServiceRating	3
ServiceProblemReport	4
SensorValue	5
TaskListCompleted	6
Access	7
TaskListNotStarted	8
ReservationCheckout	9
TaskListExpiring	10
ReservationCheckin	11

**ActionType** Enum:
Name	Value
TaskList	1
Alarm	2
IoT	3
DeactivateAlarm	4
Email	5

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

HTTP + JSV

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/jsv

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

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