Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/automations
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormAutomationRule() = 
        member val WorkflowId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Sentence:String = null with get,set
        member val State:String = null with get,set
        member val StateText:String = null with get,set
        member val Numbers:String = null with get,set
        member val Warn:String = null with get,set
        member val AnyApplication:Boolean = new Boolean() with get,set
        member val AlsoOthers:Boolean = new Boolean() with get,set
        member val SharedText:String = null with get,set
        member val FromStarter:Boolean = new Boolean() with get,set
        member val EngineLink:String = null with get,set

    [<AllowNullLiteral>]
    type FormAutomationStarter() = 
        member val Key:String = null with get,set
        member val Name:String = null with get,set
        member val Text:String = null with get,set
        member val Added:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FormMappingRow() = 
        member val Field:String = null with get,set
        member val FieldKey:String = null with get,set
        member val Target:String = null with get,set
        member val Tone:String = null with get,set
        member val Note:String = null with get,set

    [<AllowNullLiteral>]
    type FormAutomationsResponse() = 
        member val Rules:ResizeArray<FormAutomationRule> = new ResizeArray<FormAutomationRule>() with get,set
        member val Starters:ResizeArray<FormAutomationStarter> = new ResizeArray<FormAutomationStarter>() with get,set
        member val Mapping:ResizeArray<FormMappingRow> = new ResizeArray<FormMappingRow>() with get,set
        member val MapSummary:String = null with get,set
        member val CanAdd:Boolean = new Boolean() with get,set
        member val AddRefusal:String = null with get,set
        member val CanToggle:Boolean = new Boolean() with get,set
        member val CanRemove:Boolean = new Boolean() with get,set
        member val CanOpenEngine:Boolean = new Boolean() with get,set
        member val ReservedKeys:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val TestableFields:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormAutomationsRequest() = 
        member val FormUID:Guid = new Guid() with get,set

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