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 Foundation
import ServiceStack

public class FormAutomationsRequest : Codable
{
    public var formUID:String

    required public init(){}
}

public class FormAutomationsResponse : Codable
{
    public var rules:[FormAutomationRule] = []
    public var starters:[FormAutomationStarter] = []
    public var mapping:[FormMappingRow] = []
    public var mapSummary:String
    public var canAdd:Bool
    public var addRefusal:String
    public var canToggle:Bool
    public var canRemove:Bool
    public var canOpenEngine:Bool
    public var reservedKeys:[String] = []
    public var testableFields:[String] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormAutomationRule : Codable
{
    public var workflowId:Int
    public var name:String
    public var sentence:String
    public var state:String
    public var stateText:String
    public var numbers:String
    public var warn:String
    public var anyApplication:Bool
    public var alsoOthers:Bool
    public var sharedText:String
    public var fromStarter:Bool
    public var engineLink:String

    required public init(){}
}

public class FormAutomationStarter : Codable
{
    public var key:String
    public var name:String
    public var text:String
    public var added:Bool

    required public init(){}
}

public class FormMappingRow : Codable
{
    public var field:String
    public var fieldKey:String
    public var target:String
    public var tone:String
    public var note:String

    required public init(){}
}


Swift FormAutomationsRequest DTOs

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