Trendsic Platform Service

<back to all web services

FormAutomationsRequest

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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormAutomationRule
    {
        public virtual int WorkflowId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Sentence { get; set; }
        public virtual string State { get; set; }
        public virtual string StateText { get; set; }
        public virtual string Numbers { get; set; }
        public virtual string Warn { get; set; }
        public virtual bool AnyApplication { get; set; }
        public virtual bool AlsoOthers { get; set; }
        public virtual string SharedText { get; set; }
        public virtual bool FromStarter { get; set; }
        public virtual string EngineLink { get; set; }
    }

    public partial class FormAutomationsRequest
    {
        public virtual Guid FormUID { get; set; }
    }

    public partial class FormAutomationsResponse
    {
        public virtual List<FormAutomationRule> Rules { get; set; } = [];
        public virtual List<FormAutomationStarter> Starters { get; set; } = [];
        public virtual List<FormMappingRow> Mapping { get; set; } = [];
        public virtual string MapSummary { get; set; }
        public virtual bool CanAdd { get; set; }
        public virtual string AddRefusal { get; set; }
        public virtual bool CanToggle { get; set; }
        public virtual bool CanRemove { get; set; }
        public virtual bool CanOpenEngine { get; set; }
        public virtual List<string> ReservedKeys { get; set; } = [];
        public virtual List<string> TestableFields { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class FormAutomationStarter
    {
        public virtual string Key { get; set; }
        public virtual string Name { get; set; }
        public virtual string Text { get; set; }
        public virtual bool Added { get; set; }
    }

    public partial class FormMappingRow
    {
        public virtual string Field { get; set; }
        public virtual string FieldKey { get; set; }
        public virtual string Target { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Note { get; set; }
    }

}

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