| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormAutomationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AddRefusal>String</AddRefusal>
<CanAdd>false</CanAdd>
<CanOpenEngine>false</CanOpenEngine>
<CanRemove>false</CanRemove>
<CanToggle>false</CanToggle>
<MapSummary>String</MapSummary>
<Mapping>
<FormMappingRow>
<Field>String</Field>
<FieldKey>String</FieldKey>
<Note>String</Note>
<Target>String</Target>
<Tone>String</Tone>
</FormMappingRow>
</Mapping>
<ReservedKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ReservedKeys>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Rules>
<FormAutomationRule>
<AlsoOthers>false</AlsoOthers>
<AnyApplication>false</AnyApplication>
<EngineLink>String</EngineLink>
<FromStarter>false</FromStarter>
<Name>String</Name>
<Numbers>String</Numbers>
<Sentence>String</Sentence>
<SharedText>String</SharedText>
<State>String</State>
<StateText>String</StateText>
<Warn>String</Warn>
<WorkflowId>0</WorkflowId>
</FormAutomationRule>
</Rules>
<Starters>
<FormAutomationStarter>
<Added>false</Added>
<Key>String</Key>
<Name>String</Name>
<Text>String</Text>
</FormAutomationStarter>
</Starters>
<TestableFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TestableFields>
</FormAutomationsResponse>