Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/automations
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class FormAutomationRule
            Public Overridable Property WorkflowId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Sentence As String
            Public Overridable Property State As String
            Public Overridable Property StateText As String
            Public Overridable Property Numbers As String
            Public Overridable Property Warn As String
            Public Overridable Property AnyApplication As Boolean
            Public Overridable Property AlsoOthers As Boolean
            Public Overridable Property SharedText As String
            Public Overridable Property FromStarter As Boolean
            Public Overridable Property EngineLink As String
        End Class

        Public Partial Class FormAutomationsRequest
            Public Overridable Property FormUID As Guid
        End Class

        Public Partial Class FormAutomationsResponse
            Public Overridable Property Rules As List(Of FormAutomationRule) = New List(Of FormAutomationRule)
            Public Overridable Property Starters As List(Of FormAutomationStarter) = New List(Of FormAutomationStarter)
            Public Overridable Property Mapping As List(Of FormMappingRow) = New List(Of FormMappingRow)
            Public Overridable Property MapSummary As String
            Public Overridable Property CanAdd As Boolean
            Public Overridable Property AddRefusal As String
            Public Overridable Property CanToggle As Boolean
            Public Overridable Property CanRemove As Boolean
            Public Overridable Property CanOpenEngine As Boolean
            Public Overridable Property ReservedKeys As List(Of String) = New List(Of String)
            Public Overridable Property TestableFields As List(Of String) = New List(Of String)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class FormAutomationStarter
            Public Overridable Property Key As String
            Public Overridable Property Name As String
            Public Overridable Property Text As String
            Public Overridable Property Added As Boolean
        End Class

        Public Partial Class FormMappingRow
            Public Overridable Property Field As String
            Public Overridable Property FieldKey As String
            Public Overridable Property Target As String
            Public Overridable Property Tone As String
            Public Overridable Property Note As String
        End Class
    End Namespace
End Namespace

VB.NET FormAutomationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}