Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/automations
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FormAutomationsRequest
    {
        public UUID FormUID = null;
        
        public UUID getFormUID() { return FormUID; }
        public FormAutomationsRequest setFormUID(UUID value) { this.FormUID = value; return this; }
    }

    public static class FormAutomationsResponse
    {
        public ArrayList<FormAutomationRule> Rules = new ArrayList<FormAutomationRule>();
        public ArrayList<FormAutomationStarter> Starters = new ArrayList<FormAutomationStarter>();
        public ArrayList<FormMappingRow> Mapping = new ArrayList<FormMappingRow>();
        public String MapSummary = null;
        public Boolean CanAdd = null;
        public String AddRefusal = null;
        public Boolean CanToggle = null;
        public Boolean CanRemove = null;
        public Boolean CanOpenEngine = null;
        public ArrayList<String> ReservedKeys = new ArrayList<String>();
        public ArrayList<String> TestableFields = new ArrayList<String>();
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<FormAutomationRule> getRules() { return Rules; }
        public FormAutomationsResponse setRules(ArrayList<FormAutomationRule> value) { this.Rules = value; return this; }
        public ArrayList<FormAutomationStarter> getStarters() { return Starters; }
        public FormAutomationsResponse setStarters(ArrayList<FormAutomationStarter> value) { this.Starters = value; return this; }
        public ArrayList<FormMappingRow> getMapping() { return Mapping; }
        public FormAutomationsResponse setMapping(ArrayList<FormMappingRow> value) { this.Mapping = value; return this; }
        public String getMapSummary() { return MapSummary; }
        public FormAutomationsResponse setMapSummary(String value) { this.MapSummary = value; return this; }
        public Boolean isCanAdd() { return CanAdd; }
        public FormAutomationsResponse setCanAdd(Boolean value) { this.CanAdd = value; return this; }
        public String getAddRefusal() { return AddRefusal; }
        public FormAutomationsResponse setAddRefusal(String value) { this.AddRefusal = value; return this; }
        public Boolean isCanToggle() { return CanToggle; }
        public FormAutomationsResponse setCanToggle(Boolean value) { this.CanToggle = value; return this; }
        public Boolean isCanRemove() { return CanRemove; }
        public FormAutomationsResponse setCanRemove(Boolean value) { this.CanRemove = value; return this; }
        public Boolean isCanOpenEngine() { return CanOpenEngine; }
        public FormAutomationsResponse setCanOpenEngine(Boolean value) { this.CanOpenEngine = value; return this; }
        public ArrayList<String> getReservedKeys() { return ReservedKeys; }
        public FormAutomationsResponse setReservedKeys(ArrayList<String> value) { this.ReservedKeys = value; return this; }
        public ArrayList<String> getTestableFields() { return TestableFields; }
        public FormAutomationsResponse setTestableFields(ArrayList<String> value) { this.TestableFields = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FormAutomationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class FormAutomationRule
    {
        public Integer WorkflowId = null;
        public String Name = null;
        public String Sentence = null;
        public String State = null;
        public String StateText = null;
        public String Numbers = null;
        public String Warn = null;
        public Boolean AnyApplication = null;
        public Boolean AlsoOthers = null;
        public String SharedText = null;
        public Boolean FromStarter = null;
        public String EngineLink = null;
        
        public Integer getWorkflowId() { return WorkflowId; }
        public FormAutomationRule setWorkflowId(Integer value) { this.WorkflowId = value; return this; }
        public String getName() { return Name; }
        public FormAutomationRule setName(String value) { this.Name = value; return this; }
        public String getSentence() { return Sentence; }
        public FormAutomationRule setSentence(String value) { this.Sentence = value; return this; }
        public String getState() { return State; }
        public FormAutomationRule setState(String value) { this.State = value; return this; }
        public String getStateText() { return StateText; }
        public FormAutomationRule setStateText(String value) { this.StateText = value; return this; }
        public String getNumbers() { return Numbers; }
        public FormAutomationRule setNumbers(String value) { this.Numbers = value; return this; }
        public String getWarn() { return Warn; }
        public FormAutomationRule setWarn(String value) { this.Warn = value; return this; }
        public Boolean isAnyApplication() { return AnyApplication; }
        public FormAutomationRule setAnyApplication(Boolean value) { this.AnyApplication = value; return this; }
        public Boolean isAlsoOthers() { return AlsoOthers; }
        public FormAutomationRule setAlsoOthers(Boolean value) { this.AlsoOthers = value; return this; }
        public String getSharedText() { return SharedText; }
        public FormAutomationRule setSharedText(String value) { this.SharedText = value; return this; }
        public Boolean isFromStarter() { return FromStarter; }
        public FormAutomationRule setFromStarter(Boolean value) { this.FromStarter = value; return this; }
        public String getEngineLink() { return EngineLink; }
        public FormAutomationRule setEngineLink(String value) { this.EngineLink = value; return this; }
    }

    public static class FormAutomationStarter
    {
        public String Key = null;
        public String Name = null;
        public String Text = null;
        public Boolean Added = null;
        
        public String getKey() { return Key; }
        public FormAutomationStarter setKey(String value) { this.Key = value; return this; }
        public String getName() { return Name; }
        public FormAutomationStarter setName(String value) { this.Name = value; return this; }
        public String getText() { return Text; }
        public FormAutomationStarter setText(String value) { this.Text = value; return this; }
        public Boolean isAdded() { return Added; }
        public FormAutomationStarter setAdded(Boolean value) { this.Added = value; return this; }
    }

    public static class FormMappingRow
    {
        public String Field = null;
        public String FieldKey = null;
        public String Target = null;
        public String Tone = null;
        public String Note = null;
        
        public String getField() { return Field; }
        public FormMappingRow setField(String value) { this.Field = value; return this; }
        public String getFieldKey() { return FieldKey; }
        public FormMappingRow setFieldKey(String value) { this.FieldKey = value; return this; }
        public String getTarget() { return Target; }
        public FormMappingRow setTarget(String value) { this.Target = value; return this; }
        public String getTone() { return Tone; }
        public FormMappingRow setTone(String value) { this.Tone = value; return this; }
        public String getNote() { return Note; }
        public FormMappingRow setNote(String value) { this.Note = value; return this; }
    }

}

Java FormAutomationsRequest DTOs

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