Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/automations
FormAutomationsRequest Parameters:
NameParameterData TypeRequiredDescription
FormUIDpathGuidNo
FormAutomationsResponse Parameters:
NameParameterData TypeRequiredDescription
RulesformList<FormAutomationRule>No
StartersformList<FormAutomationStarter>No
MappingformList<FormMappingRow>No
MapSummaryformstringNo
CanAddformboolNo
AddRefusalformstringNo
CanToggleformboolNo
CanRemoveformboolNo
CanOpenEngineformboolNo
ReservedKeysformList<string>No
TestableFieldsformList<string>No
ResponseStatusformResponseStatusNo
FormAutomationRule Parameters:
NameParameterData TypeRequiredDescription
WorkflowIdformintNo
NameformstringNo
SentenceformstringNo
StateformstringNo
StateTextformstringNo
NumbersformstringNo
WarnformstringNo
AnyApplicationformboolNo
AlsoOthersformboolNo
SharedTextformstringNo
FromStarterformboolNo
EngineLinkformstringNo
FormAutomationStarter Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
NameformstringNo
TextformstringNo
AddedformboolNo
FormMappingRow Parameters:
NameParameterData TypeRequiredDescription
FieldformstringNo
FieldKeyformstringNo
TargetformstringNo
ToneformstringNo
NoteformstringNo

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 /v1/forms/{FormUID}/automations HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rules: 
	[
		{
			WorkflowId: 0,
			Name: String,
			Sentence: String,
			State: String,
			StateText: String,
			Numbers: String,
			Warn: String,
			AnyApplication: False,
			AlsoOthers: False,
			SharedText: String,
			FromStarter: False,
			EngineLink: String
		}
	],
	Starters: 
	[
		{
			Key: String,
			Name: String,
			Text: String,
			Added: False
		}
	],
	Mapping: 
	[
		{
			Field: String,
			FieldKey: String,
			Target: String,
			Tone: String,
			Note: String
		}
	],
	MapSummary: String,
	CanAdd: False,
	AddRefusal: String,
	CanToggle: False,
	CanRemove: False,
	CanOpenEngine: False,
	ReservedKeys: 
	[
		String
	],
	TestableFields: 
	[
		String
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}